GS2-Inventory
イベントによってトリガーされる GS2-Script のリファレンス
GS2-Script リファレンス
トリガー
acquire
acquire
namespace = args.namespace
inventory = args.inventory
itemSets = args.itemSets
acquireItemName = args.acquireItemName
acquireCount = args.acquireCount
expiresAt = args.expiresAt
result = {
permit=permit,
overrideAcquireCount=overrideAcquireCount
}
アイテム入手時 に実行されるGS2-Script実行前に呼び出される GS2-Script
Request
型 | 説明 | |
---|---|---|
namespace | Namespace | ネームスペース |
inventory | Inventory | インベントリ |
itemSets | ItemSet[] | 有効期限ごとのアイテム所持数量のリスト |
acquireItemName | string | 入手したアイテムモデル名 |
acquireCount | long | 入手数量 |
expiresAt | long | 有効期限 |
Result
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
permit | bool | ✓ | アイテム入手を許可するか | ||
overrideAcquireCount | int | ~ 2147483646 | 実際に適用する入手量 |
acquireDone
acquireDone
namespace = args.namespace
oldInventory = args.oldInventory
oldItemSets = args.oldItemSets
newInventory = args.newInventory
newItemSets = args.newItemSets
acquireItemName = args.acquireItemName
acquireCount = args.acquireCount
expiresAt = args.expiresAt
result = {
}
アイテム入手時 に実行されるGS2-Script実行後に呼び出される GS2-Script
Request
型 | 説明 | |
---|---|---|
namespace | Namespace | ネームスペース |
oldInventory | Inventory | 更新前のインベントリ |
oldItemSets | ItemSet[] | 更新前の有効期限ごとのアイテム所持数量リスト |
newInventory | Inventory | 更新後のインベントリ |
newItemSets | ItemSet[] | 更新後の有効期限ごとのアイテム所持数量のリスト |
acquireItemName | string | 入手したアイテムモデル名 |
acquireCount | long | 入手数量 |
expiresAt | long | 有効期限 |
Result
型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
overflowDone
overflowDone
namespace = args.namespace
inventory = args.inventory
itemModel = args.itemModel
overflowValue = args.overflowValue
result = {
}
入手上限に当たって入手できなかった数量を通知する完了時 に実行されるGS2-Script
Request
型 | 説明 | |
---|---|---|
namespace | Namespace | ネームスペース |
inventory | Inventory | インベントリ |
itemModel | ItemModel | アイテムモデル |
overflowValue | long | 溢れた量 |
Result
型 | 必須 | デフォルト | 値の制限 | 説明 |
---|
consume
consume
namespace = args.namespace
inventory = args.inventory
itemSets = args.itemSets
consumeItemName = args.consumeItemName
consumeCount = args.consumeCount
result = {
permit=permit,
overrideConsumeCount=overrideConsumeCount
}
アイテム消費時 に実行されるGS2-Script実行前に呼び出される GS2-Script
Request
型 | 説明 | |
---|---|---|
namespace | Namespace | ネームスペース |
inventory | Inventory | インベントリ |
itemSets | ItemSet[] | 有効期限ごとのアイテム所持数量のリスト |
consumeItemName | string | 消費したアイテムモデル名 |
consumeCount | long | 消費数量 |
Result
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
permit | bool | ✓ | アイテム消費を許可するか | ||
overrideConsumeCount | int | ~ 2147483646 | 実際に適用する消費量 |
consumeDone
consumeDone
namespace = args.namespace
oldInventory = args.oldInventory
oldItemSets = args.oldItemSets
newInventory = args.newInventory
newItemSets = args.newItemSets
consumeItemName = args.consumeItemName
consumeCount = args.consumeCount
result = {
}
アイテム消費時 に実行されるGS2-Script実行後に呼び出される GS2-Script
Request
型 | 説明 | |
---|---|---|
namespace | Namespace | ネームスペース |
oldInventory | Inventory | 消費前のインベントリ |
oldItemSets | ItemSet[] | 消費前の有効期限ごとのアイテム所持数量のリスト |
newInventory | Inventory | 消費後のインベントリ |
newItemSets | ItemSet[] | 消費後の有効期限ごとのアイテム所持数量のリスト |
consumeItemName | string | 消費したアイテムモデル名 |
consumeCount | long | 消費数量 |
Result
型 | 必須 | デフォルト | 値の制限 | 説明 |
---|