GS2-Mission GS2-Deploy/CDK リファレンス
GS2-Deployのスタックの作成に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| transactionSetting | TransactionSetting | ✓ | トランザクション設定 | ||
| missionCompleteScript | ScriptSetting | ミッションを達成したときに実行するスクリプト | |||
| counterIncrementScript | ScriptSetting | カウンターを上昇したときに実行するスクリプト | |||
| receiveRewardsScript | ScriptSetting | 報酬を受け取ったときに実行するスクリプト | |||
| completeNotification | NotificationSetting | ✓ | ミッションのタスクを達成したときのプッシュ通知 | ||
| logSetting | LogSetting | ログの出力設定 |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Mission::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting:
EnableAutoRun: true
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-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"
import "github.com/gs2io/gs2-golang-cdk/mission"
import "github.com/openlyinc/pointy"
SampleStack := core.NewStack()
mission.NewNamespace(
&SampleStack,
"namespace-0001",
mission.NamespaceOptions{
TransactionSetting: core.TransactionSetting{
EnableAutoRun: true,
QueueNamespaceId: "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 Template
class 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"
),
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()
.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(
null,
"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 Template
from 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',
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate TemplateCurrentMissionMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
Note
JSONファイルの形式については GS2-Mission マスターデータリファレンス をご参照ください。| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | CurrentMissionMaster | 更新した現在有効なミッションマスター |
実装例
Type: GS2::Mission::CurrentMissionMaster
Properties:
NamespaceName: namespace-0001
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
}
}
]
},
{
"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
}
}
]
},
{
"name": "gacha",
"metadata": "GACHA",
"counterName": "lot_gacha",
"targetValue": 1,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "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": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30
}
}
]
},
{
"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
}
}
]
}
],
"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"
}
]
}import "github.com/gs2io/gs2-golang-cdk/core"
import "github.com/gs2io/gs2-golang-cdk/mission"
import "github.com/openlyinc/pointy"
SampleStack := core.NewStack()
mission.NewNamespace(
&SampleStack,
"namespace-0001",
mission.NamespaceOptions{},
).MasterData(
[]mission.MissionGroupModel{
mission.NewMissionGroupModel(
"daily",
"daily",
mission.MissionGroupModelOptions{
Metadata: pointy.String("DAILY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_x10",
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X10"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
pointy.String("namespace-0001"),
pointy.String("player"),
pointy.String("player"),
30,
),
},
},
),
mission.NewMissionTaskModel(
"quest_x20",
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X20"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
pointy.String("namespace-0001"),
pointy.String("player"),
pointy.String("player"),
30,
),
},
PremiseMissionTaskName: pointy.String("quest_x10"),
},
),
mission.NewMissionTaskModel(
"gacha",
mission.MissionTaskModelOptions{
Metadata: pointy.String("GACHA"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
pointy.String("namespace-0001"),
pointy.String("player"),
pointy.String("player"),
30,
),
},
},
),
},
ResetHour: pointy.Int32(10),
},
),
mission.NewMissionGroupModel(
"weekly",
"weekly",
mission.MissionGroupModelOptions{
Metadata: pointy.String("WEEKLY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_x100",
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X100"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
pointy.String("namespace-0001"),
pointy.String("player"),
pointy.String("player"),
30,
),
},
},
),
mission.NewMissionTaskModel(
"quest_x1000",
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X1000"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
pointy.String("namespace-0001"),
pointy.String("player"),
pointy.String("player"),
30,
),
},
PremiseMissionTaskName: pointy.String("quest_x100"),
},
),
},
ResetDayOfWeek: pointy.String("monday"),
ResetHour: pointy.Int32(10),
},
),
mission.NewMissionGroupModel(
"story",
"notReset",
mission.MissionGroupModelOptions{
Metadata: pointy.String("STORY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_1-1",
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-1"),
},
),
mission.NewMissionTaskModel(
"quest_1-2",
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-2"),
PremiseMissionTaskName: pointy.String("quest_1-1"),
},
),
mission.NewMissionTaskModel(
"quest_1-3",
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-3"),
PremiseMissionTaskName: pointy.String("quest_1-2"),
},
),
mission.NewMissionTaskModel(
"quest_1-4",
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-4"),
PremiseMissionTaskName: pointy.String("quest_1-3"),
},
),
mission.NewMissionTaskModel(
"quest_2-1",
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.CounterScopeModelOptions{
ResetType: pointy.String("daily"),
ResetHour: pointy.Int32(5),
},
),
mission.NewCounterScopeModel(
mission.CounterScopeModelOptions{
ResetType: pointy.String("weekly"),
ResetDayOfWeek: pointy.String("monday"),
ResetHour: pointy.Int32(5),
},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST_COMPLETE"),
},
),
mission.NewCounterModel(
"lot_gacha",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelOptions{
ResetType: pointy.String("daily"),
ResetHour: pointy.Int32(5),
},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("LOT_GACHA"),
},
),
mission.NewCounterModel(
"quest1",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelOptions{
ResetType: pointy.String("notReset"),
},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST1"),
},
),
mission.NewCounterModel(
"quest2",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelOptions{
ResetType: pointy.String("notReset"),
},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST2"),
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
class 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
),
],
)
),
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
),
],
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
),
],
)
),
],
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
),
],
)
),
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
),
],
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,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::DAILY,
resetHour: 5,
)
),
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::WEEKLY,
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,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::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(
scopeType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
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,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetType: Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::NOT_RESET,
)
),
],
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,
"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")
),
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")
),
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")
)
),
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,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetType(io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.DAILY)
.withResetHour(5)
),
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetType(io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.WEEKLY)
.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,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetType(io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.DAILY)
.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,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetType(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,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetType(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
)
}
}
),
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
)
},
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
)
}
}
)
},
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
)
}
}
),
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
)
},
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,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetType = Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Daily,
resetHour = 5
}
),
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetType = Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Weekly,
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,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetType = Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Daily,
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,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
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,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
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";
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
),
]
}
),
new mission.model.MissionTaskModel(
"quest_x20",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X20",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30
),
],
premiseMissionTaskName: "quest_x10"
}
),
new mission.model.MissionTaskModel(
"gacha",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "GACHA",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30
),
]
}
),
],
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
),
]
}
),
new mission.model.MissionTaskModel(
"quest_x1000",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X1000",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30
),
],
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,
{
resetType: mission.model.CounterScopeModelResetType.DAILY,
resetHour: 5
}
),
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
{
resetType: 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,
{
resetType: mission.model.CounterScopeModelResetType.DAILY,
resetHour: 5
}
),
],
{
metadata: "LOT_GACHA"
}
),
new mission.model.CounterModel(
"quest1",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
{
resetType: mission.model.CounterScopeModelResetType.NOT_RESET
}
),
],
{
metadata: "QUEST1"
}
),
new mission.model.CounterModel(
"quest2",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
{
resetType: mission.model.CounterScopeModelResetType.NOT_RESET
}
),
],
{
metadata: "QUEST2"
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, mission
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
),
],
),
),
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
),
],
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
),
],
),
),
],
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
),
],
),
),
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
),
],
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,
options=mission.CounterScopeModelOptions(
reset_type=mission.CounterScopeModelResetType.DAILY,
reset_hour=5,
),
),
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
options=mission.CounterScopeModelOptions(
reset_type=mission.CounterScopeModelResetType.WEEKLY,
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,
options=mission.CounterScopeModelOptions(
reset_type=mission.CounterScopeModelResetType.DAILY,
reset_hour=5,
),
),
],
options=mission.CounterModelOptions(
metadata = 'LOT_GACHA'
),
),
mission.CounterModel(
name='quest1',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
options=mission.CounterScopeModelOptions(
reset_type=mission.CounterScopeModelResetType.NOT_RESET,
),
),
],
options=mission.CounterModelOptions(
metadata = 'QUEST1'
),
),
mission.CounterModel(
name='quest2',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
options=mission.CounterScopeModelOptions(
reset_type=mission.CounterScopeModelResetType.NOT_RESET,
),
),
],
options=mission.CounterModelOptions(
metadata = 'QUEST2'
),
),
],
)
print(SampleStack().yaml()) # Generate TemplateNotificationSetting
プッシュ通知に関する設定
GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。
ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。
たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。
GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。
モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| gatewayNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:gateway:default” | ~ 1024文字 | プッシュ通知に使用する GS2-Gateway のネームスペース |
| enableTransferMobileNotification | bool? | false | モバイルプッシュ通知へ転送するか | ||
| sound | string | {enableTransferMobileNotification} == true | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名 |
CounterScopeModel
カウンターリセットタイミングモデル
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| scopeType | enum { “resetTiming”, “verifyAction” } | ✓ | “resetTiming” | ~ 128文字 | スコープの種類 |
| resetType | enum { “notReset”, “daily”, “weekly”, “monthly”, “days” } | {scopeType} == “resetTiming” | ~ 128文字 | リセットタイミング | |
| resetDayOfMonth | int | {resetType} == “monthly” | 1 ~ 31 | リセットをする日にち（月の日数を超える場合は、最終日として扱われます） | |
| resetDayOfWeek | enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {resetType} == “weekly” | ~ 128文字 | リセットする曜日 | |
| resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ~ 23 | リセット時刻 | |
| conditionName | string | {scopeType} == “verifyAction” | ~ 128文字 | 条件名 | |
| condition | VerifyAction | {scopeType} == “verifyAction” | 条件 | ||
| anchorTimestamp | long | {resetType} == “days” | 経過日数のカウントをする基準日 (UNIX時間 単位：ミリ秒) | ||
| days | int | {resetType} == “days” | 1 ~ 2147483646 | リセットする日数 |
scopeType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| resetTiming | リセットタイミング |
| verifyAction | 検証アクション |
resetType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| notReset | リセットしない |
| daily | 毎日 |
| weekly | 毎週 |
| monthly | 毎月 |
| days | 一定日数ごと |
resetDayOfWeek に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| sunday | 日曜日 |
| monday | 月曜日 |
| tuesday | 火曜日 |
| wednesday | 水曜日 |
| thursday | 木曜日 |
| friday | 金曜日 |
| saturday | 土曜日 |
ScopedValue
リセットタイミング
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| scopeType | enum { “resetTiming”, “verifyAction” } | ✓ | “resetTiming” | ~ 128文字 | スコープの種類 |
| resetType | enum { “notReset”, “daily”, “weekly”, “monthly”, “days” } | {scopeType} == “resetTiming” | ~ 128文字 | リセットタイミング | |
| conditionName | string | {scopeType} == “verifyAction” | ~ 128文字 | 条件名 | |
| value | long | ✓ | 0 | ~ 9223372036854775805 | カウント |
| nextResetAt | long | 次回リセットタイミング (UNIX時間 単位：ミリ秒) | |||
| updatedAt | long | ✓ | 現在時刻 | 最終更新日時 (UNIX時間 単位：ミリ秒) |
scopeType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| resetTiming | リセットタイミング |
| verifyAction | 検証アクション |
resetType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| notReset | リセットしない |
| daily | 毎日 |
| weekly | 毎週 |
| monthly | 毎月 |
| days | 一定日数ごと |
TargetCounterModel
目標カウンター
ミッションの達成目標となるカウンターの情報
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| counterName | string | ✓ | ~ 128文字 | カウンター名 | |
| scopeType | enum { “resetTiming”, “verifyAction” } | ✓ | “resetTiming” | ~ 128文字 | スコープの種類 |
| resetType | enum { “notReset”, “daily”, “weekly”, “monthly”, “days” } | {scopeType} == “resetTiming” | ~ 128文字 | 目標リセットタイミング | |
| conditionName | string | {scopeType} == “verifyAction” | ~ 128文字 | 条件名 | |
| value | long | ✓ | 1 ~ 9223372036854775805 | 目標値 |
scopeType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| resetTiming | リセットタイミング |
| verifyAction | 検証アクション |
resetType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| notReset | リセットしない |
| daily | 毎日 |
| weekly | 毎週 |
| monthly | 毎月 |
| days | 一定日数ごと |
AcquireAction
入手アクション
ConsumeAction
消費アクション
VerifyAction
検証アクション
Config
コンフィグ設定
トランザクションの変数に適用する設定値
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| key | string | ✓ | ~ 64文字 | 名前 | |
| value | string | ~ 51200文字 | 値 |
VerifyActionResult
検証アクションの実行結果
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128文字 | 検証アクションで実行するアクションの種類 | |
| verifyRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | |
| statusCode | int | ~ 999 | ステータスコード | ||
| verifyResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
| 定義 | 説明 |
|---|
ConsumeActionResult
消費アクションの実行結果
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128文字 | 消費アクションで実行するアクションの種類 | |
| consumeRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | |
| statusCode | int | ~ 999 | ステータスコード | ||
| consumeResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
| 定義 | 説明 |
|---|
AcquireActionResult
入手アクションの実行結果
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| action | enum { } | ✓ | ~ 128文字 | 入手アクションで実行するアクションの種類 | |
| acquireRequest | string | ✓ | ~ 1048576文字 | リクエストのJSON | |
| statusCode | int | ~ 999 | ステータスコード | ||
| acquireResult | string | ~ 1048576文字 | 結果内容 |
action に指定する列挙型の定義
| 定義 | 説明 |
|---|
TransactionResult
トランザクション実行結果
サーバーサイドでのトランザクションの自動実行機能を利用して実行されたトランザクションの実行結果
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| transactionId | string | ✓ | 36 ~ 36文字 | トランザクションID | |
| verifyResults | List<VerifyActionResult> | ~ 10 items | 検証アクションの実行結果リスト | ||
| consumeResults | List<ConsumeActionResult> | [] | ~ 10 items | 消費アクションの実行結果リスト | |
| acquireResults | List<AcquireActionResult> | [] | ~ 100 items | 入手アクションの実行結果リスト |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。
ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。
この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。
GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
GitHubCheckoutSetting
GitHubからマスターデータをチェックアウトする設定
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| apiKeyId | string | ✓ | ~ 1024文字 | GitHub のAPIキーGRN | |
| repositoryName | string | ✓ | ~ 1024文字 | リポジトリ名 | |
| sourcePath | string | ✓ | ~ 1024文字 | ソースコードのファイルパス | |
| referenceType | enum { “commit_hash”, “branch”, “tag” } | ✓ | ~ 128文字 | コードの取得元 | |
| commitHash | string | {referenceType} == “commit_hash” | ~ 1024文字 | コミットハッシュ | |
| branchName | string | {referenceType} == “branch” | ~ 1024文字 | ブランチ名 | |
| tagName | string | {referenceType} == “tag” | ~ 1024文字 | タグ名 |
referenceType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| commit_hash | コミットハッシュ |
| branch | ブランチ |
| tag | タグ |
ScriptSetting
スクリプト設定
GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。
スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。
一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。
かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。
しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。
非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024文字 | スクリプトGRN | ||
| doneTriggerTargetType | enum { “none”, “gs2_script”, “aws” } | ✓ | “none” | ~ 128文字 | 完了通知の通知先 |
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | スクリプトGRN | |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | ネームスペースGRN |
doneTriggerTargetType に指定する列挙型の定義
| 定義 | 説明 |
|---|---|
| none | なし |
| gs2_script | GS2-Script |
| aws | Amazon EventBridge |
TransactionSetting
トランザクション設定
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | 発行したトランザクションをサーバーサイドで自動的に実行するか | |
| enableAtomicCommit | bool | {enableAutoRun} == true | false | トランザクションの実行をアトミックにコミットするか | |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | トランザクションを非同期処理で実行する | |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | 入手アクションを実行する際に GS2-JobQueue を使用するか | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペース |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペース |