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
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| missionGroupModel | MissionGroupModel | Mission Group |
| oldComplete | Complete | Before status of achievement |
| newComplete | Complete | After status of achievement |
| completeTaskNames | string[] | List of completed task names |
Result
| Type | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | 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
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| missionGroupModel | MissionGroupModel | Mission Group |
| complete | Complete | Status of achievement |
| completeTaskNames | string[] | List of completed task names |
Result
| Type | Required | Default | Value Limits | Description |
|---|
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
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| counterModel | CounterModel | Counter Model |
| oldCounter | Counter | Before Counter |
| newCounter | Counter | After Counter |
Result
| Type | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | 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
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| counterModel | CounterModel | Counter Model |
| counter | Counter | Counter |
Result
| Type | Required | Default | Value Limits | Description |
|---|
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
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| missionGroupModel | MissionGroupModel | Mission Group |
| oldComplete | Complete | Before status of achievement |
| newComplete | Complete | After status of achievement |
| receiveRewardTaskNames | string[] | List of task names to receive rewards |
Result
| Type | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | 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
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| missionGroupModel | MissionGroupModel | Mission Group |
| complete | Complete | status of achievement |
| receiveRewardTaskNames | string[] | List of task names to receive rewards |
Result
| Type | Required | Default | Value Limits | Description |
|---|
Implementation Example
namespace = args.namespace
missionGroupModel = args.missionGroupModel
complete = args.complete
receiveRewardTaskNames = args.receiveRewardTaskNames
result = {
}