> For the complete documentation index, see [llms.txt](/llms.txt)
# GS2-Mission Deploy/CDK リファレンス
GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
## エンティティ
Deploy処理で操作の対象となるリソース
### Namespace
ネームスペース
ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
#### Request
リソースの生成・更新リクエスト
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| description | string | | | | ~ 1024文字 | 説明文 |
| transactionSetting | [TransactionSetting](#transactionsetting) | | ✓| | | トランザクション設定
ミッション達成報酬の付与時に使用される分散トランザクションの設定です。 |
| missionCompleteScript | [ScriptSetting](#scriptsetting) | | | | | ミッションを達成したときに実行するスクリプトの設定
Script トリガーリファレンス - [`missionComplete`](../script/#missioncomplete) |
| counterIncrementScript | [ScriptSetting](#scriptsetting) | | | | | カウンターが上昇したときに実行するスクリプトの設定
Script トリガーリファレンス - [`counterIncrement`](../script/#counterincrement) |
| receiveRewardsScript | [ScriptSetting](#scriptsetting) | | | | | 報酬を受け取ったときに実行するスクリプトの設定
Script トリガーリファレンス - [`receiveRewards`](../script/#receiverewards) |
| completeNotification | [NotificationSetting](#notificationsetting) | | ✓| | | ミッションのタスクを達成したときのプッシュ通知
ミッションタスクの達成条件が満たされた際に GS2-Gateway を通じて配信されるプッシュ通知の設定です。ゲームクライアントが達成状況を即座にUIに反映できるようにします。 |
| logSetting | [LogSetting](#logsetting) | | | | | ログの出力設定
このネームスペースに対するAPIリクエスト・レスポンスログの出力先となる GS2-Log のネームスペースを指定します。カウンターの増加、ミッション達成、報酬受け取りのデバッグに役立ちます。 |
#### GetAttr
[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果
| | 型 | 説明 |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | 作成したネームスペース
#### 実装例
**GS2-Deploy(YAML)**
```yaml
Type: GS2::Mission::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting:
EnableAutoRun: true
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
MissionCompleteScript: null
CounterIncrementScript: null
ReceiveRewardsScript: null
CompleteNotification: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
```
**Go**
```go
import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/mission"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
mission.NewNamespace(
&SampleStack,
"namespace-0001",
mission.NamespaceOptions{
TransactionSetting: core.NewTransactionSetting(
core.TransactionSettingOptions{
QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
},
),
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(SampleStack.Yaml()) // Generate Template
```
**PHP**
```php
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(
new \Gs2Cdk\Core\Model\TransactionSettingOptions(
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
)
),
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
)
);
}
}
print((new SampleStack())->yaml()); // Generate Template
```
**Java**
```java
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 Template
```
**C#**
```csharp
public 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 Template
```
**TypeScript**
```typescript
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",
{
transactionSetting: new core.TransactionSetting(
{
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
```
**Python**
```python
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(
options=core.TransactionSettingOptions(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
)
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Template
```
#### TransactionSetting
トランザクション設定
トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool | | | false | | 発行したトランザクションをサーバーサイドで自動的に実行するか |
| enableAtomicCommit | bool | {enableAutoRun} == true | | false | | トランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば 有効 |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | | false | | トランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば 有効 |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | | false | | スクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば 有効 |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | | false | | 入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば 有効 |
| distributorNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:distributor:default" | ~ 1024文字 | トランザクションの実行に使用する GS2-Distributor ネームスペースGRN |
| queueNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:queue:default" | ~ 1024文字 | トランザクションの実行に使用する GS2-JobQueue のネームスペースGRN |
#### ScriptSetting
スクリプト設定
GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。
スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。
一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。
非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string | | | | ~ 1024文字 | API 実行時に同期的に実行される GS2-Script のスクリプトGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |
| doneTriggerTargetType | 文字列列挙型
enum {
"none",
"gs2_script",
"aws"
}
| | | "none" | | 非同期スクリプトの実行方法
非同期実行で使用するスクリプトの種類を指定します。
「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。"none": なし / "gs2_script": GS2-Script / "aws": Amazon EventBridge / |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024文字 | 非同期実行する GS2-Script スクリプトGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
※ doneTriggerTargetType が "gs2_script" であれば 有効 |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024文字 | 非同期実行スクリプトを実行する GS2-JobQueue ネームスペースGRN
非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。
GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。
※ doneTriggerTargetType が "gs2_script" であれば 有効 |
#### NotificationSetting
プッシュ通知に関する設定
GS2 のマイクロサービス内で何らかのイベントが発生した際に、プッシュ通知を送信するための設定です。
ここでいうプッシュ通知は GS2-Gateway の提供する WebSocket インターフェースを経由した処理であり、スマートフォンのプッシュ通知とは性質が異なります。
たとえば、マッチメイキングが完了した時やフレンドリクエストが届いた時など、ゲームクライアントの操作とは関係なく状態が変化した際に GS2-Gateway を経由してプッシュ通知をすることで、ゲームクライアントは状態の変化を検知することができます。
GS2-Gateway のプッシュ通知は通知先のデバイスがオフラインだった時に追加の処理としてモバイルプッシュ通知を送信できます。
モバイルプッシュ通知をうまく利用すれば、マッチメイキング中にゲームを終了しても、モバイルプッシュ通知を使用してプレイヤーに通知し、ゲームに戻ってくるフローを実現できる可能性があります。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| gatewayNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:gateway:default" | ~ 1024文字 | プッシュ通知に使用する GS2-Gateway のネームスペース
「grn:gs2:」から始まる GRN 形式で GS2-Gateway のネームスペースIDを指定します。 |
| enableTransferMobileNotification | bool? | | | false | | モバイルプッシュ通知へ転送するか
この通知を送信しようとした時、通知先のデバイスがオフラインだった場合、モバイルプッシュ通知へ転送するかどうかを指定します。 |
| sound | string | {enableTransferMobileNotification} == true | | | ~ 1024文字 | モバイルプッシュ通知で使用するサウンドファイル名
ここで指定したサウンドファイル名は、モバイルプッシュ通知を送信する際に使用され、特別なサウンドで通知を出すことができます。
※ enableTransferMobileNotification が true であれば 有効 |
| enable | 文字列列挙型
enum {
"Enabled",
"Disabled"
}
| | | "Enabled" | | プッシュ通知を有効にするか"Enabled": 有効 / "Disabled": 無効 / |
#### LogSetting
ログの出力設定
ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string | | ✓ | | ~ 1024文字 | ログを出力する GS2-Log のネームスペースGRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。 |
---
### CurrentMissionMaster
現在アクティブなミッションモデルのマスターデータ
現在ネームスペース内で有効な、ミッションのモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール内にマスターデータエディタを提供しています。
また、よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
{{% alert title="Note" color="info" %}}
JSONファイルの形式については [GS2-Mission マスターデータリファレンス](api_reference/mission/master_data/) をご参照ください。
{{% /alert %}}
#### Request
リソースの生成・更新リクエスト
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| mode | 文字列列挙型
enum {
"direct",
"preUpload"
}
| | | "direct" | | 更新モード"direct": マスターデータを直接更新 / "preUpload": マスターデータをアップロードしてから更新 / |
| settings | string | {mode} == "direct" | ✓※| | ~ 5242880 バイト (5MB) | マスターデータ
※ mode が "direct" であれば必須 |
| uploadToken | string | {mode} == "preUpload" | ✓※| | ~ 1024文字 | 事前アップロードで取得したトークン
アップロードしたマスターデータを適用するために使用されます。
※ mode が "preUpload" であれば必須 |
#### GetAttr
[!GetAttr](/articles/tech/deploy/#getattr)タグで取得可能なリソースの生成結果
| | 型 | 説明 |
| --- | --- | --- |
| Item | [CurrentMissionMaster](../sdk#currentmissionmaster) | 更新された現在アクティブなミッションモデルのマスターデータ
#### 実装例
**GS2-Deploy(YAML)**
```yaml
Type: GS2::Mission::CurrentMissionMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2019-05-28",
"groups": [
{
"name": "daily",
"resetType": "daily",
"metadata": "DAILY",
"tasks": [
{
"name": "quest_x10",
"metadata": "QUEST_X10",
"counterName": "quest_complete",
"targetValue": 10,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
},
{
"name": "quest_x20",
"metadata": "QUEST_X20",
"counterName": "quest_complete",
"premiseMissionTaskName": "quest_x10",
"targetValue": 20,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
},
{
"name": "gacha",
"metadata": "GACHA",
"counterName": "lot_gacha",
"targetValue": 1,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
}
],
"resetHour": 10
},
{
"name": "weekly",
"resetType": "weekly",
"metadata": "WEEKLY",
"tasks": [
{
"name": "quest_x100",
"metadata": "QUEST_X100",
"counterName": "quest_complete",
"targetValue": 100,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
},
{
"name": "quest_x1000",
"metadata": "QUEST_X1000",
"counterName": "quest_complete",
"premiseMissionTaskName": "quest_x100",
"targetValue": 1000,
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
}
]
}
],
"resetDayOfWeek": "monday",
"resetHour": 10
},
{
"name": "story",
"resetType": "notReset",
"metadata": "STORY",
"tasks": [
{
"name": "quest_1-1",
"metadata": "QUEST_1-1",
"counterName": "quest1",
"targetValue": 1
},
{
"name": "quest_1-2",
"metadata": "QUEST_1-2",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-1",
"targetValue": 1
},
{
"name": "quest_1-3",
"metadata": "QUEST_1-3",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-2",
"targetValue": 1
},
{
"name": "quest_1-4",
"metadata": "QUEST_1-4",
"counterName": "quest1",
"premiseMissionTaskName": "quest_1-3",
"targetValue": 1
},
{
"name": "quest_2-1",
"metadata": "QUEST_2-1",
"counterName": "quest2",
"premiseMissionTaskName": "quest_1-4",
"targetValue": 1
}
]
}
],
"counters": [
{
"name": "quest_complete",
"scopes": [
{
"resetType": "daily",
"resetHour": 5
},
{
"resetType": "weekly",
"resetDayOfWeek": "monday",
"resetHour": 5
}
],
"metadata": "QUEST_COMPLETE"
},
{
"name": "lot_gacha",
"scopes": [
{
"resetType": "daily",
"resetHour": 5
}
],
"metadata": "LOT_GACHA"
},
{
"name": "quest1",
"scopes": [
{
"resetType": "notReset"
}
],
"metadata": "QUEST1"
},
{
"name": "quest2",
"scopes": [
{
"resetType": "notReset"
}
],
"metadata": "QUEST2"
}
]
}
UploadToken: null
```
**Go**
```go
import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/mission"
"github.com/gs2io/gs2-golang-cdk/experience"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
mission.NewNamespace(
&SampleStack,
"namespace-0001",
mission.NamespaceOptions{},
).MasterData(
[]mission.MissionGroupModel{
mission.NewMissionGroupModel(
"daily",
mission.MissionGroupModelResetTypeDaily,
mission.MissionGroupModelOptions{
Metadata: pointy.String("DAILY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_x10",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X10"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
},
},
),
mission.NewMissionTaskModel(
"quest_x20",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X20"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
},
PremiseMissionTaskName: pointy.String("quest_x10"),
},
),
mission.NewMissionTaskModel(
"gacha",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("GACHA"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
},
},
),
},
ResetHour: pointy.Int32(10),
},
),
mission.NewMissionGroupModel(
"weekly",
mission.MissionGroupModelResetTypeWeekly,
mission.MissionGroupModelOptions{
Metadata: pointy.String("WEEKLY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_x100",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X100"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
},
},
),
mission.NewMissionTaskModel(
"quest_x1000",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_X1000"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
},
PremiseMissionTaskName: pointy.String("quest_x100"),
},
),
},
ResetDayOfWeek: mission.MissionGroupModelResetDayOfWeekMonday.Pointer(),
ResetHour: pointy.Int32(10),
},
),
mission.NewMissionGroupModel(
"story",
mission.MissionGroupModelResetTypeNotReset,
mission.MissionGroupModelOptions{
Metadata: pointy.String("STORY"),
Tasks: []mission.MissionTaskModel{
mission.NewMissionTaskModel(
"quest_1-1",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-1"),
},
),
mission.NewMissionTaskModel(
"quest_1-2",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-2"),
PremiseMissionTaskName: pointy.String("quest_1-1"),
},
),
mission.NewMissionTaskModel(
"quest_1-3",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-3"),
PremiseMissionTaskName: pointy.String("quest_1-2"),
},
),
mission.NewMissionTaskModel(
"quest_1-4",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_1-4"),
PremiseMissionTaskName: pointy.String("quest_1-3"),
},
),
mission.NewMissionTaskModel(
"quest_2-1",
mission.MissionTaskModelVerifyCompleteTypeCounter,
mission.MissionTaskModelOptions{
Metadata: pointy.String("QUEST_2-1"),
PremiseMissionTaskName: pointy.String("quest_1-4"),
},
),
},
},
),
},
[]mission.CounterModel{
mission.NewCounterModel(
"quest_complete",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeDaily,
mission.CounterScopeModelOptions{
ResetHour: pointy.Int32(5),
},
),
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeWeekly,
mission.CounterScopeModelOptions{
ResetDayOfWeek: mission.CounterScopeModelResetDayOfWeekMonday.Pointer(),
ResetHour: pointy.Int32(5),
},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST_COMPLETE"),
},
),
mission.NewCounterModel(
"lot_gacha",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeDaily,
mission.CounterScopeModelOptions{
ResetHour: pointy.Int32(5),
},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("LOT_GACHA"),
},
),
mission.NewCounterModel(
"quest1",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeNotReset,
mission.CounterScopeModelOptions{},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST1"),
},
),
mission.NewCounterModel(
"quest2",
[]mission.CounterScopeModel{
mission.NewCounterScopeModel(
mission.CounterScopeModelScopeTypeResetTiming,
mission.CounterScopeModelResetTypeNotReset,
mission.CounterScopeModelOptions{},
),
},
mission.CounterModelOptions{
Metadata: pointy.String("QUEST2"),
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
```
**PHP**
```php
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,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
),
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x20",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_X20",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
premiseMissionTaskName: "quest_x10",
),
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "gacha",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "GACHA",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
),
),
],
resetHour:10
)
),
new \Gs2Cdk\Mission\Model\MissionGroupModel(
name:"weekly",
resetType: \Gs2Cdk\Mission\Model\Enums\MissionGroupModelResetType::WEEKLY,
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"WEEKLY",
tasks:[
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x100",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_X100",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
),
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_x1000",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_X1000",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
],
premiseMissionTaskName: "quest_x100",
),
),
],
resetDayOfWeek:\Gs2Cdk\Mission\Model\Enums\MissionGroupModelResetDayOfWeek::MONDAY,
resetHour:10
)
),
new \Gs2Cdk\Mission\Model\MissionGroupModel(
name:"story",
resetType: \Gs2Cdk\Mission\Model\Enums\MissionGroupModelResetType::NOT_RESET,
options: new \Gs2Cdk\Mission\Model\Options\MissionGroupModelOptions(
metadata:"STORY",
tasks:[
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-1",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_1-1",
),
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-2",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_1-2",
premiseMissionTaskName: "quest_1-1",
),
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-3",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_1-3",
premiseMissionTaskName: "quest_1-2",
),
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_1-4",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_1-4",
premiseMissionTaskName: "quest_1-3",
),
),
new \Gs2Cdk\Mission\Model\MissionTaskModel(
name: "quest_2-1",
verifyCompleteType: \Gs2Cdk\Mission\Model\Enums\MissionTaskModelVerifyCompleteType::COUNTER,
options: new \Gs2Cdk\Mission\Model\Options\MissionTaskModelOptions(
metadata: "QUEST_2-1",
premiseMissionTaskName: "quest_1-4",
),
),
]
)
)
],
[
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest_complete",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::DAILY,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetHour: 5,
),
),
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::WEEKLY,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetDayOfWeek: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetDayOfWeek::MONDAY,
resetHour: 5,
),
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST_COMPLETE"
)
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"lot_gacha",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::DAILY,
options: new \Gs2Cdk\Mission\Model\Options\CounterScopeModelOptions(
resetHour: 5,
),
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"LOT_GACHA"
)
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest1",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::NOT_RESET,
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST1"
)
),
new \Gs2Cdk\Mission\Model\CounterModel(
name:"quest2",
scopes:[
new \Gs2Cdk\Mission\Model\CounterScopeModel(
scopeType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelScopeType::RESET_TIMING,
resetType: \Gs2Cdk\Mission\Model\Enums\CounterScopeModelResetType::NOT_RESET,
),
],
options: new \Gs2Cdk\Mission\Model\Options\CounterModelOptions(
metadata:"QUEST2"
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
```
**Java**
```java
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")
.withTasks(Arrays.asList(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x10",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_X10")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x20",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_X20")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
.withPremiseMissionTaskName("quest_x10")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"gacha",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("GACHA")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
)
))
.withResetHour(10)
),
new io.gs2.cdk.mission.model.MissionGroupModel(
"weekly",
io.gs2.cdk.mission.model.enums.MissionGroupModelResetType.WEEKLY,
new io.gs2.cdk.mission.model.options.MissionGroupModelOptions()
.withMetadata("WEEKLY")
.withTasks(Arrays.asList(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x100",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_X100")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_x1000",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_X1000")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
)
))
.withPremiseMissionTaskName("quest_x100")
)
))
.withResetDayOfWeek(io.gs2.cdk.mission.model.enums.MissionGroupModelResetDayOfWeek.MONDAY)
.withResetHour(10)
),
new io.gs2.cdk.mission.model.MissionGroupModel(
"story",
io.gs2.cdk.mission.model.enums.MissionGroupModelResetType.NOT_RESET,
new io.gs2.cdk.mission.model.options.MissionGroupModelOptions()
.withMetadata("STORY")
.withTasks(Arrays.asList(
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-1",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_1-1")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-2",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_1-2")
.withPremiseMissionTaskName("quest_1-1")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-3",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_1-3")
.withPremiseMissionTaskName("quest_1-2")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_1-4",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_1-4")
.withPremiseMissionTaskName("quest_1-3")
),
new io.gs2.cdk.mission.model.MissionTaskModel(
"quest_2-1",
io.gs2.cdk.mission.model.enums.MissionTaskModelVerifyCompleteType.COUNTER,
new io.gs2.cdk.mission.model.options.MissionTaskModelOptions()
.withMetadata("QUEST_2-1")
.withPremiseMissionTaskName("quest_1-4")
)
))
)
),
Arrays.asList(
new io.gs2.cdk.mission.model.CounterModel(
"quest_complete",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.DAILY,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetHour(5)
),
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.WEEKLY,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetDayOfWeek(io.gs2.cdk.mission.model.enums.CounterScopeModelResetDayOfWeek.MONDAY)
.withResetHour(5)
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions()
.withMetadata("QUEST_COMPLETE")
),
new io.gs2.cdk.mission.model.CounterModel(
"lot_gacha",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.DAILY,
new io.gs2.cdk.mission.model.options.CounterScopeModelOptions()
.withResetHour(5)
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions()
.withMetadata("LOT_GACHA")
),
new io.gs2.cdk.mission.model.CounterModel(
"quest1",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.NOT_RESET
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions()
.withMetadata("QUEST1")
),
new io.gs2.cdk.mission.model.CounterModel(
"quest2",
Arrays.asList(
new io.gs2.cdk.mission.model.CounterScopeModel(
io.gs2.cdk.mission.model.enums.CounterScopeModelScopeType.RESET_TIMING,
io.gs2.cdk.mission.model.enums.CounterScopeModelResetType.NOT_RESET
)
),
new io.gs2.cdk.mission.model.options.CounterModelOptions()
.withMetadata("QUEST2")
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
```
**C#**
```csharp
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Mission.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel[] {
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
name: "daily",
resetType: Gs2Cdk.Gs2Mission.Model.Enums.MissionGroupModelResetType.Daily,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions
{
metadata = "DAILY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[]
{
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x10",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_X10",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
}
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x20",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_X20",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
},
premiseMissionTaskName = "quest_x10"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "gacha",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "GACHA",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
}
}
)
},
resetHour = 10
}
),
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
name: "weekly",
resetType: Gs2Cdk.Gs2Mission.Model.Enums.MissionGroupModelResetType.Weekly,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions
{
metadata = "WEEKLY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[]
{
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x100",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_X100",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
}
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_x1000",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_X1000",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
)
},
premiseMissionTaskName = "quest_x100"
}
)
},
resetDayOfWeek = Gs2Cdk.Gs2Mission.Model.Enums.MissionGroupModelResetDayOfWeek.Monday,
resetHour = 10
}
),
new Gs2Cdk.Gs2Mission.Model.MissionGroupModel(
name: "story",
resetType: Gs2Cdk.Gs2Mission.Model.Enums.MissionGroupModelResetType.NotReset,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionGroupModelOptions
{
metadata = "STORY",
tasks = new Gs2Cdk.Gs2Mission.Model.MissionTaskModel[]
{
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-1",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_1-1"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-2",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_1-2",
premiseMissionTaskName = "quest_1-1"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-3",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_1-3",
premiseMissionTaskName = "quest_1-2"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_1-4",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_1-4",
premiseMissionTaskName = "quest_1-3"
}
),
new Gs2Cdk.Gs2Mission.Model.MissionTaskModel(
name: "quest_2-1",
verifyCompleteType: Gs2Cdk.Gs2Mission.Model.Enums.MissionTaskModelVerifyCompleteType.Counter,
options: new Gs2Cdk.Gs2Mission.Model.Options.MissionTaskModelOptions
{
metadata = "QUEST_2-1",
premiseMissionTaskName = "quest_1-4"
}
)
}
}
)
},
new Gs2Cdk.Gs2Mission.Model.CounterModel[] {
new Gs2Cdk.Gs2Mission.Model.CounterModel(
name: "quest_complete",
scopes: new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[]
{
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Daily,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetHour = 5
}
),
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Weekly,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetDayOfWeek = Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetDayOfWeek.Monday,
resetHour = 5
}
)
},
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions
{
metadata = "QUEST_COMPLETE"
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
name: "lot_gacha",
scopes: new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[]
{
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.Daily,
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterScopeModelOptions
{
resetHour = 5
}
)
},
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions
{
metadata = "LOT_GACHA"
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
name: "quest1",
scopes: new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[]
{
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.NotReset
)
},
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions
{
metadata = "QUEST1"
}
),
new Gs2Cdk.Gs2Mission.Model.CounterModel(
name: "quest2",
scopes: new Gs2Cdk.Gs2Mission.Model.CounterScopeModel[]
{
new Gs2Cdk.Gs2Mission.Model.CounterScopeModel(
scopeType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelScopeType.ResetTiming,
resetType: Gs2Cdk.Gs2Mission.Model.Enums.CounterScopeModelResetType.NotReset
)
},
options: new Gs2Cdk.Gs2Mission.Model.Options.CounterModelOptions
{
metadata = "QUEST2"
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
```
**TypeScript**
```typescript
import core from "@/gs2cdk/core";
import mission from "@/gs2cdk/mission";
import experience from "@/gs2cdk/experience";
class SampleStack extends core.Stack
{
public constructor() {
super();
new mission.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new mission.model.MissionGroupModel(
"daily",
mission.model.MissionGroupModelResetType.DAILY,
{
metadata: "DAILY",
tasks: [
new mission.model.MissionTaskModel(
"quest_x10",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X10",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
]
}
),
new mission.model.MissionTaskModel(
"quest_x20",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X20",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
],
premiseMissionTaskName: "quest_x10"
}
),
new mission.model.MissionTaskModel(
"gacha",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "GACHA",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
]
}
),
],
resetHour: 10
}
),
new mission.model.MissionGroupModel(
"weekly",
mission.model.MissionGroupModelResetType.WEEKLY,
{
metadata: "WEEKLY",
tasks: [
new mission.model.MissionTaskModel(
"quest_x100",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X100",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
]
}
),
new mission.model.MissionTaskModel(
"quest_x1000",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_X1000",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
],
premiseMissionTaskName: "quest_x100"
}
),
],
resetDayOfWeek: mission.model.MissionGroupModelResetDayOfWeek.MONDAY,
resetHour: 10
}
),
new mission.model.MissionGroupModel(
"story",
mission.model.MissionGroupModelResetType.NOT_RESET,
{
metadata: "STORY",
tasks: [
new mission.model.MissionTaskModel(
"quest_1-1",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_1-1"
}
),
new mission.model.MissionTaskModel(
"quest_1-2",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_1-2",
premiseMissionTaskName: "quest_1-1"
}
),
new mission.model.MissionTaskModel(
"quest_1-3",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_1-3",
premiseMissionTaskName: "quest_1-2"
}
),
new mission.model.MissionTaskModel(
"quest_1-4",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_1-4",
premiseMissionTaskName: "quest_1-3"
}
),
new mission.model.MissionTaskModel(
"quest_2-1",
mission.model.MissionTaskModelVerifyCompleteType.COUNTER,
{
metadata: "QUEST_2-1",
premiseMissionTaskName: "quest_1-4"
}
),
]
}
)
],
[
new mission.model.CounterModel(
"quest_complete",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.DAILY,
{
resetHour: 5
}
),
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.WEEKLY,
{
resetDayOfWeek: mission.model.CounterScopeModelResetDayOfWeek.MONDAY,
resetHour: 5
}
),
],
{
metadata: "QUEST_COMPLETE"
}
),
new mission.model.CounterModel(
"lot_gacha",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.DAILY,
{
resetHour: 5
}
),
],
{
metadata: "LOT_GACHA"
}
),
new mission.model.CounterModel(
"quest1",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.NOT_RESET
),
],
{
metadata: "QUEST1"
}
),
new mission.model.CounterModel(
"quest2",
[
new mission.model.CounterScopeModel(
mission.model.CounterScopeModelScopeType.RESET_TIMING,
mission.model.CounterScopeModelResetType.NOT_RESET
),
],
{
metadata: "QUEST2"
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
```
**Python**
```python
from gs2_cdk import Stack, core, mission, experience
class SampleStack(Stack):
def __init__(self):
super().__init__()
mission.Namespace(
stack=self,
name="namespace-0001",
).master_data(
groups=[
mission.MissionGroupModel(
name='daily',
reset_type=mission.MissionGroupModelResetType.DAILY,
options=mission.MissionGroupModelOptions(
metadata = 'DAILY',
tasks = [
mission.MissionTaskModel(
name='quest_x10',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_X10',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
),
),
mission.MissionTaskModel(
name='quest_x20',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_X20',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
premise_mission_task_name='quest_x10',
),
),
mission.MissionTaskModel(
name='gacha',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='GACHA',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
),
),
],
reset_hour = 10
),
),
mission.MissionGroupModel(
name='weekly',
reset_type=mission.MissionGroupModelResetType.WEEKLY,
options=mission.MissionGroupModelOptions(
metadata = 'WEEKLY',
tasks = [
mission.MissionTaskModel(
name='quest_x100',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_X100',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
),
),
mission.MissionTaskModel(
name='quest_x1000',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_X1000',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
],
premise_mission_task_name='quest_x100',
),
),
],
reset_day_of_week = mission.MissionGroupModelResetDayOfWeek.MONDAY,
reset_hour = 10
),
),
mission.MissionGroupModel(
name='story',
reset_type=mission.MissionGroupModelResetType.NOT_RESET,
options=mission.MissionGroupModelOptions(
metadata = 'STORY',
tasks = [
mission.MissionTaskModel(
name='quest_1-1',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_1-1',
),
),
mission.MissionTaskModel(
name='quest_1-2',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_1-2',
premise_mission_task_name='quest_1-1',
),
),
mission.MissionTaskModel(
name='quest_1-3',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_1-3',
premise_mission_task_name='quest_1-2',
),
),
mission.MissionTaskModel(
name='quest_1-4',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_1-4',
premise_mission_task_name='quest_1-3',
),
),
mission.MissionTaskModel(
name='quest_2-1',
verify_complete_type= mission.MissionTaskModelVerifyCompleteType.COUNTER,
options=mission.MissionTaskModelOptions(
metadata='QUEST_2-1',
premise_mission_task_name='quest_1-4',
),
),
]
),
),
],
counters=[
mission.CounterModel(
name='quest_complete',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.DAILY,
options=mission.CounterScopeModelOptions(
reset_hour=5,
),
),
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.WEEKLY,
options=mission.CounterScopeModelOptions(
reset_day_of_week=mission.CounterScopeModelResetDayOfWeek.MONDAY,
reset_hour=5,
),
),
],
options=mission.CounterModelOptions(
metadata = 'QUEST_COMPLETE'
),
),
mission.CounterModel(
name='lot_gacha',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.DAILY,
options=mission.CounterScopeModelOptions(
reset_hour=5,
),
),
],
options=mission.CounterModelOptions(
metadata = 'LOT_GACHA'
),
),
mission.CounterModel(
name='quest1',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.NOT_RESET,
),
],
options=mission.CounterModelOptions(
metadata = 'QUEST1'
),
),
mission.CounterModel(
name='quest2',
scopes=[
mission.CounterScopeModel(
scope_type= mission.CounterScopeModelScopeType.RESET_TIMING,
reset_type=mission.CounterScopeModelResetType.NOT_RESET,
),
],
options=mission.CounterModelOptions(
metadata = 'QUEST2'
),
),
],
)
print(SampleStack().yaml()) # Generate Template
```
#### CounterModel
カウンターモデル
カウンターモデルはミッションタスクの達成条件に設定可能なエンティティです。
カウンターの値は複数のミッショングループから参照可能なため、1つのカウンターでウィークリーミッションとデイリーミッションといった複数のミッショングループの達成条件に設定ができます。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| counterId | string | | ※ | | ~ 1024文字 | カウンターモデルGRN
※ サーバーが自動で設定 |
| name | string | | ✓ | | ~ 128文字 | カウンターモデル名
カウンターモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string | | | | ~ 1024文字 | メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| scopes | [List<CounterScopeModel>](#counterscopemodel) | | | [] | 1 ~ 20 items | カウンターのリセットタイミングリスト
このカウンターのスコープ（リセットタイミングまたは検証アクション条件）を定義します。1つのカウンターに複数のスコープを設定でき、異なる期間の値（例：デイリー、ウィークリー、累計を同時に）を追跡できます。 |
| challengePeriodEventId | string | | | | ~ 1024文字 | カウンターの操作が可能な期間を設定した GS2-Schedule イベントGRN
このカウンターの増減が可能な期間を定義する GS2-Schedule イベントを指定します。未設定の場合、カウンターはいつでも操作できます。 |
#### CounterScopeModel
カウンターリセットタイミングモデル
カウンターのスコープを定義し、カウンター値のリセット方法とタイミングを決定します。スコープはリセットタイミング（毎日、毎週、毎月、一定日数ごと、またはリセットなし）か検証アクション条件のいずれかです。各カウンターは複数のスコープを持ち、異なる期間の値を追跡できます。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| scopeType | 文字列列挙型
enum {
"resetTiming",
"verifyAction"
}
| | | "resetTiming" | | スコープの種類
カウンタースコープの定義方法を決定します。"resetTiming" は定期的なリセットスケジュールを使用し、"verifyAction" は検証アクションでカウンター値が適用されるかどうかを判定します。"resetTiming": リセットタイミング / "verifyAction": 検証アクション / |
| resetType | 文字列列挙型
enum {
"notReset",
"daily",
"weekly",
"monthly",
"days"
}
| | | "notReset" | | リセットタイミング
このスコープのカウンター値がリセットされるタイミングを決定します。リセットしない（恒久累計）、毎日、毎週、毎月、一定日数ごとから選択します。scopeType が "resetTiming" の場合のみ使用されます。"notReset": リセットしない / "daily": 毎日 / "weekly": 毎週 / "monthly": 毎月 / "days": 一定日数ごと / |
| resetDayOfMonth | int | {resetType} == "monthly" | ✓※ | | 1 ~ 31 | リセットをする日にち
カウンター値がリセットされる月の日にちです。指定した値が月の日数を超える場合は、その月の最終日として扱われます。resetType が "monthly" の場合のみ使用されます。
※ resetType が "monthly" であれば 必須 |
| resetDayOfWeek | 文字列列挙型
enum {
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
}
| {resetType} == "weekly" | ✓※ | | | リセットする曜日
カウンター値がリセットされる曜日です。resetType が "weekly" の場合のみ使用されます。"sunday": 日曜日 / "monday": 月曜日 / "tuesday": 火曜日 / "wednesday": 水曜日 / "thursday": 木曜日 / "friday": 金曜日 / "saturday": 土曜日 /
※ resetType が "weekly" であれば 必須 |
| resetHour | int | {resetType} in ["monthly", "weekly", "daily"] | ✓※ | | 0 ~ 23 | リセット時刻
カウンター値がリセットされる時刻（0〜23）です。毎日、毎週、毎月のリセットタイプと組み合わせて使用されます。
※ resetType が "monthly","weekly","daily"であれば 必須 |
| conditionName | string | {scopeType} == "verifyAction" | ✓※ | | ~ 128文字 | 条件名
この検証アクション条件スコープを識別する一意の名前です。カウンター内の対応するスコープ値の検索に使用されます。scopeType が "verifyAction" の場合のみ使用されます。
※ scopeType が "verifyAction" であれば 必須 |
| condition | [VerifyAction](#verifyaction) | {scopeType} == "verifyAction" | ✓※ | | | 条件
このスコープのカウンター値が適用されるかどうかを判定する検証アクションです。scopeType が "verifyAction" の場合のみ使用されます。
※ scopeType が "verifyAction" であれば 必須 |
| anchorTimestamp | long | {resetType} == "days" | ✓※ | | | 経過日数のカウントをする基準日時
UNIX 時間・ミリ秒
※ resetType が "days" であれば 必須 |
| days | int | {resetType} == "days" | ✓※ | | 1 ~ 2147483646 | リセットする日数
基準日時からカウントされるカウンター値のリセット間隔の日数です。resetType が "days" の場合のみ使用されます。
※ resetType が "days" であれば 必須 |
#### MissionGroupModel
ミッショングループモデル
ミッショングループは、カウンターのリセットタイミングでタスクをグルーピングするエンティティです。
たとえば、デイリーミッションで1つのグループ、ウィークリーミッションで1つのグループとなります。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| missionGroupId | string | | ※ | | ~ 1024文字 | ミッショングループGRN
※ サーバーが自動で設定 |
| name | string | | ✓ | | ~ 128文字 | ミッショングループモデル名
ミッショングループモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string | | | | ~ 1024文字 | メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| tasks | [List<MissionTaskModel>](#missiontaskmodel) | | | [] | 0 ~ 1000 items | ミッションタスクリスト
このグループに属するミッションタスクです。各タスクは達成条件（カウンターの閾値または検証アクション）と達成時に付与される報酬を定義します。 |
| resetType | 文字列列挙型
enum {
"notReset",
"daily",
"weekly",
"monthly",
"days"
}
| | | "notReset" | | リセットタイミング
ミッショングループの達成状況がリセットされるタイミングを決定します。リセットしない（恒久）、毎日、毎週、毎月、基準日時から一定日数ごとから選択します。"notReset": リセットしない / "daily": 毎日 / "weekly": 毎週 / "monthly": 毎月 / "days": 一定日数ごと / |
| resetDayOfMonth | int | {resetType} == "monthly" | ✓※ | | 1 ~ 31 | リセットをする日にち
ミッショングループがリセットされる月の日にちです。指定した値が月の日数を超える場合は、その月の最終日として扱われます。resetType が "monthly" の場合のみ使用されます。
※ resetType が "monthly" であれば 必須 |
| resetDayOfWeek | 文字列列挙型
enum {
"sunday",
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday"
}
| {resetType} == "weekly" | ✓※ | | | リセットする曜日
ミッショングループがリセットされる曜日です。resetType が "weekly" の場合のみ使用されます。"sunday": 日曜日 / "monday": 月曜日 / "tuesday": 火曜日 / "wednesday": 水曜日 / "thursday": 木曜日 / "friday": 金曜日 / "saturday": 土曜日 /
※ resetType が "weekly" であれば 必須 |
| resetHour | int | {resetType} in ["monthly", "weekly", "daily"] | ✓※ | | 0 ~ 23 | リセット時刻
ミッショングループがリセットされる時刻（0〜23）です。毎日、毎週、毎月のリセットタイプと組み合わせて使用されます。
※ resetType が "monthly","weekly","daily"であれば 必須 |
| completeNotificationNamespaceId | string | | | | ~ 1024文字 | ミッションのタスクを達成したときのプッシュ通知
このグループ内のミッションタスクが達成された際にプッシュ通知を配信するために使用される GS2-Gateway のネームスペースGRNです。ゲームクライアントにリアルタイムで通知できます。 |
| anchorTimestamp | long | {resetType} == "days" | ✓※ | | | 経過日数のカウントをする基準日時
UNIX 時間・ミリ秒
※ resetType が "days" であれば 必須 |
| days | int | {resetType} == "days" | ✓※ | | 1 ~ 2147483646 | リセットする日数
基準日時からカウントされるリセット間隔の日数です。resetType が "days" の場合のみ使用されます。
※ resetType が "days" であれば 必須 |
#### MissionTaskModel
ミッションタスクモデル
ミッションタスクは関連付けたカウンターの値が一定を超えたら報酬が貰える条件を定義するエンティティです。
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| missionTaskId | string | | ※ | | ~ 1024文字 | ミッションタスクGRN
※ サーバーが自動で設定 |
| name | string | | ✓ | | ~ 128文字 | ミッションタスクモデル名
ミッションタスクモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string | | | | ~ 1024文字 | メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| verifyCompleteType | 文字列列挙型
enum {
"counter",
"verifyActions"
}
| | | "counter" | | 達成条件種別
ミッションタスクの達成判定方法を指定します。"counter" は関連するカウンターのスコープ値が目標閾値に達したかを確認します。"verifyActions" は検証アクションを使用して達成条件を確認します。"counter": カウンター / "verifyActions": 検証アクション / |
| targetCounter | [TargetCounterModel](#targetcountermodel) | {verifyCompleteType} == "counter" | ✓※ | | | 目標カウンター
ミッションタスクの達成判定に使用されるカウンター、スコープ、目標値を定義します。カウンターのスコープ値が指定された目標値に達するか超えた場合、タスクが達成されたとみなされます。
※ verifyCompleteType が "counter" であれば 必須 |
| verifyCompleteConsumeActions | [List<VerifyAction>](#verifyaction) | {verifyCompleteType} == "verifyActions" | | [] | 0 ~ 10 items | タスク達成判定に使用する検証アクション
ミッションタスクの達成判定に使用される検証アクションのリストです。すべての検証アクションが成功した場合にタスクが達成とみなされます。verifyCompleteType が "verifyActions" の場合のみ使用されます。
※ verifyCompleteType が "verifyActions" であれば 有効 |
| completeAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | ミッション達成時の報酬
プレイヤーがミッション達成報酬を受け取る際に実行される入手アクションのリストです。 |
| challengePeriodEventId | string | | | | ~ 1024文字 | 報酬が受け取り可能な期間を設定した GS2-Schedule イベントGRN
ミッションタスクの報酬を受け取ることができる期間を定義する GS2-Schedule イベントを指定します。未設定の場合、達成後いつでも報酬を受け取ることができます。 |
| premiseMissionTaskName | string | | | | ~ 128文字 | このタスクに挑戦するために達成しておく必要のあるタスクの名前
このタスクの報酬を受け取る前に達成しておく必要がある、同じグループ内の前提ミッションタスクを指定します。段階的なミッションチェーンの作成に使用します。 |
#### TargetCounterModel
目標カウンター
ミッションの達成目標となるカウンターの情報
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| counterName | string | | ✓ | | ~ 128文字 | カウンターモデル名
カウンターモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| scopeType | 文字列列挙型
enum {
"resetTiming",
"verifyAction"
}
| | | "resetTiming" | | スコープの種類
ミッション達成判定に使用するカウンタースコープの種類を指定します。"resetTiming" は特定のリセット期間のカウンター値を評価し、"verifyAction" は名前付き条件の値を評価します。"resetTiming": リセットタイミング / "verifyAction": 検証アクション / |
| resetType | 文字列列挙型
enum {
"notReset",
"daily",
"weekly",
"monthly",
"days"
}
| {scopeType} == "resetTiming" | | | | 目標リセットタイミング
目標値と比較するカウンターのリセットタイミングスコープを指定します。例えば "daily" を選択すると、デイリーのカウンター値を確認します。省略した場合、ミッショングループのリセットタイミングが使用されます。"notReset": リセットしない / "daily": 毎日 / "weekly": 毎週 / "monthly": 毎月 / "days": 一定日数ごと /
※ scopeType が "resetTiming" であれば 有効 |
| conditionName | string | {scopeType} == "verifyAction" | ✓※ | | ~ 128文字 | 条件名
目標値と比較する検証アクション条件スコープの名前です。カウンターモデルのスコープで定義された conditionName と一致する必要があります。scopeType が "verifyAction" の場合のみ使用されます。
※ scopeType が "verifyAction" であれば 必須 |
| value | long | | ✓ | | 0 ~ 9223372036854775805 | 目標値
ミッションタスクが達成とみなされるために、カウンターのスコープ値が達するか超える必要がある閾値です。 |
#### AcquireAction
入手アクション
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| action | 文字列列挙型
enum {
}
| | ✓ | | | 入手アクションで実行するアクションの種類 |
| request | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |
#### VerifyAction
検証アクション
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| action | 文字列列挙型
enum {
}
| | ✓ | | | 検証アクションで実行するアクションの種類 |
| request | string | | ✓ | | ~ 524288文字 | アクション実行時に使用されるリクエストのJSON文字列 |
---