GS2-Inventory Script トリガーリファレンス

GS2-Inventoryで定義されている、拡張スクリプトを呼び出すイベントトリガーのリファレンス

acquire

アイテム入手実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryInventoryインベントリ
itemSetsItemSet[]有効期限ごとのアイテム所持数量のリスト
acquireItemNamestring入手したアイテムモデル名
userIdstringユーザーID
acquireCountlong入手数量
expiresAtlong有効期限

Result

必須デフォルト値の制限説明
permitboolアイテム入手を許可するか
overrideAcquireCountint~ 2147483645実際に適用する入手量

実装例

namespace = args.namespace
inventory = args.inventory
itemSets = args.itemSets
acquireItemName = args.acquireItemName
userId = args.userId
acquireCount = args.acquireCount
expiresAt = args.expiresAt

result = {
  permit=permit,
  overrideAcquireCount=overrideAcquireCount
}

acquireDone

アイテム入手実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
oldInventoryInventory更新前のインベントリ
oldItemSetsItemSet[]更新前の有効期限ごとのアイテム所持数量リスト
newInventoryInventory更新後のインベントリ
newItemSetsItemSet[]更新後の有効期限ごとのアイテム所持数量のリスト
acquireItemNamestring入手したアイテムモデル名
userIdstringユーザーID
acquireCountlong入手数量
overflowValuelong溢れた量
expiresAtlong有効期限

Result

必須デフォルト値の制限説明

実装例

namespace = args.namespace
oldInventory = args.oldInventory
oldItemSets = args.oldItemSets
newInventory = args.newInventory
newItemSets = args.newItemSets
acquireItemName = args.acquireItemName
userId = args.userId
acquireCount = args.acquireCount
overflowValue = args.overflowValue
expiresAt = args.expiresAt

result = {
}

overflowDone

アイテム数が入手上限に当たり、入手できなかった数量の通知完了実行時にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryInventoryインベントリ
itemModelItemModelアイテムモデル
userIdstringユーザーID
overflowValuelong溢れた量

Result

必須デフォルト値の制限説明

実装例

namespace = args.namespace
inventory = args.inventory
itemModel = args.itemModel
userId = args.userId
overflowValue = args.overflowValue

result = {
}

consume

アイテム消費実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryInventoryインベントリ
itemSetsItemSet[]有効期限ごとのアイテム所持数量のリスト
consumeItemNamestring消費したアイテムモデル名
userIdstringユーザーID
consumeCountlong消費数量

Result

必須デフォルト値の制限説明
permitboolアイテム消費を許可するか
overrideConsumeCountint~ 2147483645実際に適用する消費量

実装例

namespace = args.namespace
inventory = args.inventory
itemSets = args.itemSets
consumeItemName = args.consumeItemName
userId = args.userId
consumeCount = args.consumeCount

result = {
  permit=permit,
  overrideConsumeCount=overrideConsumeCount
}

consumeDone

アイテム消費実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
oldInventoryInventory消費前のインベントリ
oldItemSetsItemSet[]消費前の有効期限ごとのアイテム所持数量のリスト
newInventoryInventory消費後のインベントリ
newItemSetsItemSet[]消費後の有効期限ごとのアイテム所持数量のリスト
consumeItemNamestring消費したアイテムモデル名
userIdstringユーザーID
consumeCountlong消費数量

Result

必須デフォルト値の制限説明

実装例

namespace = args.namespace
oldInventory = args.oldInventory
oldItemSets = args.oldItemSets
newInventory = args.newInventory
newItemSets = args.newItemSets
consumeItemName = args.consumeItemName
userId = args.userId
consumeCount = args.consumeCount

result = {
}

simpleItemAcquire

シンプルアイテム入手実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryNamestringシンプルインベントリモデル名
simpleItemsSimpleItem[]有効期限ごとのシンプルアイテム所持数量のリスト
userIdstringユーザーID
acquireCountsAcquireCount[]シンプルアイテムの入手数量リスト

Result

必須デフォルト値の制限説明
permitboolシンプルアイテム入手を許可するか
overrideAcquireCountsAcquireCount[]~ 100 itemsシンプルアイテムの入手数量リスト

実装例

namespace = args.namespace
inventoryName = args.inventoryName
simpleItems = args.simpleItems
userId = args.userId
acquireCounts = args.acquireCounts

result = {
  permit=permit,
  overrideAcquireCounts=overrideAcquireCounts
}

simpleItemAcquireDone

シンプルアイテム入手実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryNamestringシンプルインベントリモデル名
oldSimpleItemsSimpleItem[]有効期限ごとのシンプルアイテム所持数量のリスト
newSimpleItemsSimpleItem[]有効期限ごとのシンプルアイテム所持数量のリスト
userIdstringユーザーID
acquireCountsAcquireCount[]シンプルアイテムの入手数量リスト

Result

必須デフォルト値の制限説明

実装例

namespace = args.namespace
inventoryName = args.inventoryName
oldSimpleItems = args.oldSimpleItems
newSimpleItems = args.newSimpleItems
userId = args.userId
acquireCounts = args.acquireCounts

result = {
}

simpleItemConsume

シンプルアイテム消費実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryNamestringシンプルインベントリモデル名
simpleItemsSimpleItem[]シンプルアイテム一覧
userIdstringユーザーID
consumeCountsConsumeCount[]シンプルアイテムの消費数量リスト

Result

必須デフォルト値の制限説明
permitboolシンプルアイテム消費を許可するか
overrideConsumeCountsConsumeCount[]~ 100 itemsシンプルアイテムの消費数量リスト

実装例

namespace = args.namespace
inventoryName = args.inventoryName
simpleItems = args.simpleItems
userId = args.userId
consumeCounts = args.consumeCounts

result = {
  permit=permit,
  overrideConsumeCounts=overrideConsumeCounts
}

simpleItemConsumeDone

シンプルアイテム消費実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryNamestringシンプルインベントリモデル名
oldSimpleItemsSimpleItem[]更新前のシンプルアイテム一覧
newSimpleItemsSimpleItem[]更新後のシンプルアイテム一覧
userIdstringユーザーID
consumeCountsConsumeCount[]シンプルアイテムの消費数量リスト

Result

必須デフォルト値の制限説明

実装例

namespace = args.namespace
inventoryName = args.inventoryName
oldSimpleItems = args.oldSimpleItems
newSimpleItems = args.newSimpleItems
userId = args.userId
consumeCounts = args.consumeCounts

result = {
}

bigItemAcquire

巨大アイテム入手実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryNamestring巨大インベントリモデル名
itemNamestring巨大アイテムモデルの名前
itemBigItem巨大アイテム
userIdstringユーザーID
acquireCountstring巨大アイテムの入手数量リスト

Result

必須デフォルト値の制限説明
permitbool巨大アイテム入手を許可するか
ratefloat1.0~ 1000入手量の倍率

実装例

namespace = args.namespace
inventoryName = args.inventoryName
itemName = args.itemName
item = args.item
userId = args.userId
acquireCount = args.acquireCount

result = {
  permit=permit,
  rate=rate
}

bigItemAcquireDone

巨大アイテム入手実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryNamestring巨大インベントリモデル名
itemNamestring巨大アイテムモデルの名前
oldItemBigItem更新前の巨大アイテム
newItemBigItem更新後の巨大アイテム
userIdstringユーザーID
acquireCountstring巨大アイテムの入手数量リスト

Result

必須デフォルト値の制限説明

実装例

namespace = args.namespace
inventoryName = args.inventoryName
itemName = args.itemName
oldItem = args.oldItem
newItem = args.newItem
userId = args.userId
acquireCount = args.acquireCount

result = {
}

bigItemConsume

巨大アイテム消費実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryNamestring巨大インベントリモデル名
itemNamestring巨大アイテムモデルの名前
itemBigItem巨大アイテム
userIdstringユーザーID
consumeCountstring巨大アイテムの消費数量リスト

Result

必須デフォルト値の制限説明
permitbool巨大アイテム消費を許可するか
ratefloat1.0~ 1000消費量の倍率

実装例

namespace = args.namespace
inventoryName = args.inventoryName
itemName = args.itemName
item = args.item
userId = args.userId
consumeCount = args.consumeCount

result = {
  permit=permit,
  rate=rate
}

bigItemConsumeDone

巨大アイテム消費実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
inventoryNamestring巨大インベントリモデル名
itemNamestring巨大アイテムモデルの名前
oldItemBigItem更新前の巨大アイテム
newItemBigItem更新後の巨大アイテム
userIdstringユーザーID
consumeCountstring巨大アイテムの消費数量リスト

Result

必須デフォルト値の制限説明

実装例

namespace = args.namespace
inventoryName = args.inventoryName
itemName = args.itemName
oldItem = args.oldItem
newItem = args.newItem
userId = args.userId
consumeCount = args.consumeCount

result = {
}