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

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

startQuest

クエスト開始実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
questGroupModelQuestGroupModelクエストグループモデル
questModelQuestModelクエストモデル
randomSeedlong乱数シード
rewardsReward[]クエストで得られる報酬の上限
configConfig[]トランザクションの変数に適用する設定値

Result

必須デフォルト値の制限説明
permitboolクエスト開始を許可するか
overrideRandomSeedlong~ 9223372036854775805乱数シード
overrideRewardsReward[]~ 1000 itemsクエストで得られる報酬の上限

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
randomSeed = args.randomSeed
rewards = args.rewards
config = args.config

result = {
  permit=permit,
  overrideRandomSeed=overrideRandomSeed,
  overrideRewards=overrideRewards
}

startQuestDone

クエスト開始実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
questGroupModelQuestGroupModelクエストグループモデル
questModelQuestModelクエストモデル
progressProgressクエスト進行状況
configConfig[]トランザクションの変数に適用する設定値

Result

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

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
progress = args.progress
config = args.config

result = {
}

completeQuest

クエストクリア実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
questGroupModelQuestGroupModelクエストグループモデル
questModelQuestModelクエストモデル
rewardsReward[]クエストで得た報酬
progressProgressクエスト進行状況
configConfig[]トランザクションの変数に適用する設定値

Result

必須デフォルト値の制限説明
permitboolクエストクリアを許可するか
overrideRewardsReward[]~ 1000 itemsクエストで得られる報酬の上限

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
progress = args.progress
config = args.config

result = {
  permit=permit,
  overrideRewards=overrideRewards
}

completeQuestDone

クエストクリア実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
questGroupModelQuestGroupModelクエストグループモデル
questModelQuestModelクエストモデル
rewardsReward[]クエストで得た報酬
progressProgressクエスト進行状況
configConfig[]トランザクションの変数に適用する設定値

Result

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

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
progress = args.progress
config = args.config

result = {
}

failedQuest

クエスト失敗実行前にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
questGroupModelQuestGroupModelクエストグループモデル
questModelQuestModelクエストモデル
rewardsReward[]クエストで得た報酬
configConfig[]トランザクションの変数に適用する設定値

Result

必須デフォルト値の制限説明
permitboolクエスト失敗を許可するか
overrideRewardsReward[]~ 1000 itemsクエストで得られる報酬の上限

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
config = args.config

result = {
  permit=permit,
  overrideRewards=overrideRewards
}

failedQuestDone

クエスト失敗実行後にGS2-Scriptを呼び出すイベントトリガー

Request

説明
namespaceNamespaceネームスペース
questGroupModelQuestGroupModelクエストグループモデル
questModelQuestModelクエストモデル
rewardsReward[]クエストで得た報酬
configConfig[]トランザクションの変数に適用する設定値

Result

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

実装例

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
config = args.config

result = {
}