NAV
GS2-Deploy

GS2-Dictionary

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

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

必須 デフォルト 値の制限 説明
name string ~ 32文字 ネームスペース名
description string ~ 1024文字 説明文
entryScript ScriptSetting エントリー登録時に実行するスクリプト
duplicateEntryScript ScriptSetting 登録済みのエントリーを再度登録しようとした時に実行するスクリプト
logSetting LogSetting ログの出力設定

EntryModelMaster

EntryModelMaster

Type: GS2::Dictionary::EntryModelMaster
Properties:
  NamespaceName: namespace1
  Name: monster-0001
  Description: null
  Metadata: MONSTER-0001

エントリーモデルとは図鑑に記録するエンティティです。 ここではどんなエンティティが図鑑に記録可能かを定義します。

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
name string ~ 128文字 エントリーモデル名
description string ~ 1024文字 説明文
metadata string ~ 2048文字 メタデータ

CurrentEntryMaster

CurrentEntryMaster

Type: GS2::Dictionary::CurrentEntryMaster
Properties:
  NamespaceName: namespace1
  Settings: {\n  "version": "2020-04-30",\n  "entryModels": [\n    {\n      "name": "monster-0001",\n      "metadata": "MONSTER-0001"\n    },\n    {\n      "name": "monster-0002",\n      "metadata": "MONSTER-0002"\n    }\n  ]\n}

GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

JSONファイルの形式についてはドキュメントを参照ください。

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
settings string ~ 5242880文字 マスターデータ