NAV
GS2-Deploy

GS2-Formation

GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス

エンティティ

Namespace

Namespace

Type: GS2::Formation::Namespace
Properties:
  Name: namespace1
  Description: null
  UpdateMoldScript: null
  UpdateFormScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

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

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

必須 デフォルト 値の制限 説明
name string ~ 32文字 ネームスペース名
description string ~ 1024文字 説明文
updateMoldScript ScriptSetting キャパシティを更新するときに実行するスクリプト
updateFormScript ScriptSetting フォームを更新するときに実行するスクリプト
logSetting LogSetting ログの出力設定

FormModelMaster

FormModelMaster

Type: GS2::Formation::FormModelMaster
Properties:
  NamespaceName: namespace1
  Name: form-0001
  Description: null
  Metadata: null
  Slots: 
    - 
      Name: slot-0001
      PropertyRegex: .*
    - 
      Name: slot-0002
      PropertyRegex: .*
      Metadata: METADATA_0002

編成状況を表すエンティティです。 編成できる領域として スロット を定義できます。

武器・防具 であれば 「右手」「左手」「胴」「腕」のような部位をスロットとし、 パーティであれば「前衛」「中衛」「後衛」のようなポジションをスロットとして表現できます。

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
name string ~ 128文字 フォーム名
description string ~ 1024文字 説明文
metadata string ~ 2048文字 メタデータ
slots SlotModel[] スロットリスト

MoldModelMaster

MoldModelMaster

Type: GS2::Formation::MoldModelMaster
Properties:
  NamespaceName: namespace1
  Name: mold-0001
  Description: null
  Metadata: null
  FormModelName: $formModel1.name
  InitialMaxCapacity: 5
  MaxCapacity: 10

編成状況の保存領域を表すエンティティです。

パーティ編成であれば「火属性パーティ」「水属性パーティ」のような形で保存することを想定しています。

保存できる領域の数は制限することができ、個別に拡張することもできます。

必須 デフォルト 値の制限 説明
namespaceName string ~ 32文字 ネームスペース名
name string ~ 128文字 フォームの保存領域名
description string ~ 1024文字 説明文
metadata string ~ 2048文字 メタデータ
formModelName string ~ 128文字 保存するフォーム
initialMaxCapacity int 1 ~ 9223372036854775807 フォームを保存できる初期キャパシティ
maxCapacity int 1 ~ 9223372036854775807 フォームを保存できる最大キャパシティ

CurrentFormMaster

CurrentFormMaster

Type: GS2::Formation::CurrentFormMaster
Properties:
  NamespaceName: namespace1
  Settings: {\n  "version": "2019-09-09",\n  "moldModels": [\n    {\n      "name": "party",\n      "metadata": "PARTY",\n      "formModel": {\n        "name": "party",\n        "metadata": "PARTY",\n        "slots": [\n          {\n            "name": "tank",\n            "metadata": "TANK",\n            "propertyRegex": "grn:.*"\n          },\n          {\n            "name": "healer",\n            "metadata": "HEALER",\n            "propertyRegex": "grn:.*"\n          },\n          {\n            "name": "dps_1",\n            "metadata": "DPS",\n            "propertyRegex": "grn:.*"\n          },\n          {\n            "name": "dps_2",\n            "metadata": "DPS",\n            "propertyRegex": "grn:.*"\n          }\n        ]\n      },\n      "initialMaxCapacity": 10,\n      "maxCapacity": 20\n    },\n    {\n      "name": "equipment",\n      "metadata": "EQUIPMENT",\n      "formModel": {\n        "name": "equipment",\n        "metadata": "EQUIPMENT",\n        "slots": [\n          {\n            "name": "head",\n            "metadata": "HEAD",\n            "propertyRegex": "grn:.*"\n          },\n          {\n            "name": "body",\n            "metadata": "BODY",\n            "propertyRegex": "grn:.*"\n          },\n          {\n            "name": "leg",\n            "metadata": "LEG",\n            "propertyRegex": "grn:.*"\n          }\n        ]\n      },\n      "initialMaxCapacity": 20,\n      "maxCapacity": 30\n    }\n  ]\n}

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

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

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

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