GS2-Mission Deploy/CDK Reference
The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
Entities
Resources targeted by the Deploy operation
Namespace
Namespace
A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.
Therefore, you must create a namespace before you can start using each service.
Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| description | string | ~ 1024 chars | Description | |||
| transactionSetting | TransactionSetting | ✓ | Transaction Setting Settings for distributed transactions used when granting mission completion rewards. | |||
| missionCompleteScript | ScriptSetting | Script to run when a mission is accomplished Script Trigger Reference - missionComplete | ||||
| counterIncrementScript | ScriptSetting | Script to run when the counter rises Script Trigger Reference - counterIncrement | ||||
| receiveRewardsScript | ScriptSetting | Script to run when a reward is received Script Trigger Reference - receiveRewards | ||||
| completeNotification | NotificationSetting | ✓ | Push notifications when mission tasks are accomplished Configures push notifications delivered via GS2-Gateway when a mission task’s completion conditions are met. This allows the game client to immediately reflect the accomplishment in the UI. | |||
| logSetting | LogSetting | Log Output Setting Specifies the GS2-Log namespace to which API request and response logs for this namespace will be output. Useful for debugging counter increments, mission completions, and reward receipts. |
GetAttr
Resource creation results that can be retrieved using the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Created namespace |
Implementation Example
Type: GS2::Mission::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting:
EnableAutoRun: true
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
MissionCompleteScript: null
CounterIncrementScript: null
ReceiveRewardsScript: null
CompleteNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/mission"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
mission.NewNamespace(
&SampleStack,
"namespace-0001",
mission.NamespaceOptions{
TransactionSetting: core.NewTransactionSetting(
core.TransactionSettingOptions{
QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
},
),
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(SampleStack.Yaml()) // Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Mission\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Mission\Model\Options\NamespaceOptions(
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
new \Gs2Cdk\Core\Model\TransactionSettingOptions(
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
)
),
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
)
);
}
}
print((new SampleStack())->yaml()); // Generate Templateclass SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.mission.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.mission.model.options.NamespaceOptions()
.withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
new io.gs2.cdk.core.model.options.TransactionSettingOptions()
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
))
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Mission.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Mission.Model.Options.NamespaceOptions
{
transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
options: new Gs2Cdk.Core.Model.TransactionSettingOptions
{
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";
class SampleStack extends core.Stack
{
public constructor() {
super();
new mission.model.Namespace(
this,
"namespace-0001",
{
transactionSetting: new core.TransactionSetting(
{
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Templatefrom gs2_cdk import Stack, core, mission
class SampleStack(Stack):
def __init__(self):
super().__init__()
mission.Namespace(
stack=self,
name='namespace-0001',
options=mission.NamespaceOptions(
transaction_setting=core.TransactionSetting(
options=core.TransactionSettingOptions(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
)
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate TemplateTransactionSetting
Transaction Setting
Transaction Setting controls how transactions are executed, including their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | false | Whether to automatically execute issued transactions on the server side | |||
| enableAtomicCommit | bool | {enableAutoRun} == true | false | Whether to commit the execution of transactions atomically * Applicable only if enableAutoRun is true | ||
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | Whether to execute transactions asynchronously * Applicable only if enableAtomicCommit is true | ||
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | false | Whether to execute the commit processing of the script result asynchronously * Applicable only if transactionUseDistributor is true | ||
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | Whether to use GS2-JobQueue to execute the acquire action * Applicable only if enableAtomicCommit is true | ||
| distributorNamespaceId | string | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor Namespace GRN used to execute transactions | ||
| queueNamespaceId | string | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute transactions |
ScriptSetting
Script Setting
In GS2, you can associate custom scripts with microservice events and execute them. This model holds the settings for triggering script execution.
There are two main ways to execute a script: synchronous execution and asynchronous execution. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script’s execution results to halt API execution or control the API’s response content.
In contrast, asynchronous execution does not block processing until the script has finished executing. However, because the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API response flow and is generally recommended.
There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge. By using Amazon EventBridge, you can write processing in languages other than Lua.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024 chars | GS2-Script script GRN
executed synchronously when the API is executed Must be specified in GRN format starting with “grn:gs2:”. | |||||||||||
| doneTriggerTargetType | String Enum enum { “none”, “gs2_script”, “aws” } | “none” | How to execute asynchronous scripts Specifies the type of script to use for asynchronous execution. You can choose from “Do not use asynchronous execution (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
| |||||||||||
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-Script script GRN
for asynchronous execution Must be specified in GRN format starting with “grn:gs2:”. * Applicable only if doneTriggerTargetType is “gs2_script” | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-JobQueue namespace GRN
to execute asynchronous execution scripts If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN. There are not many cases where GS2-JobQueue is required, so you generally do not need to specify it unless you have a specific reason. * Applicable only if doneTriggerTargetType is “gs2_script” |
NotificationSetting
Push Notification Settings
This is a setting for sending push notifications when an event occurs in a GS2 microservice. The push notification here refers to the processing via the WebSocket interface provided by GS2-Gateway, and is different from the push notification of a smartphone. For example, when a matchmaking is completed or a friend request is received, the GS2-Gateway can send a push notification via the WebSocket interface, and the game client can detect the change of the state.
GS2-Gateway’s push notifications can be used to forward notifications to mobile push notification services when the destination device is offline. By properly utilizing mobile push notifications, you can implement a flow in which players are notified even if they exit the game during matchmaking and later return to it.
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| gatewayNamespaceId | string | “grn:gs2:{region}:{ownerId}:gateway:default” | ~ 1024 chars | GS2-Gateway namespace to use for push notifications Specify the GS2-Gateway namespace ID in GRN format starting with “grn:gs2:”. | ||||||||
| enableTransferMobileNotification | bool? | false | Whether to forward the notification as a mobile push notification When this notification is sent and the destination device is offline, specify whether to forward it as a mobile push notification. | |||||||||
| sound | string | {enableTransferMobileNotification} == true | ~ 1024 chars | Sound file name to be used for mobile push notifications The sound file name specified here is used when sending mobile push notifications, and you can send notifications with a special sound. * Applicable only if enableTransferMobileNotification is true | ||||||||
| enable | String Enum enum { “Enabled”, “Disabled” } | “Enabled” | Whether to enable push notifications
|
LogSetting
Log Output Setting
Log Output Setting defines how log data is exported. This type holds the GS2-Log namespace identifier (Namespace ID) used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, debugging, and other operational purposes.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | GS2-Log namespace GRN
to output logs Must be specified in GRN format starting with “grn:gs2:”. |
CurrentMissionMaster
Currently active Mission Model master data
This master data describes the definitions of Mission Models currently active within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on the server.
To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for game operations and export JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-Mission for the JSON file format.Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| mode | String Enum enum { “direct”, “preUpload” } | “direct” | Update mode
| |||||||||
| settings | string | {mode} == “direct” | ✓* | ~ 5242880 chars | Master Data * Required if mode is “direct” | |||||||
| uploadToken | string | {mode} == “preUpload” | ✓* | ~ 1024 chars | Token obtained by pre-upload Used to apply the uploaded master data. * Required if mode is “preUpload” |
GetAttr
Resource creation results that can be retrieved using the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentMissionMaster | Updated master data of the currently active Mission Models |
Implementation Example
Type: GS2::Mission::CurrentMissionMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2019-05-28",
"groups": [
{
"name": "daily",
"resetType": "daily",
"metadata": "DAILY",
"tasks": [
{
"name": "quest_x10",
"metadata": "QUEST_X10",
"counterName": "quest_complete",
"targetValue": 10,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
},
{
"name": "quest_x20",
"metadata": "QUEST_X20",
"counterName": "quest_complete",
"premiseMissionTaskName": "quest_x10",
"targetValue": 20,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
},
{
"name": "gacha",
"metadata": "GACHA",
"counterName": "lot_gacha",
"targetValue": 1,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
}
],
"resetHour": 10
},
{
"name": "weekly",
"resetType": "weekly",
"metadata": "WEEKLY",
"tasks": [
{
"name": "quest_x100",
"metadata": "QUEST_X100",
"counterName": "quest_complete",
"targetValue": 100,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
},
{
"name": "quest_x1000",
"metadata": "QUEST_X1000",
"counterName": "quest_complete",
"premiseMissionTaskName": "quest_x100",
"targetValue": 1000,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
}
],
"resetDayOfWeek": "monday",
"resetHour": 10
},
{
"name": "story",
"resetType": "notReset",
"metadata": "STORY",
"tasks": [
{
"name": "quest_1-1",
"metadata": "QUEST_1-1",
"counterName": "quest1",
"targetValue": 1
},
{
"name": "quest_1-2",
"metadata": "QUEST_1-2",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-1",
"targetValue": 1
},
{
"name": "quest_1-3",
"metadata": "QUEST_1-3",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-2",
"targetValue": 1
},
{
"name": "quest_1-4",
"metadata": "QUEST_1-4",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-3",
"targetValue": 1
},
{
"name": "quest_2-1",
"metadata": "QUEST_2-1",
"counterName": "quest2",
"premiseMissionTaskName": "quest_1-4",
"targetValue": 1
}
]
}
],
"counters": [
{
"name": "quest_complete",
"scopes": [
{
"resetType": "daily",
"resetHour": 5
},
{
"resetType": "weekly",
"resetDayOfWeek": "monday",
"resetHour": 5
}
],
"metadata": "QUEST_COMPLETE"
},
{
"name": "lot_gacha",
"scopes": [
{
"resetType": "daily",
"resetHour": 5
}
],
"metadata": "LOT_GACHA"
},
{
"name": "quest1",
"scopes": [
{
"resetType": "notReset"
}
],
"metadata": "QUEST1"
},
{
"name": "quest2",
"scopes": [
{
"resetType": "notReset"
}
],
"metadata": "QUEST2"
}
]
}
UploadToken: nullimport (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/mission"
"github.com/gs2io/gs2-golang-cdk/experience"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
mission.NewNamespace(
&SampleStack,
"namespace-0001",
mission.NamespaceOptions{},
).MasterData(
[]mission.MissionGroupModel{
mission.NewMissionGroupModel(
"daily",
mission.MissionGroupModelResetTypeDaily,
mission.MissionGroupModelOptions{
Metadata: pointy.String("DAILY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_x10",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X10"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
"#{userId}",
),
},
},
),
mission.NewMissionTaskModel(
"quest_x20",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X20"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
"#{userId}",
),
},
PremiseMissionTaskName: pointy.String("quest_x10"),
},
),
mission.NewMissionTaskModel(
"gacha",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("GACHA"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
"#{userId}",
),
},
},
),
},
ResetHour: pointy.Int32(10),
},
),
mission.NewMissionGroupModel(
"weekly",
mission.MissionGroupModelResetTypeWeekly,
mission.MissionGroupModelOptions{
Metadata: pointy.String("WEEKLY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_x100",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X100"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
"#{userId}",
),
},
},
),
mission.NewMissionTaskModel(
"quest_x1000",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X1000"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
"#{userId}",
),
},
PremiseMissionTaskName: pointy.String("quest_x100"),
},
),
},
ResetDayOfWeek: mission.MissionGroupModelResetDayOfWeekMonday.Pointer(),
ResetHour: pointy.Int32(10),
},
),
mission.NewMissionGroupModel(
"story",
mission.MissionGroupModelResetTypeNotReset,
mission.MissionGroupModelOptions{
Metadata: pointy.String("STORY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_1-1",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-1"),
},
),
mission.NewMissionTaskModel(
"quest_1-2",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-2"),
PremiseMissionTaskName: pointy.String("quest_1-1"),
},
),
mission.NewMissionTaskModel(
"quest_1-3",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-3"),
PremiseMissionTaskName: pointy.String("quest_1-2"),
},
),
mission.NewMissionTaskModel(
"quest_1-4",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-4"),
PremiseMissionTaskName: pointy.String("quest_1-3"),
},
),
mission.NewMissionTaskModel(
"quest_2-1",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_2-1"),
PremiseMissionTaskName: pointy.String("quest_1-4"),
},
),
},
},
),
},
[]mission.CounterModel{
mission.NewCounterModel(
"quest_complete",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeDaily,
mission.CounterScopeModelOptions{
ResetHour: pointy.Int32(5),
},
),
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeWeekly,
mission.CounterScopeModelOptions{
ResetDayOfWeek: mission.CounterScopeModelResetDayOfWeekMonday.Pointer(),
ResetHour: pointy.Int32(5),
},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST_COMPLETE"),
},
),
mission.NewCounterModel(
"lot_gacha",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeDaily,
mission.CounterScopeModelOptions{
ResetHour: pointy.Int32(5),
},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("LOT_GACHA"),
},
),
mission.NewCounterModel(
"quest1",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeNotReset,
mission.CounterScopeModelOptions{},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST1"),
},
),
mission.NewCounterModel(
"quest2",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeNotReset,
mission.CounterScopeModelOptions{},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST2"),
},
),
},
)
println(SampleStack.Yaml()) // Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Mission\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\Mission\Model\MissionGroupModel(
name:"daily",
resetType: \Gs2Cdk\Mission\Model\Enums\MissionGroupModelResetType::DAILY,
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"DAILY",
tasks:[
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x10",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_X10",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
)
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x20",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_X20",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
premiseMissionTaskName: "quest_x10",
)
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "gacha",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "GACHA",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
)
),
],
resetHour:10
)
),
new \Gs2Cdk\Mission\Model\MissionGroupModel(
name:"weekly",
resetType: \Gs2Cdk\Mission\Model\Enums\MissionGroupModelResetType::WEEKLY,
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"WEEKLY",
tasks:[
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x100",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_X100",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
)
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x1000",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_X1000",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
premiseMissionTaskName: "quest_x100",
)
),
],
resetDayOfWeek:Gs2Cdk\Mission\Model\Enums\MissionGroupModelResetDayOfWeek::MONDAY,
resetHour:10
)
),
new \Gs2Cdk\Mission\Model\MissionGroupModel(
name:"story",
resetType: \Gs2Cdk\Mission\Model\Enums\MissionGroupModelResetType::NOT_RESET,
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"STORY",
tasks:[
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-1",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_1-1",
)
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-2",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_1-2",
premiseMissionTaskName: "quest_1-1",
)
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-3",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_1-3",
premiseMissionTaskName: "quest_1-2",
)
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-4",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_1-4",
premiseMissionTaskName: "quest_1-3",
)
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_2-1",
verifyCompleteType: Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_2-1",
premiseMissionTaskName: "quest_1-4",
)
),
]
)
)
],
[
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest_complete",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::DAILY,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetHour: 5,
)
),
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::WEEKLY,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetDayOfWeek: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetDayOfWeek::MONDAY,
resetHour: 5,
)
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST_COMPLETE"
)
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"lot_gacha",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::DAILY,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetHour: 5,
)
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"LOT_GACHA"
)
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest1",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::NOT_RESET,
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST1"
)
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest2",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::NOT_RESET,
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST2"
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Templateclass SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.mission.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.mission.model.MissionGroupModel(
"daily",
io.gs2.cdk.mission.model.enums.MissionGroupModelResetType.DAILY,
new io.gs2.cdk.mission.model.options.MissionGroupModelOptions()
.withMetadata("DAILY")
.withTasks(Arrays.asList(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x10",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_X10")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x20",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_X20")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
.withPremiseMissionTaskName("quest_x10")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"gacha",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("GACHA")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
)
))
.withResetHour(10)
),
new io.gs2.cdk.mission.model.MissionGroupModel(
"weekly",
io.gs2.cdk.mission.model.enums.MissionGroupModelResetType.WEEKLY,
new io.gs2.cdk.mission.model.options.MissionGroupModelOptions()
.withMetadata("WEEKLY")
.withTasks(Arrays.asList(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x100",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_X100")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x1000",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_X1000")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
.withPremiseMissionTaskName("quest_x100")
)
))
.withResetDayOfWeek(io.gs2.cdk.mission.model.enums.MissionGroupModelResetDayOfWeek.MONDAY)
.withResetHour(10)
),
new io.gs2.cdk.mission.model.MissionGroupModel(
"story",
io.gs2.cdk.mission.model.enums.MissionGroupModelResetType.NOT_RESET,
new io.gs2.cdk.mission.model.options.MissionGroupModelOptions()
.withMetadata("STORY")
.withTasks(Arrays.asList(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-1",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_1-1")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-2",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_1-2")
.withPremiseMissionTaskName("quest_1-1")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-3",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_1-3")
.withPremiseMissionTaskName("quest_1-2")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-4",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_1-4")
.withPremiseMissionTaskName("quest_1-3")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_2-1",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_2-1")
.withPremiseMissionTaskName("quest_1-4")
)
))
)
),
Arrays.asList(
new io.gs2.cdk.mission.model.CounterModel(
"quest_complete",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.DAILY,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetHour(5)
),
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.WEEKLY,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetDayOfWeek(io.gs2.cdk.mission.model.enums.CounterScopeModelResetDayOfWeek.MONDAY)
.withResetHour(5)
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions()
.withMetadata("QUEST_COMPLETE")
),
new io.gs2.cdk.mission.model.CounterModel(
"lot_gacha",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.DAILY,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetHour(5)
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions()
.withMetadata("LOT_GACHA")
),
new io.gs2.cdk.mission.model.CounterModel(
"quest1",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.NOT_RESET
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions()
.withMetadata("QUEST1")
),
new io.gs2.cdk.mission.model.CounterModel(
"quest2",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.NOT_RESET
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions()
.withMetadata("QUEST2")
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Mission.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel[] {
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
name: "daily",
resetType: Gs2Cdk.Gs2Mission.Model.Enums.MissionGroupModelResetType.Daily,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions
{
metadata = "DAILY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[]
{
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x10",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_X10",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
}
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x20",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_X20",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
},
premiseMissionTaskName = "quest_x10"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "gacha",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "GACHA",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
}
}
)
},
resetHour = 10
}
),
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
name: "weekly",
resetType: Gs2Cdk.Gs2Mission.Model.Enums.MissionGroupModelResetType.Weekly,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions
{
metadata = "WEEKLY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[]
{
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x100",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_X100",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
}
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x1000",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_X1000",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
},
premiseMissionTaskName = "quest_x100"
}
)
},
resetDayOfWeek = Gs2Cdk.Gs2Mission.Model.Enums.MissionGroupModelResetDayOfWeek.Monday,
resetHour = 10
}
),
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
name: "story",
resetType: Gs2Cdk.Gs2Mission.Model.Enums.MissionGroupModelResetType.NotReset,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions
{
metadata = "STORY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[]
{
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-1",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_1-1"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-2",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_1-2",
premiseMissionTaskName = "quest_1-1"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-3",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_1-3",
premiseMissionTaskName = "quest_1-2"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-4",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_1-4",
premiseMissionTaskName = "quest_1-3"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_2-1",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_2-1",
premiseMissionTaskName = "quest_1-4"
}
)
}
}
)
},
new Gs2Cdk.Gs2Mission.Model.CounterModel[] {
new Gs2Cdk.Gs2Mission.Model.CounterModel(
name: "quest_complete",
scopes: new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[]
{
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Daily,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetHour = 5
}
),
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Weekly,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetDayOfWeek = Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetDayOfWeek.Monday,
resetHour = 5
}
)
},
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions
{
metadata = "QUEST_COMPLETE"
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
name: "lot_gacha",
scopes: new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[]
{
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Daily,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetHour = 5
}
)
},
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions
{
metadata = "LOT_GACHA"
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
name: "quest1",
scopes: new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[]
{
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.NotReset
)
},
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions
{
metadata = "QUEST1"
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
name: "quest2",
scopes: new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[]
{
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.NotReset
)
},
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions
{
metadata = "QUEST2"
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";
import experience from "@/gs2cdk/experience";
class SampleStack extends core.Stack
{
public constructor() {
super();
new mission.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new mission.model.MissionGroupModel(
"daily",
mission.model.MissionGroupModelResetType.DAILY,
{
metadata: "DAILY",
tasks: [
new mission.model.MissionTaskModel(
"quest_x10",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X10",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
"#{userId}"
),
]
}
),
new mission.model.MissionTaskModel(
"quest_x20",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X20",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
"#{userId}"
),
],
premiseMissionTaskName: "quest_x10"
}
),
new mission.model.MissionTaskModel(
"gacha",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "GACHA",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
"#{userId}"
),
]
}
),
],
resetHour: 10
}
),
new mission.model.MissionGroupModel(
"weekly",
mission.model.MissionGroupModelResetType.WEEKLY,
{
metadata: "WEEKLY",
tasks: [
new mission.model.MissionTaskModel(
"quest_x100",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X100",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
"#{userId}"
),
]
}
),
new mission.model.MissionTaskModel(
"quest_x1000",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X1000",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
"#{userId}"
),
],
premiseMissionTaskName: "quest_x100"
}
),
],
resetDayOfWeek: mission.model.MissionGroupModelResetDayOfWeek.MONDAY,
resetHour: 10
}
),
new mission.model.MissionGroupModel(
"story",
mission.model.MissionGroupModelResetType.NOT_RESET,
{
metadata: "STORY",
tasks: [
new mission.model.MissionTaskModel(
"quest_1-1",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_1-1"
}
),
new mission.model.MissionTaskModel(
"quest_1-2",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_1-2",
premiseMissionTaskName: "quest_1-1"
}
),
new mission.model.MissionTaskModel(
"quest_1-3",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_1-3",
premiseMissionTaskName: "quest_1-2"
}
),
new mission.model.MissionTaskModel(
"quest_1-4",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_1-4",
premiseMissionTaskName: "quest_1-3"
}
),
new mission.model.MissionTaskModel(
"quest_2-1",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_2-1",
premiseMissionTaskName: "quest_1-4"
}
),
]
}
)
],
[
new mission.model.CounterModel(
"quest_complete",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.DAILY,
{
resetHour: 5
}
),
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.WEEKLY,
{
resetDayOfWeek: mission.model.CounterScopeModelResetDayOfWeek.MONDAY,
resetHour: 5
}
),
],
{
metadata: "QUEST_COMPLETE"
}
),
new mission.model.CounterModel(
"lot_gacha",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.DAILY,
{
resetHour: 5
}
),
],
{
metadata: "LOT_GACHA"
}
),
new mission.model.CounterModel(
"quest1",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.NOT_RESET
),
],
{
metadata: "QUEST1"
}
),
new mission.model.CounterModel(
"quest2",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.NOT_RESET
),
],
{
metadata: "QUEST2"
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Templatefrom gs2_cdk import Stack, core, mission, experience
class SampleStack(Stack):
def __init__(self):
super().__init__()
mission.Namespace(
stack=self,
name="namespace-0001",
).master_data(
groups=[
mission.MissionGroupModel(
name='daily',
reset_type=mission.MissionGroupModelResetType.DAILY,
options=mission.MissionGroupModelOptions(
metadata = 'DAILY',
tasks = [
mission.MissionTaskModel(
name='quest_x10',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_X10',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
),
),
mission.MissionTaskModel(
name='quest_x20',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_X20',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
premise_mission_task_name='quest_x10',
),
),
mission.MissionTaskModel(
name='gacha',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='GACHA',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
),
),
],
reset_hour = 10
),
),
mission.MissionGroupModel(
name='weekly',
reset_type=mission.MissionGroupModelResetType.WEEKLY,
options=mission.MissionGroupModelOptions(
metadata = 'WEEKLY',
tasks = [
mission.MissionTaskModel(
name='quest_x100',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_X100',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
),
),
mission.MissionTaskModel(
name='quest_x1000',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_X1000',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
premise_mission_task_name='quest_x100',
),
),
],
reset_day_of_week = mission.MissionGroupModelResetDayOfWeek.MONDAY,
reset_hour = 10
),
),
mission.MissionGroupModel(
name='story',
reset_type=mission.MissionGroupModelResetType.NOT_RESET,
options=mission.MissionGroupModelOptions(
metadata = 'STORY',
tasks = [
mission.MissionTaskModel(
name='quest_1-1',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_1-1',
),
),
mission.MissionTaskModel(
name='quest_1-2',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_1-2',
premise_mission_task_name='quest_1-1',
),
),
mission.MissionTaskModel(
name='quest_1-3',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_1-3',
premise_mission_task_name='quest_1-2',
),
),
mission.MissionTaskModel(
name='quest_1-4',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_1-4',
premise_mission_task_name='quest_1-3',
),
),
mission.MissionTaskModel(
name='quest_2-1',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_2-1',
premise_mission_task_name='quest_1-4',
),
),
]
),
),
],
counters=[
mission.CounterModel(
name='quest_complete',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.DAILY,
options=mission.CounterScopeModelOptions(
reset_hour=5,
),
),
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.WEEKLY,
options=mission.CounterScopeModelOptions(
reset_day_of_week=mission.CounterScopeModelResetDayOfWeek.MONDAY,
reset_hour=5,
),
),
],
options=mission.CounterModelOptions(
metadata = 'QUEST_COMPLETE'
),
),
mission.CounterModel(
name='lot_gacha',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.DAILY,
options=mission.CounterScopeModelOptions(
reset_hour=5,
),
),
],
options=mission.CounterModelOptions(
metadata = 'LOT_GACHA'
),
),
mission.CounterModel(
name='quest1',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.NOT_RESET,
),
],
options=mission.CounterModelOptions(
metadata = 'QUEST1'
),
),
mission.CounterModel(
name='quest2',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.NOT_RESET,
),
],
options=mission.CounterModelOptions(
metadata = 'QUEST2'
),
),
],
)
print(SampleStack().yaml()) # Generate TemplateCounterModel
Counter Model
Counter Model is an entity that can be set as a condition for accomplishing mission tasks. Since counter values can be referenced by multiple mission groups, a single counter can be set as an accomplishment condition for multiple mission groups, such as weekly and daily missions.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| counterId | string | * | ~ 1024 chars | Counter Model GRN * Set automatically by the server | ||
| name | string | ✓ | ~ 128 chars | Counter Model name Counter Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| metadata | string | ~ 1024 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||
| scopes | List<CounterScopeModel> | [] | 1 ~ 20 items | List of Counter reset timing Defines the scopes (reset timings or verify action conditions) for this counter. A single counter can have multiple scopes, allowing one counter to track values across different periods (e.g., daily, weekly, and cumulative totals simultaneously). | ||
| challengePeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN
that sets the period during which the counter can be operated Specifies the GS2-Schedule event that defines the time window during which this counter can be incremented or decremented. If not set, the counter can be operated at any time. |
CounterScopeModel
Counter Reset Timing Model
Defines a scope for a counter, which determines how and when the counter value is reset. A scope can be either a reset timing (daily, weekly, monthly, fixed-day interval, or never) or a verify action condition. Each counter can have multiple scopes to track values across different periods.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| scopeType | String Enum enum { “resetTiming”, “verifyAction” } | “resetTiming” | Scope type Determines how the counter scope is defined. “resetTiming” uses a periodic reset schedule, while “verifyAction” uses a verify action to determine whether the counter value applies.
| |||||||||||||||||||
| resetType | String Enum enum { “notReset”, “daily”, “weekly”, “monthly”, “days” } | “notReset” | Reset timing Determines when the counter value for this scope is reset. Choose from: not reset (permanent cumulative), daily, weekly, monthly, or every fixed number of days. Only used when scopeType is “resetTiming”.
| |||||||||||||||||||
| resetDayOfMonth | int | {resetType} == “monthly” | ✓* | 1 ~ 31 | Date to reset The day of the month on which the counter value resets. If the specified value exceeds the number of days in the month, it is treated as the last day of that month. Only used when resetType is “monthly”. * Required if resetType is “monthly” | |||||||||||||||||
| resetDayOfWeek | String Enum enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {resetType} == “weekly” | ✓* | Day of the week to reset The day of the week on which the counter value resets. Only used when resetType is “weekly”.
* Required if resetType is “weekly” | ||||||||||||||||||
| resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ✓* | 0 ~ 23 | Hour of Reset The hour (0-23) at which the counter value resets. Used in combination with daily, weekly, or monthly reset types. * Required if resetType is “monthly”,“weekly”,“daily” | |||||||||||||||||
| conditionName | string | {scopeType} == “verifyAction” | ✓* | ~ 128 chars | Condition Name A unique name that identifies this verify action condition scope. Used to look up the corresponding scoped value in the counter. Only used when scopeType is “verifyAction”. * Required if scopeType is “verifyAction” | |||||||||||||||||
| condition | VerifyAction | {scopeType} == “verifyAction” | ✓* | Condition The verify action that determines whether the counter value for this scope is applicable. Only used when scopeType is “verifyAction”. * Required if scopeType is “verifyAction” | ||||||||||||||||||
| anchorTimestamp | long | {resetType} == “days” | ✓* | Base date and time for counting elapsed days Unix time, milliseconds * Required if resetType is “days” | ||||||||||||||||||
| days | int | {resetType} == “days” | ✓* | 1 ~ 2147483646 | Number of days to reset The interval in days between counter value resets, counting from the anchor timestamp. Only used when resetType is “days”. * Required if resetType is “days” |
MissionGroupModel
Mission Group Model
A mission group is an entity that groups tasks by counter reset timing. For example, one group for daily missions. One group for Weekly Mission.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| missionGroupId | string | * | ~ 1024 chars | Mission Group GRN * Set automatically by the server | ||||||||||||||||||
| name | string | ✓ | ~ 128 chars | Mission Group Model name Mission Group Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||||
| metadata | string | ~ 1024 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||||||||||||||||||
| tasks | List<MissionTaskModel> | [] | 0 ~ 1000 items | List of Mission Task The mission tasks belonging to this group. Each task defines a completion condition (counter threshold or verify actions) and the rewards granted upon accomplishment. | ||||||||||||||||||
| resetType | String Enum enum { “notReset”, “daily”, “weekly”, “monthly”, “days” } | “notReset” | Reset timing Determines when the mission group’s completion status is reset. Choose from: not reset (permanent), daily, weekly, monthly, or every fixed number of days from an anchor timestamp.
| |||||||||||||||||||
| resetDayOfMonth | int | {resetType} == “monthly” | ✓* | 1 ~ 31 | Date to reset The day of the month on which the mission group resets. If the specified value exceeds the number of days in the month, it is treated as the last day of that month. Only used when resetType is “monthly”. * Required if resetType is “monthly” | |||||||||||||||||
| resetDayOfWeek | String Enum enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {resetType} == “weekly” | ✓* | Day of the week to reset The day of the week on which the mission group resets. Only used when resetType is “weekly”.
* Required if resetType is “weekly” | ||||||||||||||||||
| resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ✓* | 0 ~ 23 | Hour of Reset The hour (0-23) at which the mission group resets. Used in combination with daily, weekly, or monthly reset types. * Required if resetType is “monthly”,“weekly”,“daily” | |||||||||||||||||
| completeNotificationNamespaceId | string | ~ 1024 chars | Push notifications when mission tasks are accomplished The GS2-Gateway namespace GRN used to deliver push notifications when a mission task in this group is accomplished. Allows the game client to be notified in real-time. | |||||||||||||||||||
| anchorTimestamp | long | {resetType} == “days” | ✓* | Base date and time for counting elapsed days Unix time, milliseconds * Required if resetType is “days” | ||||||||||||||||||
| days | int | {resetType} == “days” | ✓* | 1 ~ 2147483646 | Number of days to reset The interval in days between resets, counting from the anchor timestamp. Only used when resetType is “days”. * Required if resetType is “days” |
MissionTaskModel
Mission Task Model
A mission task is an entity that defines the conditions under which a reward will be given if the value of the associated counter exceeds a certain level.
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| missionTaskId | string | * | ~ 1024 chars | Mission Task GRN * Set automatically by the server | ||||||||
| name | string | ✓ | ~ 128 chars | Mission Task Model name Mission Task Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| metadata | string | ~ 1024 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||||||||
| verifyCompleteType | String Enum enum { “counter”, “verifyActions” } | “counter” | Completion condition type Specifies how mission task completion is determined. “counter” checks if the associated counter’s scoped value reaches the target threshold. “verifyActions” uses verify actions to check completion conditions.
| |||||||||
| targetCounter | TargetCounterModel | {verifyCompleteType} == “counter” | ✓* | Target Counter Defines the counter, scope, and target value used to determine mission task completion. When the counter’s scoped value reaches or exceeds the specified target value, the task is considered accomplished. * Required if verifyCompleteType is “counter” | ||||||||
| verifyCompleteConsumeActions | List<VerifyAction> | {verifyCompleteType} == “verifyActions” | [] | 0 ~ 10 items | Verify Actions when task is accomplished A list of verify actions used to determine if the mission task is completed. All verify actions must pass for the task to be considered accomplished. Only used when verifyCompleteType is “verifyActions”. * Applicable only if verifyCompleteType is “verifyActions” | |||||||
| completeAcquireActions | List<AcquireAction> | [] | 0 ~ 100 items | Rewards for mission accomplishment The list of acquire actions executed as rewards when the player receives the mission completion reward. | ||||||||
| challengePeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN
with a set period of time during which rewards can be received Specifies the GS2-Schedule event that defines the time window during which the mission task rewards can be claimed. If not set, rewards can be received at any time after accomplishment. | |||||||||
| premiseMissionTaskName | string | ~ 128 chars | Name of the task that must be accomplished to attempt this task Specifies a prerequisite mission task within the same group that must be completed before the player can receive the reward for this task. Used to create sequential mission chains. |
TargetCounterModel
Target Counter
Information about the counter that serves as the achievement goal for the mission
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| counterName | string | ✓ | ~ 128 chars | Counter Model name Counter Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||
| scopeType | String Enum enum { “resetTiming”, “verifyAction” } | “resetTiming” | Scope type Specifies which type of counter scope to use for the mission completion check. “resetTiming” evaluates the counter value for a specific reset period, while “verifyAction” evaluates the value for a named condition.
| |||||||||||||||
| resetType | String Enum enum { “notReset”, “daily”, “weekly”, “monthly”, “days” } | {scopeType} == “resetTiming” | Target Reset timing Specifies which reset timing scope of the counter to check against the target value. For example, selecting “daily” means the task checks the daily counter value. If omitted, the mission group’s reset timing is used.
* Applicable only if scopeType is “resetTiming” | |||||||||||||||
| conditionName | string | {scopeType} == “verifyAction” | ✓* | ~ 128 chars | Condition Name The name of the verify action condition scope to check against the target value. Must match a conditionName defined in the counter model’s scopes. Only used when scopeType is “verifyAction”. * Required if scopeType is “verifyAction” | |||||||||||||
| value | long | ✓ | 0 ~ 9223372036854775805 | Target value The threshold value that the counter’s scoped value must reach or exceed for the mission task to be considered accomplished. |
AcquireAction
Acquire Action
VerifyAction
Verify Action