GS2-Deploy/CDK Reference of GS2-Mission
Entities
Namespace
Namespace
Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.
Therefore, it is necessary to create a namespace before starting to use each service.
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 32 chars | Namespace name | |
| description | string | ~ 1024 chars | description of Namespace | ||
| transactionSetting | TransactionSetting | ✓ | Transaction settings | ||
| missionCompleteScript | ScriptSetting | Script to run when a mission is accomplished | |||
| counterIncrementScript | ScriptSetting | Script to run when the counter rises | |||
| receiveRewardsScript | ScriptSetting | Script to run when a reward is received | |||
| completeNotification | NotificationSetting | Push notifications when mission tasks are accomplished | |||
| logSetting | LogSetting | Log output settings |
GetAttr
| Type | Description | |
|---|---|---|
| Item | Namespace | Created namespace |
Implementation Example
Type: GS2::Mission::Namespace
Properties:
Name: namespace1
Description: null
TransactionSetting:
EnableAutoRun: false
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
MissionCompleteScript: null
CounterIncrementScript: null
ReceiveRewardsScript: null
CompleteNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1from gs2_cdk import Stack, core, mission
class SampleStack(Stack):
def __init__(self):
super().__init__()
mission.Namespace(
stack=self,
name="namespace-0001",
transaction_setting=core.TransactionSetting(
enable_auto_run=False,
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
options=core.TransactionSettingOptions(
distributor_namespace_id=,
key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
)
),
options=mission.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Mission\Model\Namespace_(
stack: $this,
name: "namespace-0001",
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
enableAutoRun: False,
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
distributorNamespaceId: ,
keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
)
),
options: new \Gs2Cdk\Mission\Model\Options\NamespaceOptions(
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
),
),
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class 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.core.model.TransactionSetting(
false,
"grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
new io.gs2.cdk.core.model.options.TransactionSettingOptions(
,
"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
)
),
new io.gs2.cdk.mission.model.options.NamespaceOptions() {
{
logSetting = new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";
class SampleStack extends core.Stack
{
public constructor() {
super();
new mission.model.Namespace(
this,
"namespace-0001",
new core.TransactionSetting(
false,
"grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
{
,
"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
}
),
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Mission.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Core.Model.TransactionSetting(
false,
"grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
DistributorNamespaceId = ,
KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
}
),
new Gs2Cdk.Gs2Mission.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateCurrentMissionMaster
Currently available master data
GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.
We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.
Please refer to the documentation for the format of the JSON file.
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32 chars | Namespace name | |
| settings | string | ✓ | ~ 5242880 chars | Master data |
GetAttr
| Type | Description | |
|---|---|---|
| Item | CurrentMissionMaster | Updated and currently available Mission Master |
Implementation Example
Type: GS2::Mission::CurrentMissionMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-05-28",
"groups": [
{
"name": "daily",
"metadata": "DAILY",
"tasks": [
{
"name": "quest_x10",
"metadata": "QUEST_X10",
"counterName": "quest_complete",
"targetValue": 10,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 10}"
}
]
},
{
"name": "quest_x20",
"metadata": "QUEST_X20",
"counterName": "quest_complete",
"premiseMissionTaskName": "quest_x10",
"targetValue": 20,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 20}"
}
]
},
{
"name": "gacha",
"metadata": "GACHA",
"counterName": "lot_gacha",
"targetValue": 1,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 30}"
}
]
}
],
"resetType": "daily",
"resetHour": 10
},
{
"name": "weekly",
"metadata": "WEEKLY",
"tasks": [
{
"name": "quest_x100",
"metadata": "QUEST_X100",
"counterName": "quest_complete",
"targetValue": 100,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 40}"
}
]
},
{
"name": "quest_x1000",
"metadata": "QUEST_X1000",
"counterName": "quest_complete",
"premiseMissionTaskName": "quest_x100",
"targetValue": 1000,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\\"experienceName\\": \\"basic\\", \\"userId\\": \\"#{userId}\\", \\"experienceModelName\\": \\"player\\", \\"propertyId\\": \\"player\\", \\"experienceValue\\": 50}"
}
]
}
],
"resetType": "weekly",
"resetDayOfWeek": "monday",
"resetHour": 10
},
{
"name": "story",
"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
}
],
"resetType": "notReset"
}
],
"counters": [
{
"name": "quest_complete",
"metadata": "QUEST_COMPLETE",
"scopes": [
{
"resetType": "daily",
"resetHour": 5
},
{
"resetType": "weekly",
"resetDayOfWeek": "monday",
"resetHour": 5
}
]
},
{
"name": "lot_gacha",
"metadata": "LOT_GACHA",
"scopes": [
{
"resetType": "daily",
"resetHour": 5
}
]
},
{
"name": "quest1",
"metadata": "QUEST1",
"scopes": [
{
"resetType": "notReset"
}
]
},
{
"name": "quest2",
"metadata": "QUEST2",
"scopes": [
{
"resetType": "notReset"
}
]
}
]
}from gs2_cdk import Stack, core, mission
class SampleStack(Stack):
def __init__(self):
super().__init__()
mission.Namespace(
stack=self,
# omission
).master_data(
[
mission.MissionGroupModel(
name='daily',
reset_type='daily',
options=mission.MissionGroupModelOptions(
metadata='DAILY',
tasks=[ {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
{'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
{'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]},
],
reset_hour=10,
),
),
mission.MissionGroupModel(
name='weekly',
reset_type='weekly',
options=mission.MissionGroupModelOptions(
metadata='WEEKLY',
tasks=[ {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
{'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]},
],
reset_day_of_week='monday',
reset_hour=10,
),
),
mission.MissionGroupModel(
name='story',
reset_type='notReset',
options=mission.MissionGroupModelOptions(
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},
],
),
),
],
[
mission.CounterModel(
name='quest_complete',
scopes=[ {'resetType': 'daily', 'resetHour': 5},
{'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5},
],
options=mission.CounterModelOptions(
metadata='QUEST_COMPLETE',
),
),
mission.CounterModel(
name='lot_gacha',
scopes=[ {'resetType': 'daily', 'resetHour': 5},
],
options=mission.CounterModelOptions(
metadata='LOT_GACHA',
),
),
mission.CounterModel(
name='quest1',
scopes=[ {'resetType': 'notReset'},
],
options=mission.CounterModelOptions(
metadata='QUEST1',
),
),
mission.CounterModel(
name='quest2',
scopes=[ {'resetType': 'notReset'},
],
options=mission.CounterModelOptions(
metadata='QUEST2',
),
),
],
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Mission\Model\Namespace_(
stack: $this,
// omission
))->masterData(
[
new \Gs2Cdk\Mission\Model\MissionGroupModel(
name:"daily",
resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::DAILY
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"DAILY",
tasks:[ {'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
{'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
{'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]},
],
resetHour:10,
),
),
new \Gs2Cdk\Mission\Model\MissionGroupModel(
name:"weekly",
resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::WEEKLY
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"WEEKLY",
tasks:[ {'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
{'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]},
],
resetDayOfWeek:"monday",
resetHour:10,
),
),
new \Gs2Cdk\Mission\Model\MissionGroupModel(
name:"story",
resetType: \Gs2Cdk\Mission\Model\Enums\CurrentMissionMasterResetType::NOT_RESET
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
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},
],
),
),
],
[
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest_complete",
scopes:[ {'resetType': 'daily', 'resetHour': 5},
{'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5},
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST_COMPLETE",
),
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"lot_gacha",
scopes:[ {'resetType': 'daily', 'resetHour': 5},
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"LOT_GACHA",
),
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest1",
scopes:[ {'resetType': 'notReset'},
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST1",
),
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest2",
scopes:[ {'resetType': 'notReset'},
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST2",
),
),
],
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.mission.model.Namespace(
this,
// omission
).masterData(
Arrays.asList(
new io.gs2.cdk.mission.model.MissionGroupModel(
"daily",
Daily,
new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
{
metadata: "DAILY";
tasks: Arrays.asList(
{'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
{'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
{'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
);
resetHour: 10;
}
}
),
new io.gs2.cdk.mission.model.MissionGroupModel(
"weekly",
Weekly,
new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
{
metadata: "WEEKLY";
tasks: Arrays.asList(
{'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
{'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
);
resetDayOfWeek: "monday";
resetHour: 10;
}
}
),
new io.gs2.cdk.mission.model.MissionGroupModel(
"story",
NotReset,
new io.gs2.cdk.mission.model.options.MissionGroupModelOptions() {
{
metadata: "STORY";
tasks: Arrays.asList(
{'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}
);
}
}
)
),
Arrays.asList(
new io.gs2.cdk.mission.model.CounterModel(
"quest_complete",
Arrays.asList(
{'resetType': 'daily', 'resetHour': 5},
{'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
),
new io.gs2.cdk.mission.model.options.CounterModelOptions() {
{
metadata: "QUEST_COMPLETE";
}
}
),
new io.gs2.cdk.mission.model.CounterModel(
"lot_gacha",
Arrays.asList(
{'resetType': 'daily', 'resetHour': 5}
),
new io.gs2.cdk.mission.model.options.CounterModelOptions() {
{
metadata: "LOT_GACHA";
}
}
),
new io.gs2.cdk.mission.model.CounterModel(
"quest1",
Arrays.asList(
{'resetType': 'notReset'}
),
new io.gs2.cdk.mission.model.options.CounterModelOptions() {
{
metadata: "QUEST1";
}
}
),
new io.gs2.cdk.mission.model.CounterModel(
"quest2",
Arrays.asList(
{'resetType': 'notReset'}
),
new io.gs2.cdk.mission.model.options.CounterModelOptions() {
{
metadata: "QUEST2";
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";
class SampleStack extends core.Stack
{
public constructor() {
super();
new mission.model.Namespace(
this,
// omission
).masterData(
[
new mission.model.MissionGroupModel(
"daily",
mission.model.CurrentMissionMasterResetType.DAILY,
{
metadata: "DAILY",
tasks: [
{'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
{'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
{'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
],
resetHour: 10
}
),
new mission.model.MissionGroupModel(
"weekly",
mission.model.CurrentMissionMasterResetType.WEEKLY,
{
metadata: "WEEKLY",
tasks: [
{'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
{'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
],
resetDayOfWeek: "monday",
resetHour: 10
}
),
new mission.model.MissionGroupModel(
"story",
mission.model.CurrentMissionMasterResetType.NOT_RESET,
{
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}
]
}
)
],
[
new mission.model.CounterModel(
"quest_complete",
[
{'resetType': 'daily', 'resetHour': 5},
{'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
],
{
metadata: "QUEST_COMPLETE"
}
),
new mission.model.CounterModel(
"lot_gacha",
[
{'resetType': 'daily', 'resetHour': 5}
],
{
metadata: "LOT_GACHA"
}
),
new mission.model.CounterModel(
"quest1",
[
{'resetType': 'notReset'}
],
{
metadata: "QUEST1"
}
),
new mission.model.CounterModel(
"quest2",
[
{'resetType': 'notReset'}
],
{
metadata: "QUEST2"
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Mission.Model.Namespace(
this,
// omission
).MasterData(
new [] {
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
"daily",
Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.Daily,
new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
metadata = "DAILY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
{'name': 'quest_x10', 'metadata': 'QUEST_X10', 'counterName': 'quest_complete', 'targetValue': 10, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'}]},
{'name': 'quest_x20', 'metadata': 'QUEST_X20', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x10', 'targetValue': 20, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'}]},
{'name': 'gacha', 'metadata': 'GACHA', 'counterName': 'lot_gacha', 'targetValue': 1, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 30}'}]}
},
resetHour = 10,
}
),
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
"weekly",
Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.Weekly,
new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
metadata = "WEEKLY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
{'name': 'quest_x100', 'metadata': 'QUEST_X100', 'counterName': 'quest_complete', 'targetValue': 100, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'}]},
{'name': 'quest_x1000', 'metadata': 'QUEST_X1000', 'counterName': 'quest_complete', 'premiseMissionTaskName': 'quest_x100', 'targetValue': 1000, 'completeAcquireActions': [{'action': 'Gs2Experience:AddExperienceByUserId', 'request': '{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 50}'}]}
},
resetDayOfWeek = "monday",
resetHour = 10,
}
),
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
"story",
Gs2Cdk.Gs2Mission.Model.Enums.CurrentMissionMasterResetType.NotReset,
new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
metadata = "STORY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
{'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}
},
}
)
},
new [] {
new Gs2Cdk.Gs2Mission.Model.CounterModel(
"quest_complete",
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
{'resetType': 'daily', 'resetHour': 5},
{'resetType': 'weekly', 'resetDayOfWeek': 'monday', 'resetHour': 5}
},
new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
metadata = "QUEST_COMPLETE",
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
"lot_gacha",
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
{'resetType': 'daily', 'resetHour': 5}
},
new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
metadata = "LOT_GACHA",
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
"quest1",
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
{'resetType': 'notReset'}
},
new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
metadata = "QUEST1",
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
"quest2",
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
{'resetType': 'notReset'}
},
new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
metadata = "QUEST2",
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateNotificationSetting
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| gatewayNamespaceId | string | ✓ | ~ 1024 chars | Namespace GRN | |
| enableTransferMobileNotification | bool? | Forwarding to mobile push notification | |||
| sound | string | ~ 1024 chars | Sound file name to be used for mobile push notifications |
CounterScopeModel
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| resetType | enum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’] | ✓ | ~ 128 chars | Reset timing | |
| resetDayOfMonth | int | {resetType} == “monthly” | 1 ~ 31 | Date to reset (If the value exceeds the days of the month, it is treated as the last day.) | |
| resetDayOfWeek | enum [‘sunday’, ‘monday’, ’tuesday’, ‘wednesday’, ’thursday’, ‘friday’, ‘saturday’] | {resetType} == “weekly” | ~ 128 chars | Day of the week to reset | |
| resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ~ 23 | Hour of Reset |
ScopedValue
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| resetType | enum [’notReset’, ‘daily’, ‘weekly’, ‘monthly’] | ✓ | ~ 128 chars | Reset timing | |
| value | long | ✓ | 0 | ~ 9223372036854775805 | Count value |
| nextResetAt | long | Next reset timing | |||
| updatedAt | long | ✓ | Datetime of last update |
AcquireAction
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| action | enum [] | ✓ | ~ 128 chars | Types of actions to be performed in the stamp sheet | |
| request | string | ✓ | ~ 1048576 chars | JSON of request |
Config
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| key | string | ✓ | ~ 64 chars | Name | |
| value | string | ~ 51200 chars | Value |
LogSetting
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | Namespace GRN |
GitHubCheckoutSetting
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| apiKeyId | string | ✓ | ~ 1024 chars | GitHub API key GRN | |
| repositoryName | string | ✓ | ~ 1024 chars | Repository Name | |
| sourcePath | string | ✓ | ~ 1024 chars | Source code file path | |
| referenceType | enum [‘commit_hash’, ‘branch’, ’tag’] | ✓ | ~ 128 chars | Source of code | |
| commitHash | string | {referenceType} == “commit_hash” | ~ 1024 chars | Commit hash | |
| branchName | string | {referenceType} == “branch” | ~ 1024 chars | Branch Name | |
| tagName | string | {referenceType} == “tag” | ~ 1024 chars | Tag Name |
ScriptSetting
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024 chars | Script GRN | ||
| doneTriggerTargetType | enum [’none’, ‘gs2_script’, ‘aws’] | ✓ | “none” | ~ 128 chars | Notification of Completion |
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Script GRN | |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | Namespace GRN |
TransactionSetting
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | Automatically run issued stamp sheets on the server side, or | |
| distributorNamespaceId | string | {enableAutoRun} | ~ 1024 chars | GS2-Distributor namespace used for stamp sheet execution | |
| keyId | string | !{enableAutoRun} | ~ 1024 chars | GS2-Key encryption key used to sign the stamp sheet | |
| queueNamespaceId | string | ✓ | ~ 1024 chars | Namespace in GS2-JobQueue used to run the stamp sheet |