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

# GS2-Stamina Buff リファレンス

GS2-Buff でバフを適用する際に指定する、パラメータの補正が可能なモデル/アクション内のフィールドと、その適用範囲の設定について




{{% alert title="Note" color="info" %}}
バフエントリーモデルの詳細については [BuffEntryModel](api_reference/buff/master_data/#buffentrymodel) をご参照ください。
{{% /alert %}}

## Models
バフを適用可能なモデルの種類

### Gs2Stamina:Stamina
スタミナ


#### バフの適用対象フィールド

##### maxValue


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| maxValue | int |  | ✓|  | 1 ~ 2147483646 | スタミナの最大値<br>StaminaModel から解決され、オプションでプレイヤーの GS2-Experience ランクに基づく MaxStaminaTable でオーバーライドされるユーザーごとのスタミナ最大値。<br>オーバーフロー無効時は initialCapacity が下限となります。オーバーフロー有効時は maxCapacity が上限となります。<br>自然回復はこの値で停止します。 |


##### マスターデータ記述例

`rate` には、対象フィールドに対する補正レートを指定します。


**JSON**
```json
"targetModel": {
    "targetModelName": "Gs2Stamina:Stamina",
    "targetFieldName": "maxValue",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```



#### バフの適用条件モデル

##### Gs2Stamina:StaminaModel


スタミナモデル


##### マスターデータ記述例


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Stamina:StaminaModel",
        "targetGrn": "grn:gs2:any:any:stamina:{namespaceName}:model:{staminaName}"
    }
]
```


---
##### recoverIntervalMinutes


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| recoverIntervalMinutes | int |  | |  | 1 ~ 2147483646 | スタミナの回復間隔（分）<br>StaminaModel から解決され、オプションでプレイヤーの GS2-Experience ランクに基づく RecoverIntervalTable でオーバーライドされるユーザーごとの回復間隔（分）。<br>テーブルが設定されていない場合、モデルのデフォルト recoverIntervalMinutes にフォールバックします。 |


##### マスターデータ記述例

`rate` には、対象フィールドに対する補正レートを指定します。


**JSON**
```json
"targetModel": {
    "targetModelName": "Gs2Stamina:Stamina",
    "targetFieldName": "recoverIntervalMinutes",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```



#### バフの適用条件モデル

##### Gs2Stamina:StaminaModel


スタミナモデル


##### マスターデータ記述例


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Stamina:StaminaModel",
        "targetGrn": "grn:gs2:any:any:stamina:{namespaceName}:model:{staminaName}"
    }
]
```


---
##### recoverValue


|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| recoverValue | int |  | |  | 1 ~ 2147483646 | スタミナの回復量<br>StaminaModel から解決され、オプションでプレイヤーの GS2-Experience ランクに基づく RecoverValueTable でオーバーライドされるユーザーごとのティックあたりの回復量。<br>テーブルが設定されていない場合、モデルのデフォルト recoverValue にフォールバックします。 |


##### マスターデータ記述例

`rate` には、対象フィールドに対する補正レートを指定します。


**JSON**
```json
"targetModel": {
    "targetModelName": "Gs2Stamina:Stamina",
    "targetFieldName": "recoverValue",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```



#### バフの適用条件モデル

##### Gs2Stamina:StaminaModel


スタミナモデル


##### マスターデータ記述例


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Stamina:StaminaModel",
        "targetGrn": "grn:gs2:any:any:stamina:{namespaceName}:model:{staminaName}"
    }
]
```


---
## Action
バフを適用可能なアクションの種類

### Gs2Stamina:ConsumeStamina
スタミナを消費<br>

現在のスタミナ値から指定された量を差し引きます。現在のスタミナ値が消費量未満の場合、Insufficientエラーを返します。


#### バフの適用対象フィールド

##### consumeValue


[Stamina - スタミナ](../sdk#stamina)



|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| consumeValue | int |  | ✓|  | 1 ~ 2147483646 | 消費するスタミナ量 |


##### マスターデータ記述例



**JSON**
```json
"targetAction": {
    "targetActionName": "Gs2Stamina:ConsumeStamina",
    "targetFieldName": "consumeValue",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```

#### バフの適用条件モデル

##### Gs2Stamina:StaminaModel


スタミナモデル


##### マスターデータ記述例


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Stamina:StaminaModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:stamina:{namespaceName}:model:{staminaName}"
    }
]
```



---

### Gs2Stamina:ConsumeStaminaByUserId
ユーザーIDを指定してスタミナを消費<br>

指定されたユーザーの現在のスタミナ値から指定された量を差し引きます。現在のスタミナ値が消費量未満の場合、Insufficientエラーを返します。


#### バフの適用対象フィールド

##### consumeValue


[Stamina - スタミナ](../sdk#stamina)



|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| consumeValue | int |  | ✓|  | 1 ~ 2147483646 | 消費するスタミナ量 |


##### マスターデータ記述例



**JSON**
```json
"targetAction": {
    "targetActionName": "Gs2Stamina:ConsumeStaminaByUserId",
    "targetFieldName": "consumeValue",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```

#### バフの適用条件モデル

##### Gs2Stamina:StaminaModel


スタミナモデル


##### マスターデータ記述例


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Stamina:StaminaModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:stamina:{namespaceName}:model:{staminaName}"
    }
]
```



---

### Gs2Stamina:RecoverStaminaByUserId
ユーザーIDを指定してスタミナを回復<br>

指定された量のスタミナを最大容量まで回復します。回復により値が最大値を超え、オーバーフローモードが有効な場合、超過分はオーバーフロー値として記録されます。


#### バフの適用対象フィールド

##### recoverValue


[Stamina - スタミナ](../sdk#stamina)



|  | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| recoverValue | int |  | ✓|  | 1 ~ 2147483646 | スタミナの回復量 |


##### マスターデータ記述例



**JSON**
```json
"targetAction": {
    "targetActionName": "Gs2Stamina:RecoverStaminaByUserId",
    "targetFieldName": "recoverValue",
    "conditionGrns": [
    ],
    "rate": 1.0
}
```

#### バフの適用条件モデル

##### Gs2Stamina:StaminaModel


スタミナモデル


##### マスターデータ記述例


**JSON**
```json
"conditionGrns": [
    {
        "targetModelName": "Gs2Stamina:StaminaModel",
        "targetGrn": "grn:gs2:{region}:{ownerId}:stamina:{namespaceName}:model:{staminaName}"
    }
]
```



---