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 | ✓ | ~ 128 chars | Namespace name | |
| description | string | ~ 1024 chars | Description | ||
| 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",
options=mission.NamespaceOptions(
transaction_setting=core.TransactionSetting(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
options=core.TransactionSettingOptions(
key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
)
),
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",
options: new \Gs2Cdk\Mission\Model\Options\NamespaceOptions(
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
enableAutoRun: True,
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
)
),
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.mission.model.options.NamespaceOptions() {
{
transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(){
{
queueNamespaceId = "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"
)
);
logSetting = new io.gs2.cdk.core.model.LogSetting(
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(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(
,
"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.Gs2Mission.Model.Options.NamespaceOptions {
transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions {
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
},
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
LoggingNamespaceId = "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.
Note
Please refer to Master Data Reference of GS2-Mission for the JSON file format.| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 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",
"resetType": "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
},
{
"name": "weekly",
"resetType": "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
},
{
"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"
}
]
}from gs2_cdk import Stack, core, mission
class SampleStack(Stack):
def __init__(self):
super().__init__()
mission.Namespace(
stack=self,
# omission
).master_data(
groups=[
mission.MissionGroupModel(
name='daily',
reset_type='daily',
options=mission.MissionGroupModelOptions(
metadata='DAILY',
tasks=[
mission.MissionTaskModel(
name='quest_x10',
metadata='QUEST_X10',
counter_name='quest_complete',
target_value=10,
complete_acquire_actions=[
mission.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request='{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 10}'
)
]
),
mission.MissionTaskModel(
name='quest_x20',
metadata='QUEST_X20',
counter_name='quest_complete',
premise_mission_task_name='quest_x10',
target_value=20,
complete_acquire_actions=[
mission.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request='{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 20}'
)
]
),
mission.MissionTaskModel(
name='gacha',
metadata='GACHA',
counter_name='lot_gacha',
target_value=1,
complete_acquire_actions=[
mission.AcquireAction(
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=[
mission.MissionTaskModel(
name='quest_x100',
metadata='QUEST_X100',
counter_name='quest_complete',
target_value=100,
complete_acquire_actions=[
mission.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request='{"experienceName": "basic", "userId": "#{userId}", "experienceModelName": "player", "propertyId": "player", "experienceValue": 40}'
)
]
),
mission.MissionTaskModel(
name='quest_x1000',
metadata='QUEST_X1000',
counter_name='quest_complete',
premise_mission_task_name='quest_x100',
target_value=1000,
complete_acquire_actions=[
mission.AcquireAction(
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=[
mission.MissionTaskModel(
name='quest_1-1',
metadata='QUEST_1-1',
counter_name='quest1',
target_value=1
),
mission.MissionTaskModel(
name='quest_1-2',
metadata='QUEST_1-2',
counter_name='quest1',
premise_mission_task_name='quest_1-1',
target_value=1
),
mission.MissionTaskModel(
name='quest_1-3',
metadata='QUEST_1-3',
counter_name='quest1',
premise_mission_task_name='quest_1-2',
target_value=1
),
mission.MissionTaskModel(
name='quest_1-4',
metadata='QUEST_1-4',
counter_name='quest1',
premise_mission_task_name='quest_1-3',
target_value=1
),
mission.MissionTaskModel(
name='quest_2-1',
metadata='QUEST_2-1',
counter_name='quest2',
premise_mission_task_name='quest_1-4',
target_value=1
),
],
),
),
],
counters=[
mission.CounterModel(
name='quest_complete',
scopes=[
mission.CounterScopeModel(
reset_type='daily',
reset_hour=5
),
mission.CounterScopeModel(
reset_type='weekly',
reset_day_of_week='monday',
reset_hour=5
),
],
options=mission.CounterModelOptions(
metadata='QUEST_COMPLETE',
),
),
mission.CounterModel(
name='lot_gacha',
scopes=[
mission.CounterScopeModel(
reset_type='daily',
reset_hour=5
),
],
options=mission.CounterModelOptions(
metadata='LOT_GACHA',
),
),
mission.CounterModel(
name='quest1',
scopes=[
mission.CounterScopeModel(
reset_type='notReset'
),
],
options=mission.CounterModelOptions(
metadata='QUEST1',
),
),
mission.CounterModel(
name='quest2',
scopes=[
mission.CounterScopeModel(
reset_type='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\MissionGroupModelResetType::DAILY,
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"DAILY",
tasks:[
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x10",
metadata: "QUEST_X10",
counterName: "quest_complete",
targetValue: 10,
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
)
]
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x20",
metadata: "QUEST_X20",
counterName: "quest_complete",
premiseMissionTaskName: "quest_x10",
targetValue: 20,
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
)
]
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "gacha",
metadata: "GACHA",
counterName: "lot_gacha",
targetValue: 1,
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
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\MissionGroupModelResetType::WEEKLY,
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"WEEKLY",
tasks:[
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x100",
metadata: "QUEST_X100",
counterName: "quest_complete",
targetValue: 100,
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 40}"
)
]
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x1000",
metadata: "QUEST_X1000",
counterName: "quest_complete",
premiseMissionTaskName: "quest_x100",
targetValue: 1000,
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
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\MissionGroupModelResetType::NOT_RESET,
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"STORY",
tasks:[
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-1",
metadata: "QUEST_1-1",
counterName: "quest1",
targetValue: 1
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-2",
metadata: "QUEST_1-2",
counterName: "quest1",
premiseMissionTaskName: "quest_1-1",
targetValue: 1
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-3",
metadata: "QUEST_1-3",
counterName: "quest1",
premiseMissionTaskName: "quest_1-2",
targetValue: 1
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-4",
metadata: "QUEST_1-4",
counterName: "quest1",
premiseMissionTaskName: "quest_1-3",
targetValue: 1
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
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:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
resetType: "daily",
resetHour: 5
),
new \Gs2Cdk\Mission\Model\CounterScopeModel(
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:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
resetType: "daily",
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(
resetType: "notReset"
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST1"
)
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest2",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
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(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x10",
"QUEST_X10",
"quest_complete",
10L,
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
)
)
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x20",
"QUEST_X20",
"quest_complete",
"quest_x10",
20L,
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
)
)
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"gacha",
"GACHA",
"lot_gacha",
1L,
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"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(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x100",
"QUEST_X100",
"quest_complete",
100L,
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 40}"
)
)
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x1000",
"QUEST_X1000",
"quest_complete",
"quest_x100",
1000L,
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"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(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-1",
"QUEST_1-1",
"quest1",
1L
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-2",
"QUEST_1-2",
"quest1",
"quest_1-1",
1L
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-3",
"QUEST_1-3",
"quest1",
"quest_1-2",
1L
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-4",
"QUEST_1-4",
"quest1",
"quest_1-3",
1L
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_2-1",
"QUEST_2-1",
"quest2",
"quest_1-4",
1L
)
);
}
}
)
),
Arrays.asList(
new io.gs2.cdk.mission.model.CounterModel(
"quest_complete",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
"daily",
5
),
new io.gs2.cdk.mission.model.CounterScopeModel(
"weekly",
"monday",
5
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions() {
{
metadata: "QUEST_COMPLETE";
}
}
),
new io.gs2.cdk.mission.model.CounterModel(
"lot_gacha",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
"daily",
5
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions() {
{
metadata: "LOT_GACHA";
}
}
),
new io.gs2.cdk.mission.model.CounterModel(
"quest1",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
"notReset"
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions() {
{
metadata: "QUEST1";
}
}
),
new io.gs2.cdk.mission.model.CounterModel(
"quest2",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
"notReset"
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions() {
{
metadata: "QUEST2";
}
}
)
)
);
}
}
System.out.println(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,
// omission
).masterData(
[
new mission.model.MissionGroupModel(
"daily",
mission.model.MissionGroupModelResetType.DAILY,
{
metadata: "DAILY",
tasks: [
new mission.model.MissionTaskModel(
"quest_x10",
"QUEST_X10",
"quest_complete",
10,
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
)
]
),
new mission.model.MissionTaskModel(
"quest_x20",
"QUEST_X20",
"quest_complete",
"quest_x10",
20,
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
)
]
),
new mission.model.MissionTaskModel(
"gacha",
"GACHA",
"lot_gacha",
1,
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 30}"
)
]
),
],
resetHour: 10
}
),
new mission.model.MissionGroupModel(
"weekly",
mission.model.MissionGroupModelResetType.WEEKLY,
{
metadata: "WEEKLY",
tasks: [
new mission.model.MissionTaskModel(
"quest_x100",
"QUEST_X100",
"quest_complete",
100,
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 40}"
)
]
),
new mission.model.MissionTaskModel(
"quest_x1000",
"QUEST_X1000",
"quest_complete",
"quest_x100",
1000,
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 50}"
)
]
),
],
resetDayOfWeek: "monday",
resetHour: 10
}
),
new mission.model.MissionGroupModel(
"story",
mission.model.MissionGroupModelResetType.NOT_RESET,
{
metadata: "STORY",
tasks: [
new mission.model.MissionTaskModel(
"quest_1-1",
"QUEST_1-1",
"quest1",
1
),
new mission.model.MissionTaskModel(
"quest_1-2",
"QUEST_1-2",
"quest1",
"quest_1-1",
1
),
new mission.model.MissionTaskModel(
"quest_1-3",
"QUEST_1-3",
"quest1",
"quest_1-2",
1
),
new mission.model.MissionTaskModel(
"quest_1-4",
"QUEST_1-4",
"quest1",
"quest_1-3",
1
),
new mission.model.MissionTaskModel(
"quest_2-1",
"QUEST_2-1",
"quest2",
"quest_1-4",
1
),
]
}
)
],
[
new mission.model.CounterModel(
"quest_complete",
[
new mission.model.CounterScopeModel(
"daily",
5
),
new mission.model.CounterScopeModel(
"weekly",
"monday",
5
),
],
{
metadata: "QUEST_COMPLETE"
}
),
new mission.model.CounterModel(
"lot_gacha",
[
new mission.model.CounterScopeModel(
"daily",
5
),
],
{
metadata: "LOT_GACHA"
}
),
new mission.model.CounterModel(
"quest1",
[
new mission.model.CounterScopeModel(
"notReset"
),
],
{
metadata: "QUEST1"
}
),
new mission.model.CounterModel(
"quest2",
[
new mission.model.CounterScopeModel(
"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.MissionGroupModelResetType.Daily,
new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
metadata = "DAILY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x10",
metadata: "QUEST_X10",
counterName: "quest_complete",
targetValue: 10L,
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
)
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x20",
metadata: "QUEST_X20",
counterName: "quest_complete",
premiseMissionTaskName: "quest_x10",
targetValue: 20L,
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
)
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "gacha",
metadata: "GACHA",
counterName: "lot_gacha",
targetValue: 1L,
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
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.MissionGroupModelResetType.Weekly,
new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
metadata = "WEEKLY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x100",
metadata: "QUEST_X100",
counterName: "quest_complete",
targetValue: 100L,
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"experienceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceModelName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 40}"
)
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x1000",
metadata: "QUEST_X1000",
counterName: "quest_complete",
premiseMissionTaskName: "quest_x100",
targetValue: 1000L,
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
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.MissionGroupModelResetType.NotReset,
new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions {
metadata = "STORY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[] {
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-1",
metadata: "QUEST_1-1",
counterName: "quest1",
targetValue: 1L
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-2",
metadata: "QUEST_1-2",
counterName: "quest1",
premiseMissionTaskName: "quest_1-1",
targetValue: 1L
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-3",
metadata: "QUEST_1-3",
counterName: "quest1",
premiseMissionTaskName: "quest_1-2",
targetValue: 1L
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-4",
metadata: "QUEST_1-4",
counterName: "quest1",
premiseMissionTaskName: "quest_1-3",
targetValue: 1L
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_2-1",
metadata: "QUEST_2-1",
counterName: "quest2",
premiseMissionTaskName: "quest_1-4",
targetValue: 1L
),
}
}
)
},
new [] {
new Gs2Cdk.Gs2Mission.Model.CounterModel(
"quest_complete",
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[] {
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
resetType: "daily",
resetHour: 5
),
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
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[] {
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[] {
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[] {
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
resetType: "notReset"
),
},
new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions {
metadata = "QUEST2"
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateNotificationSetting
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 send additional processing to mobile push notifications when the destination device is offline. If you use mobile push notifications well, you may be able to realize a flow in which you can notify the player by using mobile push notifications even if you end the game during matchmaking and return to the game.
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| gatewayNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:gateway:default” | ~ 1024 chars | GS2-Gateway namespace to use for push notifications |
| enableTransferMobileNotification | bool? | false | Forwarding to mobile push notification | ||
| sound | string | {enableTransferMobileNotification} == true | ~ 1024 chars | Sound file name to be used for mobile push notifications |
CounterScopeModel
Counter Reset Timing Model
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| scopeType | enum { “resetTiming”, “verifyAction” } | ✓ | “resetTiming” | ~ 128 chars | Scope type |
| resetType | enum { “notReset”, “daily”, “weekly”, “monthly” } | {scopeType} == “resetTiming” | ~ 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 | |
| conditionName | string | {scopeType} == “verifyAction” | ~ 128 chars | Condition Name | |
| condition | VerifyAction | {scopeType} == “verifyAction” | Condition |
Enumeration type definition to specify as scopeType
| Enumerator String Definition | Description |
|---|---|
| resetTiming | Reset timing |
| verifyAction | Verify action |
Enumeration type definition to specify as resetType
| Enumerator String Definition | Description |
|---|---|
| notReset | Not resetting. |
| daily | Daily |
| weekly | Weekly |
| monthly | Monthly |
Enumeration type definition to specify as resetDayOfWeek
| Enumerator String Definition | Description |
|---|---|
| sunday | Sunday |
| monday | Monday |
| tuesday | Tuesday |
| wednesday | Wednesday |
| thursday | Thuesday |
| friday | Friday |
| saturday | Saturday |
ScopedValue
Reset timing
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| scopeType | enum { “resetTiming”, “verifyAction” } | ✓ | “resetTiming” | ~ 128 chars | Scope type |
| resetType | enum { “notReset”, “daily”, “weekly”, “monthly” } | {scopeType} == “resetTiming” | ~ 128 chars | Reset timing | |
| conditionName | string | {scopeType} == “verifyAction” | ~ 128 chars | Condition Name | |
| value | long | ✓ | 0 | ~ 9223372036854775805 | Count value |
| nextResetAt | long | Next reset timing (Unix time unit:milliseconds) | |||
| updatedAt | long | ✓ | Now | Datetime of last update (Unix time unit:milliseconds) |
Enumeration type definition to specify as scopeType
| Enumerator String Definition | Description |
|---|---|
| resetTiming | Reset timing |
| verifyAction | Verify action |
Enumeration type definition to specify as resetType
| Enumerator String Definition | Description |
|---|---|
| notReset | Not resetting. |
| daily | Daily |
| weekly | Weekly |
| monthly | Monthly |
TargetCounterModel
Target Counter
Information about the counter that serves as the achievement goal for the mission
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| counterName | string | ✓ | ~ 128 chars | Counter Name | |
| scopeType | enum { “resetTiming”, “verifyAction” } | ✓ | “resetTiming” | ~ 128 chars | Scope type |
| resetType | enum { “notReset”, “daily”, “weekly”, “monthly” } | {scopeType} == “resetTiming” | ~ 128 chars | Target Reset timing | |
| conditionName | string | {scopeType} == “verifyAction” | ~ 128 chars | Condition Name | |
| value | long | ✓ | 1 ~ 9223372036854775805 | Target value |
Enumeration type definition to specify as scopeType
| Enumerator String Definition | Description |
|---|---|
| resetTiming | Reset timing |
| verifyAction | Verify action |
Enumeration type definition to specify as resetType
| Enumerator String Definition | Description |
|---|---|
| notReset | Not resetting. |
| daily | Daily |
| weekly | Weekly |
| monthly | Monthly |
AcquireAction
Acquire Action
ConsumeAction
Consume Action
VerifyAction
Verify Action
Config
Configration
Set values to be applied to transaction variables
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| key | string | ✓ | ~ 64 chars | Name | |
| value | string | ~ 51200 chars | Value |
LogSetting
Log setting
This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024 chars | Namespace GRN |
GitHubCheckoutSetting
Setup to check out master data from GitHub
| 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 |
Enumeration type definition to specify as referenceType
| Enumerator String Definition | Description |
|---|---|
| commit_hash | Commit hash |
| branch | Branch |
| tag | Tag |
ScriptSetting
Script settings
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 execution result to stop the execution of the API or to tamper with the result of the API.
On the other hand, asynchronous execution does not block processing until the script has finished executing. Instead, you can use the script execution result to stop the execution of the API or to tamper with the result of the API. However, asynchronous execution does not block processing until the script has finished executing, so it is generally recommended to use asynchronous execution.
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 | 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 |
Enumeration type definition to specify as doneTriggerTargetType
| Enumerator String Definition | Description |
|---|---|
| none | None |
| gs2_script | GS2-Script |
| aws | Amazon EventBridge |
TransactionSetting
Transaction settings
| Type | Require | Default | Limitation | Description | |
|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | Automatically run issued transactions on the server side, or | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor namespace used for transaction execution |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | Namespace in GS2-JobQueue used to run the transaction |