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

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

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




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


**JSON**
```json
{
  "version": "2019-02-14",
  "staminaModels": [
    {
      "name": "[string]スタミナモデル名",
      "metadata": "[string?]メタデータ",
      "recoverIntervalMinutes": "[int]回復間隔（分）",
      "recoverValue": "[int]回復量",
      "initialCapacity": "[int]最大値の初期値",
      "isOverflow": "[bool]オーバーフロー可否",
      "maxCapacity": "[int]オーバーフロー時の最大値",
      "maxStaminaTable": {
        "name": "[string]スタミナ最大値テーブル名",
        "metadata": "[string?]メタデータ",
        "experienceModelId": "[string]経験値モデルID",
        "values": [
          "[int]スタミナの最大値"
        ]
      },
      "recoverIntervalTable": {
        "name": "[string]回復間隔テーブル名",
        "metadata": "[string?]メタデータ",
        "experienceModelId": "[string]経験値モデルID",
        "values": [
          "[int?]スタミナの回復間隔（分）"
        ]
      },
      "recoverValueTable": {
        "name": "[string]スタミナ回復量テーブル名",
        "metadata": "[string?]メタデータ",
        "experienceModelId": "[string]経験値モデルID",
        "values": [
          "[int?]スタミナの回復量"
        ]
      }
    }
  ]
}
```


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| version | string | | ✓ | 2019-02-14 | | マスターデータのフォーマットバージョン |
| staminaModels | [List&lt;StaminaModel&gt;](#staminamodel) |  |  |  |  ~ 100 items | スタミナモデル<br>スタミナの最大値や、回復間隔、回復量といったパラメータを定義できます。<br>GS2-Experience と連動させて、最大値や回復量をコントロールすることもできます。 |

## モデル

### StaminaModel

スタミナモデル<br>

スタミナの最大値や、回復間隔、回復量といったパラメータを定義できます。<br>
GS2-Experience と連動させて、最大値や回復量をコントロールすることもできます。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| staminaModelId | string |  | ※ |  |  ~ 1024文字 | スタミナモデルGRN<br>※ サーバーが自動で設定 |
| name | string |  | ✓ |  |  ~ 128文字 | スタミナモデル名<br>スタミナモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 128文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| recoverIntervalMinutes | int |  | ✓ |  | 0 ~ 2147483646 | 回復間隔（分）<br>スタミナ回復ティックの間隔（分単位）。<br>この間隔が経過するたびに、プレイヤーのスタミナが回復量分だけ増加します。<br>RecoverIntervalTable を使用して GS2-Experience のランクごとにユーザー単位でオーバーライド可能です。<br>0 に設定すると時間ベースの自動回復が無効になります。 |
| recoverValue | int |  |  | 1 | 0 ~ 2147483646 | 回復量<br>回復ティックごとに回復するスタミナの量。<br>回復間隔が経過するたびに、最大値に達するまでこの値分スタミナが増加します。<br>RecoverValueTable を使用して GS2-Experience のランクごとにユーザー単位でオーバーライド可能です。<br>デフォルトは 1。 |
| initialCapacity | int |  | ✓ |  | 0 ~ 2147483646 | 最大値の初期値<br>全プレイヤーに対するデフォルトのスタミナ最大値。<br>オーバーフローが無効の場合、ユーザーごとの最大値の下限として機能します。<br>MaxStaminaTable を使用して GS2-Experience のランクごとにユーザー単位でオーバーライド可能です。 |
| isOverflow | bool |  | ✓ |  |  | オーバーフロー可否<br>アイテム使用などの手段でスタミナが初期最大値を超えられるかどうか。<br>有効の場合、スタミナは initialCapacity を超えて maxCapacity まで設定可能です。自然回復は通常の最大値で停止します。<br>無効の場合、ユーザーごとの最大値は initialCapacity 以上に制限されます。 |
| maxCapacity | int | {isOverflow} == true | ✓※ |  | 0 ~ 2147483646 | オーバーフロー時の最大値<br>オーバーフロー有効時のスタミナの絶対上限値。<br>オーバーフローでもスタミナはこの値を超えることはできません。isOverflow が true の場合のみ表示されます。<br>例えば initialCapacity が 100、maxCapacity が 200 の場合、アイテムでスタミナを 200 まで増やせますが、自然回復は 100 で停止します。<br>※ isOverflow が true であれば 必須 |
| maxStaminaTable | [MaxStaminaTable](#maxstaminatable) |  |  |  |  | スタミナ最大値テーブル<br>プレイヤーの GS2-Experience ランクに基づいてスタミナ最大値を動的に決定する MaxStaminaTable への参照。<br>設定時、プレイヤーの最大スタミナは現在のランクインデックスでテーブルから参照され、initialCapacity をオーバーライドします。<br>未設定の場合、全プレイヤーが同じ initialCapacity を最大値として共有します。 |
| recoverIntervalTable | [RecoverIntervalTable](#recoverintervaltable) |  |  |  |  | 回復間隔テーブル<br>プレイヤーの GS2-Experience ランクに基づいて回復間隔を動的に決定する RecoverIntervalTable への参照。<br>設定時、プレイヤーの回復間隔は現在のランクインデックスでテーブルから参照され、recoverIntervalMinutes をオーバーライドします。<br>未設定の場合、全プレイヤーが同じ recoverIntervalMinutes を共有します。 |
| recoverValueTable | [RecoverValueTable](#recovervaluetable) |  |  |  |  | 回復量テーブル<br>プレイヤーの GS2-Experience ランクに基づいて回復量を動的に決定する RecoverValueTable への参照。<br>設定時、プレイヤーの回復量は現在のランクインデックスでテーブルから参照され、recoverValue をオーバーライドします。<br>未設定の場合、全プレイヤーが同じ recoverValue を共有します。 |

---

### MaxStaminaTable

スタミナ最大値テーブル<br>

スタミナ最大値テーブルは、GS2-Experience のランクごとにスタミナの最大値を定義するエンティティです。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | スタミナ最大値テーブル名<br>スタミナ最大値テーブル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 128文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| experienceModelId | string |  | ✓ |  |  ~ 1024文字 | 経験値モデルID<br>プレイヤーの現在のランクを参照するために使用する GS2-Experience の ExperienceModel の GRN。<br>ランクインデックスが values リストの配列インデックスとして使用され、ユーザーごとのスタミナ最大値が決定されます。 |
| values | List&lt;int&gt; |  | ✓ |  | 1 ~ 1024 items | ランク毎のスタミナ最大値<br>プレイヤーの GS2-Experience ランクインデックスで索引されるスタミナ最大値の配列。<br>インデックス i の値がランク i のプレイヤーの最大スタミナとして使用されます。配列長は参照先の ExperienceModel で定義されたランク数と一致させる必要があります。 |

---

### RecoverIntervalTable

回復間隔テーブル<br>

回復間隔テーブルは、GS2-Experience のランクごとにスタミナの回復間隔を定義するエンティティです。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | 回復間隔テーブル名<br>回復間隔テーブル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 128文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| experienceModelId | string |  | ✓ |  |  ~ 1024文字 | 経験値モデルID<br>プレイヤーの現在のランクを参照するために使用する GS2-Experience の ExperienceModel の GRN。<br>ランクインデックスが values リストの配列インデックスとして使用され、ユーザーごとの回復間隔が決定されます。 |
| values | List&lt;int&gt; |  | ✓ |  | 1 ~ 1024 items | ランク毎の回復間隔<br>プレイヤーの GS2-Experience ランクインデックスで索引される回復間隔値（分単位）の配列。<br>インデックス i の値がランク i のプレイヤーの回復間隔として使用され、モデルのデフォルト recoverIntervalMinutes をオーバーライドします。 |

---

### RecoverValueTable

スタミナ回復量テーブル<br>

スタミナ回復量テーブルは、GS2-Experience のランクごとにスタミナの回復量を定義するエンティティです。

|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| name | string |  | ✓ |  |  ~ 128文字 | スタミナ回復量テーブル名<br>スタミナ回復量テーブル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| metadata | string |  |  |  |  ~ 128文字 | メタデータ<br>メタデータには任意の値を設定できます。<br>これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。 |
| experienceModelId | string |  | ✓ |  |  ~ 1024文字 | 経験値モデルID<br>プレイヤーの現在のランクを参照するために使用する GS2-Experience の ExperienceModel の GRN。<br>ランクインデックスが values リストの配列インデックスとして使用され、ユーザーごとの回復量が決定されます。 |
| values | List&lt;int&gt; |  | ✓ |  | 1 ~ 1024 items | ランク毎の回復量<br>プレイヤーの GS2-Experience ランクインデックスで索引される回復量値の配列。<br>インデックス i の値がランク i のプレイヤーのティックあたりの回復量として使用され、モデルのデフォルト recoverValue をオーバーライドします。 |

---



