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

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

createWallet

ウォレット新規作成実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
walletWalletウォレット

Result

必須デフォルト値の制限説明
permitboolウォレットの作成を許可するか
initialAmountint~ 2147483645ウォレットの初期残高 - 無償付与として加算されます

実装例

namespace = args.namespace
wallet = args.wallet

result = {
  permit=permit,
  initialAmount=initialAmount
}

createWalletDone

ウォレット新規作成実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
walletWalletウォレット

Result

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

実装例

namespace = args.namespace
wallet = args.wallet

result = {
}

deposit

ウォレット残高加算実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
oldWalletWallet加算前のウォレット
newWalletWallet加算後のウォレット
pricefloat購入価格
depositCountint付与する課金通貨の数量

Result

必須デフォルト値の制限説明
permitboolウォレット残高加算を許可するか

実装例

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
price = args.price
depositCount = args.depositCount

result = {
  permit=permit
}

depositDone

ウォレット残高加算実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
oldWalletWallet加算前のウォレット
newWalletWallet加算後のウォレット
pricefloat購入価格
depositCountint付与する課金通貨の数量

Result

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

実装例

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
price = args.price
depositCount = args.depositCount

result = {
}

withdraw

ウォレット残高消費実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
oldWalletWallet消費前のウォレット
newWalletWallet消費後のウォレット
withdrawCountint消費する課金通貨の数量
paidOnlybool有償課金通貨のみを対象とするか

Result

必須デフォルト値の制限説明
permitboolウォレット残高消費を許可するか

実装例

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
withdrawCount = args.withdrawCount
paidOnly = args.paidOnly

result = {
  permit=permit
}

withdrawDone

ウォレット残高消費実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
oldWalletWallet消費前のウォレット
newWalletWallet消費後のウォレット
withdrawCountint消費する課金通貨の数量
paidOnlybool有償課金通貨のみを対象とするか

Result

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

実装例

namespace = args.namespace
oldWallet = args.oldWallet
newWallet = args.newWallet
withdrawCount = args.withdrawCount
paidOnly = args.paidOnly

result = {
}