GS2-Dictionary
GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス
GS2-Deploy リファレンス
エンティティ
Namespace
Namespace
Type: GS2::Dictionary::Namespace
Properties:
Name: namespace1
Description: null
EntryScript: null
DuplicateEntryScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, dictionary
class SampleStack(Stack):
def __init__(self):
super().__init__()
dictionary.Namespace(
stack=self,
name="namespace-0001",
options=dictionary.NamespaceOptions(
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Dictionary\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Dictionary\Model\Options\NamespaceOptions(
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
),
),
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.dictionary.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.dictionary.model.options.NamespaceOptions() {
{
logSetting = new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import dictionary from "@/gs2cdk/dictionary";
class SampleStack extends core.Stack
{
public constructor() {
super();
new dictionary.model.Namespace(
this,
"namespace-0001",
{
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Dictionary.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Dictionary.Model.Options.NamespaceOptions {
logSetting = new Gs2Cdk.Core.Model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
),
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 32文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| entryScript | ScriptSetting | エントリー登録時に実行するスクリプト | |||
| duplicateEntryScript | ScriptSetting | 登録済みのエントリーを再度登録しようとした時に実行するスクリプト | |||
| logSetting | LogSetting | ログの出力設定 |
CurrentEntryMaster
CurrentEntryMaster
Type: GS2::Dictionary::CurrentEntryMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2020-04-30",
"entryModels": [
{
"name": "monster-0001",
"metadata": "MONSTER-0001"
},
{
"name": "monster-0002",
"metadata": "MONSTER-0002"
}
]
}
from gs2_cdk import Stack, core, dictionary
class SampleStack(Stack):
def __init__(self):
super().__init__()
dictionary.Namespace(
stack=self,
# 省略
).master_data(
[
dictionary.EntryModel(
name='monster-0001',
options=dictionary.EntryModelOptions(
metadata='MONSTER-0001',
),
),
dictionary.EntryModel(
name='monster-0002',
options=dictionary.EntryModelOptions(
metadata='MONSTER-0002',
),
),
],
)
print(SampleStack().yaml()) # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Dictionary\Model\Namespace_(
stack: $this,
// 省略
))->masterData(
[
new \Gs2Cdk\Dictionary\Model\EntryModel(
name:"monster-0001",
options: new \Gs2Cdk\Dictionary\Model\Options\EntryModelOptions(
metadata:"MONSTER-0001",
),
),
new \Gs2Cdk\Dictionary\Model\EntryModel(
name:"monster-0002",
options: new \Gs2Cdk\Dictionary\Model\Options\EntryModelOptions(
metadata:"MONSTER-0002",
),
),
],
);
}
}
print((new SampleStack())->yaml()); // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.dictionary.model.Namespace(
this,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.dictionary.model.EntryModel(
"monster-0001",
new io.gs2.cdk.dictionary.model.options.EntryModelOptions() {
{
metadata: "MONSTER-0001";
}
}
),
new io.gs2.cdk.dictionary.model.EntryModel(
"monster-0002",
new io.gs2.cdk.dictionary.model.options.EntryModelOptions() {
{
metadata: "MONSTER-0002";
}
}
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
import core from "@/gs2cdk/core";
import dictionary from "@/gs2cdk/dictionary";
class SampleStack extends core.Stack
{
public constructor() {
super();
new dictionary.model.Namespace(
this,
// 省略
).masterData(
[
new dictionary.model.EntryModel(
"monster-0001",
{
metadata: "MONSTER-0001"
}
),
new dictionary.model.EntryModel(
"monster-0002",
{
metadata: "MONSTER-0002"
}
)
]
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Dictionary.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Dictionary.Model.EntryModel(
"monster-0001",
new Gs2Cdk.Gs2Dictionary.Model.Options.EntryModelOptions {
metadata = "MONSTER-0001",
}
),
new Gs2Cdk.Gs2Dictionary.Model.EntryModel(
"monster-0002",
new Gs2Cdk.Gs2Dictionary.Model.Options.EntryModelOptions {
metadata = "MONSTER-0002",
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが
よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |