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

拡張スクリプトを呼び出す イベントトリガー のリファレンス

トリガー

rankCapScript

ランクキャップ取得

同期実行スクリプト

スクリプト、ランクキャップ取得の順に同期実行されます。

Request
説明
namespaceNamespaceネームスペース
experienceModelExperienceModel経験値モデル
userIdstringユーザーID
propertyIdstringプロパティID
Result
必須デフォルト値の制限説明
rankCaplong
0 ~ 2147483645ランクキャップ
実装例
namespace = args.namespace
experienceModel = args.experienceModel
userId = args.userId
propertyId = args.propertyId

result = {
  rankCap=rankCap
}

changeExperience

経験値変化

同期実行スクリプト

スクリプト、経験値変化の順に同期実行されます。

Request
説明
namespaceNamespaceネームスペース
experienceModelExperienceModel経験値モデル
statusStatus変化前ステータス
afterStatusStatus変化後ステータス
Result
必須デフォルト値の制限説明
permitbool
経験値変化 を許可するか
overrideExperienceValuelong
0 ~ 2147483645上書きする経験値
実装例
namespace = args.namespace
experienceModel = args.experienceModel
status = args.status
afterStatus = args.afterStatus

result = {
  permit=permit,
  overrideExperienceValue=overrideExperienceValue
}

非同期実行スクリプト

経験値変化の実行後にスクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
experienceModelExperienceModel経験値モデル
oldStatusStatus変化前のステータス
statusStatusステータス
実装例
namespace = args.namespace
experienceModel = args.experienceModel
oldStatus = args.oldStatus
status = args.status

result = {
}

changeRank

ランク変化

同期実行スクリプト

スクリプト、ランク変化の順に同期実行されます。

Request
説明
namespaceNamespaceネームスペース
experienceModelExperienceModel経験値モデル
statusStatus変化前のステータス
afterStatusStatus変化後のステータス
Result
必須デフォルト値の制限説明
permitbool
ランク変化 を許可するか
実装例
namespace = args.namespace
experienceModel = args.experienceModel
status = args.status
afterStatus = args.afterStatus

result = {
  permit=permit
}

非同期実行スクリプト

ランク変化の実行後にスクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
experienceModelExperienceModel経験値モデル
oldStatusStatus変化前のステータス
statusStatusステータス
実装例
namespace = args.namespace
experienceModel = args.experienceModel
oldStatus = args.oldStatus
status = args.status

result = {
}

changeRankCap

ランクキャップ変化

同期実行スクリプト

スクリプト、ランクキャップ変化の順に同期実行されます。

Request
説明
namespaceNamespaceネームスペース
experienceModelExperienceModel経験値モデル
statusStatus変化前のステータス
afterStatusStatus変化後のステータス
Result
必須デフォルト値の制限説明
permitbool
ランクキャップ変化 を許可するか
overrideRankCapValuelong
0 ~ 2147483645新しいランクキャップ
実装例
namespace = args.namespace
experienceModel = args.experienceModel
status = args.status
afterStatus = args.afterStatus

result = {
  permit=permit,
  overrideRankCapValue=overrideRankCapValue
}

非同期実行スクリプト

ランクキャップ変化の実行後にスクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
experienceModelExperienceModel経験値モデル
statusStatusステータス
実装例
namespace = args.namespace
experienceModel = args.experienceModel
status = args.status

result = {
}

overflowExperience

経験値あふれ

同期実行スクリプト

スクリプト、経験値あふれの順に同期実行されます。

Request
説明
namespaceNamespaceネームスペース
experienceModelExperienceModel経験値モデル
statusStatusステータス
overflowExperienceValuelong経験値あふれ量
Result
必須デフォルト値の制限説明
permitbool
経験値あふれ を許可するか
実装例
namespace = args.namespace
experienceModel = args.experienceModel
status = args.status
overflowExperienceValue = args.overflowExperienceValue

result = {
  permit=permit
}