GS2-Mission
Reference for event triggers that call GS2-Script
GS2-Script Reference
Trigger
missionComplete
missionComplete
namespace = args.namespace
missionGroupModel = args.missionGroupModel
oldComplete = args.oldComplete
newComplete = args.newComplete
result = {
permit=permit
}
Event trigger to call GS2-Script before a mission is completed.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| missionGroupModel | MissionGroupModel | Mission Group |
| oldComplete | Complete | Before status of achievement |
| newComplete | Complete | After status of achievement |
Result
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Allow mission accomplishment |
missionCompleteDone
missionCompleteDone
namespace = args.namespace
missionGroupModel = args.missionGroupModel
complete = args.complete
result = {
}
GS2-Script called after a mission is completed.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| missionGroupModel | MissionGroupModel | Mission Group |
| complete | Complete | Status of achievement |
Result
| Type | Require | Default | Limitation | Description |
|---|
counterIncrement
counterIncrement
namespace = args.namespace
counterModel = args.counterModel
oldCounter = args.oldCounter
newCounter = args.newCounter
result = {
permit=permit
}
Event trigger to call GS2-Script before the counter rises.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| counterModel | CounterModel | Counter Model |
| oldCounter | Counter | Before Counter |
| newCounter | Counter | After Counter |
Result
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Allow counter rise |
counterIncrementDone
counterIncrementDone
namespace = args.namespace
counterModel = args.counterModel
counter = args.counter
result = {
}
GS2-Script called after the counter rises.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| counterModel | CounterModel | Counter Model |
| counter | Counter | Counter |
Result
| Type | Require | Default | Limitation | Description |
|---|
receiveRewards
receiveRewards
namespace = args.namespace
missionGroupModel = args.missionGroupModel
missionTaskModel = args.missionTaskModel
oldComplete = args.oldComplete
newComplete = args.newComplete
result = {
permit=permit
}
Event trigger to call GS2-Script before GS2-Script to be executed upon receipt of reward.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| missionGroupModel | MissionGroupModel | Mission Group |
| missionTaskModel | MissionTaskModel | Mission Task |
| oldComplete | Complete | Before status of achievement |
| newComplete | Complete | After status of achievement |
Result
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| permit | bool | ✓ | Allow counter rise |
receiveRewardsDone
receiveRewardsDone
namespace = args.namespace
missionGroupModel = args.missionGroupModel
missionTaskModel = args.missionTaskModel
complete = args.complete
result = {
}
GS2-Script called after GS2-Script to be executed upon receipt of reward.
Request
| Type | Description | |
|---|---|---|
| namespace | Namespace | Namespace |
| missionGroupModel | MissionGroupModel | Mission Group |
| missionTaskModel | MissionTaskModel | Mission Task |
| complete | Complete | status of achievement |
Result
| Type | Require | Default | Limitation | Description |
|---|