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

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

トリガー

missionComplete

ミッション達成

同期実行スクリプト

ミッション達成処理の前に、スクリプトが同期実行されます。

Request
説明
namespaceNamespaceネームスペース
missionGroupModelMissionGroupModelミッショングループ
oldCompleteComplete達成前の達成状況
newCompleteComplete達成後の達成状況
completeTaskNames[]達成したタスク名のリスト
Result
必須デフォルト値の制限説明
permitbool
ミッション達成 を許可するか
実装例
-- Request
local namespace = args.namespace
local missionGroupModel = args.missionGroupModel
local oldComplete = args.oldComplete
local newComplete = args.newComplete
local completeTaskNames = args.completeTaskNames

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

ミッション達成処理の後に、スクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
missionGroupModelMissionGroupModelミッショングループ
completeComplete達成状況
completeTaskNames[]達成したタスク名のリスト
実装例
-- Request
local namespace = args.namespace
local missionGroupModel = args.missionGroupModel
local complete = args.complete
local completeTaskNames = args.completeTaskNames

-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.

result = {
}

counterIncrement

カウンター上昇

同期実行スクリプト

カウンター上昇処理の前に、スクリプトが同期実行されます。

Request
説明
namespaceNamespaceネームスペース
counterModelCounterModelカウンターモデル
oldCounterCounter更新前のカウンター
newCounterCounter更新後のカウンター
Result
必須デフォルト値の制限説明
permitbool
カウンター上昇 を許可するか
実装例
-- Request
local namespace = args.namespace
local counterModel = args.counterModel
local oldCounter = args.oldCounter
local newCounter = args.newCounter

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

カウンター上昇処理の後に、スクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
counterModelCounterModelカウンターモデル
counterCounterカウンター
実装例
-- Request
local namespace = args.namespace
local counterModel = args.counterModel
local counter = args.counter

-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.

result = {
}

receiveRewards

報酬受取

同期実行スクリプト

報酬受取処理の前に、スクリプトが同期実行されます。

Request
説明
namespaceNamespaceネームスペース
missionGroupModelMissionGroupModelミッショングループ
oldCompleteComplete更新前の達成状況
newCompleteComplete更新後の達成状況
receiveRewardTaskNames[]報酬を受け取るタスク名リスト
Result
必須デフォルト値の制限説明
permitbool
報酬受取 を許可するか
実装例
-- Request
local namespace = args.namespace
local missionGroupModel = args.missionGroupModel
local oldComplete = args.oldComplete
local newComplete = args.newComplete
local receiveRewardTaskNames = args.receiveRewardTaskNames

-- Business logic:
local permit = true

-- Result
result = {
  permit=permit
}

非同期実行スクリプト

報酬受取処理の後に、スクリプトが非同期実行されます。

Request
説明
namespaceNamespaceネームスペース
missionGroupModelMissionGroupModelミッショングループ
completeComplete達成状況
receiveRewardTaskNames[]報酬を受け取るタスク名リスト
実装例
-- Request
local namespace = args.namespace
local missionGroupModel = args.missionGroupModel
local complete = args.complete
local receiveRewardTaskNames = args.receiveRewardTaskNames

-- Asynchronous scripts typically do not affect the API response.
-- Use for logging, analytics, external notifications, etc.

result = {
}