Trigger Reference of GS2-Mission Script

Reference of event triggers that call extended scripts

Trigger

missionComplete

a mission is completed

Synchronous Execution Script

Script and a mission is completed are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
missionGroupModelMissionGroupModelMission Group
oldCompleteCompleteBefore status of achievement
newCompleteCompleteAfter status of achievement
completeTaskNamesstring[]List of completed task names
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow mission accomplishment
Implementation Example
namespace = args.namespace
missionGroupModel = args.missionGroupModel
oldComplete = args.oldComplete
newComplete = args.newComplete
completeTaskNames = args.completeTaskNames

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the a mission is completed is executed.

Request
TypeDescription
namespaceNamespaceNamespace
missionGroupModelMissionGroupModelMission Group
completeCompleteStatus of achievement
completeTaskNamesstring[]List of completed task names
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
missionGroupModel = args.missionGroupModel
complete = args.complete
completeTaskNames = args.completeTaskNames

result = {
}

counterIncrement

the counter rises

Synchronous Execution Script

Script and the counter rises are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
counterModelCounterModelCounter Model
oldCounterCounterBefore Counter
newCounterCounterAfter Counter
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow counter rise
Implementation Example
namespace = args.namespace
counterModel = args.counterModel
oldCounter = args.oldCounter
newCounter = args.newCounter

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the the counter rises is executed.

Request
TypeDescription
namespaceNamespaceNamespace
counterModelCounterModelCounter Model
counterCounterCounter
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
counterModel = args.counterModel
counter = args.counter

result = {
}

receiveRewards

GS2-Script to be executed upon receipt of reward

Synchronous Execution Script

Script and GS2-Script to be executed upon receipt of reward are executed synchronously in that order.

Request
TypeDescription
namespaceNamespaceNamespace
missionGroupModelMissionGroupModelMission Group
oldCompleteCompleteBefore status of achievement
newCompleteCompleteAfter status of achievement
receiveRewardTaskNamesstring[]List of task names to receive rewards
Result
TypeRequiredDefaultValue LimitsDescription
permitbool
Whether to allow counter rise
Implementation Example
namespace = args.namespace
missionGroupModel = args.missionGroupModel
oldComplete = args.oldComplete
newComplete = args.newComplete
receiveRewardTaskNames = args.receiveRewardTaskNames

result = {
  permit=permit
}

Asynchronous Execution Script

The script will run after the GS2-Script to be executed upon receipt of reward is executed.

Request
TypeDescription
namespaceNamespaceNamespace
missionGroupModelMissionGroupModelMission Group
completeCompletestatus of achievement
receiveRewardTaskNamesstring[]List of task names to receive rewards
Result
TypeRequiredDefaultValue LimitsDescription
Implementation Example
namespace = args.namespace
missionGroupModel = args.missionGroupModel
complete = args.complete
receiveRewardTaskNames = args.receiveRewardTaskNames

result = {
}