NAV
Japanese | English
GS2-Deploy

GS2-Formation

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

GS2-Deploy リファレンス

エンティティ

Namespace

Namespace

Type: GS2::Formation::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  UpdateMoldScript: null
  UpdateFormScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

ネームスペース

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

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

型 必須 デフォルト 値の制限 説明
name string ✓ ~ 32文字 ネームスペース名
description string ~ 1024文字 説明文
transactionSetting TransactionSetting トランザクション設定
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 ~ 2147483646 フォームを保存できる初期キャパシティ
maxCapacity int ✓ 1 ~ 2147483646 フォームを保存できる最大キャパシティ

CurrentFormMaster

CurrentFormMaster

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

現在有効なマスターデータ

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

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

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

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