> For the complete documentation index, see [llms.txt](/llms.txt)

# GS2-Formation マスターデータリファレンス

マスターデータのフォーマットと インポートする各種モデルのリファレンス




## マスターデータのフォーマット


**JSON**
```json
{
  "version": "2019-09-09",
  "moldModels": [
    {
      "name": "[string]フォームの保存領域モデルの名前",
      "metadata": "[string?]メタデータ",
      "initialMaxCapacity": "[int]フォームを保存できる初期キャパシティ",
      "maxCapacity": "[int]フォームを保存できる最大キャパシティ",
      "formModel": {
        "formModelId": "[string]フォームモデルGRN",
        "name": "[string]フォームモデル名",
        "metadata": "[string?]メタデータ",
        "slots": [
          {
            "name": "[string]スロットモデル名",
            "propertyRegex": "[string]プロパティとして設定可能な値の正規表現",
            "metadata": "[string?]メタデータ"
          }
        ]
      }
    }
  ],
  "propertyFormModels": [
    {
      "name": "[string]プロパティフォームモデル名",
      "metadata": "[string?]メタデータ",
      "slots": [
        {
          "name": "[string]スロットモデル名",
          "propertyRegex": "[string]プロパティとして設定可能な値の正規表現",
          "metadata": "[string?]メタデータ"
        }
      ]
    }
  ]
}
```


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2019-09-09 | | マスターデータのフォーマットバージョン |
| moldModels | [List&lt;MoldModel&gt;](#moldmodel) |  |  |  |  ~ 100 items | フォームの保存領域モデル<br>フォームの保存領域モデルは、パーティ編成であれば「火属性パーティ」「水属性パーティ」のような形で保存することを想定しています。<br>保存できる領域の数は制限することができ、個別に拡張することもできます。 |
| propertyFormModels | [List&lt;PropertyFormModel&gt;](#propertyformmodel) |  |  |  |  ~ 100 items | プロパティフォームモデル<br>プロパティフォームモデルは編成状況を表すエンティティです。<br>Mold / Form との違いは、スロット数を定義して、各スロットに編成を記録するのが Mold / Form で、<br>所有している装備に対してスキルを設定するような、数を事前に決めるのが難しい編成を表現するのに利用するのがプロパティフォームモデルです。 |

## モデル

### FormModel

フォームモデル<br>

フォームモデルは編成状況を表すエンティティです。<br>
編成できる領域として `スロット` を定義できます。<br>

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

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| formModelId | string |  | ※ |  |  ~ 1024文字 | フォームモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | フォームモデル名<br>フォームモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| slots | [List&lt;SlotModel&gt;](#slotmodel) |  | ✓ |  | 1 ~ 10 items | スロットモデルリスト<br>このフォームを構成するスロット定義の順序付きリストです。各スロットは割り当て可能なポジションを表し、スロット名はフォーム内で一意である必要があります。装備では「weapon」「armor」「accessory」のようなスロット、パーティでは「position_1」「position_2」のようなスロットが考えられます。 |

---

### SlotModel

スロットモデル<br>

フォームモデル内の1つのスロットを定義します。スロットはゲームリソース（アイテム、キャラクター、装備など）を配置できる割り当て可能なポジションを表します。プロパティの正規表現によってスロットに設定可能な値が検証されます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | スロットモデル名<br>フォームモデル内でこのスロットを一意に識別する名前です。装備フォームでは「right_hand」「body」のような名前が、パーティフォームでは「vanguard」「rear_guard」のような名前が一般的です。 |
| propertyRegex | string |  |  | ".*" |  ~ 512文字 | プロパティとして設定可能な値の正規表現<br>このスロットに割り当て可能なプロパティ ID 値を検証する正規表現パターンです。例えば、特定の GS2-Inventory アイテム GRN や GS2-Dictionary エントリー GRN に制限することができます。デフォルトは ".*" で任意の値を許可します。 |
| metadata | string |  |  |  |  ~ 512文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |

---

### MoldModel

フォームの保存領域モデル<br>

フォームの保存領域モデルは、パーティ編成であれば「火属性パーティ」「水属性パーティ」のような形で保存することを想定しています。<br>
保存できる領域の数は制限することができ、個別に拡張することもできます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| moldModelId | string |  | ※ |  |  ~ 1024文字 | フォームの保存領域GRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | フォームの保存領域モデルの名前<br>フォームの保存領域モデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| initialMaxCapacity | int |  | ✓ |  | 1 ~ 2147483646 | フォームを保存できる初期キャパシティ<br>この保存領域で各プレイヤーが利用できるデフォルトのフォーム保存スロット数です。例えば 3 に設定すると、プレイヤーは初期状態で最大 3 つの異なる編成（例:「火属性パーティ」「水属性パーティ」「風属性パーティ」）を保存できます。プレイヤーごとに maxCapacity まで拡張可能です。 |
| maxCapacity | int |  | ✓ |  | 1 ~ 2147483646 | フォームを保存できる最大キャパシティ<br>この保存領域でプレイヤーごとのフォーム保存スロット数の絶対的な上限です。キャパシティ拡張操作を行っても、キャパシティはこの値を超えることはできません。initialMaxCapacity 以上の値である必要があります。 |
| formModel | [FormModel](#formmodel) |  | ✓ |  |  | フォームモデル |

---

### PropertyFormModel

プロパティフォームモデル<br>

プロパティフォームモデルは編成状況を表すエンティティです。<br>
Mold / Form との違いは、スロット数を定義して、各スロットに編成を記録するのが Mold / Form で、<br>
所有している装備に対してスキルを設定するような、数を事前に決めるのが難しい編成を表現するのに利用するのがプロパティフォームモデルです。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| propertyFormModelId | string |  | ※ |  |  ~ 1024文字 | プロパティフォームモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | プロパティフォームモデル名<br>プロパティフォームモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 2048文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| slots | [List&lt;SlotModel&gt;](#slotmodel) |  | ✓ |  | 1 ~ 10 items | スロットモデルリスト<br>このプロパティフォームのスロット定義の順序付きリストです。キャパシティでフォーム数が制限される Mold/Form とは異なり、プロパティフォームはプロパティ ID で識別され、所有するリソースごとに存在できます。スロット名はフォーム内で一意である必要があります。 |

---