> For the complete documentation index, see [llms.txt](/llms.txt)
# GS2-Stamina トランザクションアクション
検証/消費/入手の各トランザクションアクションの仕様
## Verify Action
検証アクション
### Gs2Stamina:VerifyStaminaValueByUserId
ユーザーIDを指定してスタミナ現在値を検証
指定されたユーザーの現在のスタミナ値が指定された条件を指定された閾値に対して満たすことを、状態を変更せずに検証します。
**数量指定可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| verifyType | 文字列列挙型
enum {
"less",
"lessEqual",
"greater",
"greaterEqual",
"equal",
"notEqual"
}
| | ✓| | | 検証の種類"less": 現在値が指定値未満であること / "lessEqual": 現在値が指定値以下であること / "greater": 現在値が指定値超過であること / "greaterEqual": 現在値が指定値以上であること / "equal": 現在値が指定値と一致すること / "notEqual": 現在値が指定値と一致しないこと / |
| value | int | | ✓| | 0 ~ 2147483646 | 現在値 |
| multiplyValueSpecifyingQuantity | bool | | | true | | 数量指定した際に、検証に使用する値も乗算するか |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:VerifyStaminaValueByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"staminaName": "[string]スタミナモデル名",
"verifyType": "[string]検証の種類",
"value": "[int]現在値",
"multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:VerifyStaminaValueByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
staminaName: "[string]スタミナモデル名"
verifyType: "[string]検証の種類"
value: "[int]現在値"
multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").verify.verify_stamina_value_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
staminaName="[string]スタミナモデル名",
verifyType="[string]検証の種類",
value="[int]現在値",
multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:VerifyStaminaMaxValueByUserId
ユーザーIDを指定してスタミナ最大値を検証
指定されたユーザーのスタミナの最大容量（バフによる変更を含む）が指定された条件を指定された閾値に対して満たすことを、状態を変更せずに検証します。
**数量指定可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| verifyType | 文字列列挙型
enum {
"less",
"lessEqual",
"greater",
"greaterEqual",
"equal",
"notEqual"
}
| | ✓| | | 検証の種類"less": 最大値が指定値未満であること / "lessEqual": 最大値が指定値以下であること / "greater": 最大値が指定値超過であること / "greaterEqual": 最大値が指定値以上であること / "equal": 最大値が指定値と一致すること / "notEqual": 最大値が指定値と一致しないこと / |
| value | int | | ✓| | 0 ~ 2147483646 | 最大値 |
| multiplyValueSpecifyingQuantity | bool | | | true | | 数量指定した際に、検証に使用する値も乗算するか |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:VerifyStaminaMaxValueByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"staminaName": "[string]スタミナモデル名",
"verifyType": "[string]検証の種類",
"value": "[int]最大値",
"multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:VerifyStaminaMaxValueByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
staminaName: "[string]スタミナモデル名"
verifyType: "[string]検証の種類"
value: "[int]最大値"
multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").verify.verify_stamina_max_value_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
staminaName="[string]スタミナモデル名",
verifyType="[string]検証の種類",
value="[int]最大値",
multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId
ユーザーIDを指定してスタミナ回復間隔（分）を検証
指定されたユーザーのスタミナの回復間隔（分）が指定された条件を指定された閾値に対して満たすことを、状態を変更せずに検証します。
**数量指定可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| verifyType | 文字列列挙型
enum {
"less",
"lessEqual",
"greater",
"greaterEqual",
"equal",
"notEqual"
}
| | ✓| | | 検証の種類"less": 回復速度が指定値未満であること / "lessEqual": 回復速度が指定値以下であること / "greater": 回復速度が指定値超過であること / "greaterEqual": 回復速度が指定値以上であること / "equal": 回復速度が指定値と一致すること / "notEqual": 回復速度が指定値と一致しないこと / |
| value | int | | ✓| | 0 ~ 2147483646 | 回復速度 |
| multiplyValueSpecifyingQuantity | bool | | | true | | 数量指定した際に、検証に使用する値も乗算するか |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"staminaName": "[string]スタミナモデル名",
"verifyType": "[string]検証の種類",
"value": "[int]回復速度",
"multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
staminaName: "[string]スタミナモデル名"
verifyType: "[string]検証の種類"
value: "[int]回復速度"
multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").verify.verify_stamina_recover_interval_minutes_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
staminaName="[string]スタミナモデル名",
verifyType="[string]検証の種類",
value="[int]回復速度",
multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:VerifyStaminaRecoverValueByUserId
ユーザーIDを指定してスタミナ回復量を検証
指定されたユーザーのスタミナの回復量（バフによる変更を含む）が指定された条件を指定された閾値に対して満たすことを、状態を変更せずに検証します。
**数量指定可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| verifyType | 文字列列挙型
enum {
"less",
"lessEqual",
"greater",
"greaterEqual",
"equal",
"notEqual"
}
| | ✓| | | 検証の種類"less": 回復量が指定値未満であること / "lessEqual": 回復量が指定値以下であること / "greater": 回復量が指定値超過であること / "greaterEqual": 回復量が指定値以上であること / "equal": 回復量が指定値と一致すること / "notEqual": 回復量が指定値と一致しないこと / |
| value | int | | ✓| | 0 ~ 2147483646 | 回復量 |
| multiplyValueSpecifyingQuantity | bool | | | true | | 数量指定した際に、検証に使用する値も乗算するか |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:VerifyStaminaRecoverValueByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"staminaName": "[string]スタミナモデル名",
"verifyType": "[string]検証の種類",
"value": "[int]回復量",
"multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:VerifyStaminaRecoverValueByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
staminaName: "[string]スタミナモデル名"
verifyType: "[string]検証の種類"
value: "[int]回復量"
multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").verify.verify_stamina_recover_value_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
staminaName="[string]スタミナモデル名",
verifyType="[string]検証の種類",
value="[int]回復量",
multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:VerifyStaminaOverflowValueByUserId
ユーザーIDを指定してスタミナオーバーフロー量を検証
指定されたユーザーのスタミナのオーバーフロー量が指定された条件を指定された閾値に対して満たすことを、状態を変更せずに検証します。
**数量指定可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| verifyType | 文字列列挙型
enum {
"less",
"lessEqual",
"greater",
"greaterEqual",
"equal",
"notEqual"
}
| | ✓| | | 検証の種類"less": オーバーフロー量が指定値未満であること / "lessEqual": オーバーフロー量が指定値以下であること / "greater": オーバーフロー量が指定値超過であること / "greaterEqual": オーバーフロー量が指定値以上であること / "equal": オーバーフロー量が指定値と一致すること / "notEqual": オーバーフロー量が指定値と一致しないこと / |
| value | int | | ✓| | 0 ~ 2147483646 | オーバーフロー量 |
| multiplyValueSpecifyingQuantity | bool | | | true | | 数量指定した際に、検証に使用する値も乗算するか |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:VerifyStaminaOverflowValueByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"userId": "[string]ユーザーID",
"staminaName": "[string]スタミナモデル名",
"verifyType": "[string]検証の種類",
"value": "[int]オーバーフロー量",
"multiplyValueSpecifyingQuantity": "[bool]数量指定した際に、検証に使用する値も乗算するか",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:VerifyStaminaOverflowValueByUserId
request:
namespaceName: "[string]ネームスペース名"
userId: "[string]ユーザーID"
staminaName: "[string]スタミナモデル名"
verifyType: "[string]検証の種類"
value: "[int]オーバーフロー量"
multiplyValueSpecifyingQuantity: "[bool]数量指定した際に、検証に使用する値も乗算するか"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").verify.verify_stamina_overflow_value_by_user_id({
namespaceName="[string]ネームスペース名",
userId="[string]ユーザーID",
staminaName="[string]スタミナモデル名",
verifyType="[string]検証の種類",
value="[int]オーバーフロー量",
multiplyValueSpecifyingQuantity="[bool]数量指定した際に、検証に使用する値も乗算するか",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
## Consume Action
消費アクション
### Gs2Stamina:DecreaseMaxValueByUserId
ユーザーIDを指定してスタミナの最大値の減算
指定されたユーザーのスタミナの最大容量を指定された量だけ減少させます。スタミナ容量へのデバフやペナルティの適用に使用できます。
**数量指定可能なアクション：はい**
**反転可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| decreaseValue | int | | ✓| | 0 ~ 2147483646 | 減算する最大スタミナ量 |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:DecreaseMaxValueByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"staminaName": "[string]スタミナモデル名",
"userId": "[string]ユーザーID",
"decreaseValue": "[int]減算する最大スタミナ量",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:DecreaseMaxValueByUserId
request:
namespaceName: "[string]ネームスペース名"
staminaName: "[string]スタミナモデル名"
userId: "[string]ユーザーID"
decreaseValue: "[int]減算する最大スタミナ量"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").consume.decrease_max_value_by_user_id({
namespaceName="[string]ネームスペース名",
staminaName="[string]スタミナモデル名",
userId="[string]ユーザーID",
decreaseValue="[int]減算する最大スタミナ量",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:ConsumeStaminaByUserId
ユーザーIDを指定してスタミナを消費
指定されたユーザーの現在のスタミナ値から指定された量を差し引きます。現在のスタミナ値が消費量未満の場合、Insufficientエラーを返します。
**数量指定可能なアクション：はい**
**反転可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| consumeValue | int | | ✓| | 1 ~ 2147483646 | 消費するスタミナ量 |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:ConsumeStaminaByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"staminaName": "[string]スタミナモデル名",
"userId": "[string]ユーザーID",
"consumeValue": "[int]消費するスタミナ量",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:ConsumeStaminaByUserId
request:
namespaceName: "[string]ネームスペース名"
staminaName: "[string]スタミナモデル名"
userId: "[string]ユーザーID"
consumeValue: "[int]消費するスタミナ量"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").consume.consume_stamina_by_user_id({
namespaceName="[string]ネームスペース名",
staminaName="[string]スタミナモデル名",
userId="[string]ユーザーID",
consumeValue="[int]消費するスタミナ量",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
## Acquire Action
入手アクション
### Gs2Stamina:RecoverStaminaByUserId
ユーザーIDを指定してスタミナを回復
指定された量のスタミナを最大容量まで回復します。回復により値が最大値を超え、オーバーフローモードが有効な場合、超過分はオーバーフロー値として記録されます。
**数量指定可能なアクション：はい**
**反転可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| recoverValue | int | | ✓| | 1 ~ 2147483646 | スタミナの回復量 |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"staminaName": "[string]スタミナモデル名",
"userId": "[string]ユーザーID",
"recoverValue": "[int]スタミナの回復量",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:RecoverStaminaByUserId
request:
namespaceName: "[string]ネームスペース名"
staminaName: "[string]スタミナモデル名"
userId: "[string]ユーザーID"
recoverValue: "[int]スタミナの回復量"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").acquire.recover_stamina_by_user_id({
namespaceName="[string]ネームスペース名",
staminaName="[string]スタミナモデル名",
userId="[string]ユーザーID",
recoverValue="[int]スタミナの回復量",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:RaiseMaxValueByUserId
ユーザーIDを指定してスタミナの最大値を加算
指定された量だけスタミナの最大容量を恒久的に増加させます。レベルアップ報酬やアイテム効果などの恒久的なステータス上昇に使用されます。
**数量指定可能なアクション：はい**
**反転可能なアクション：はい**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| raiseValue | int | | ✓| | 0 ~ 2147483646 | 上昇する最大スタミナ量 |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:RaiseMaxValueByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"staminaName": "[string]スタミナモデル名",
"userId": "[string]ユーザーID",
"raiseValue": "[int]上昇する最大スタミナ量",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:RaiseMaxValueByUserId
request:
namespaceName: "[string]ネームスペース名"
staminaName: "[string]スタミナモデル名"
userId: "[string]ユーザーID"
raiseValue: "[int]上昇する最大スタミナ量"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").acquire.raise_max_value_by_user_id({
namespaceName="[string]ネームスペース名",
staminaName="[string]スタミナモデル名",
userId="[string]ユーザーID",
raiseValue="[int]上昇する最大スタミナ量",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:SetMaxValueByUserId
ユーザーIDを指定してスタミナの最大値を更新
スタミナの最大容量を指定された値に設定します。監査目的で変更前のスタミナ状態がレスポンスに保持されます。管理者によるオーバーライドや特別イベントでの調整に使用されます。
**数量指定可能なアクション：はい**
**反転可能なアクション：いいえ**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| maxValue | int | | ✓| | 1 ~ 2147483646 | スタミナの最大値
StaminaModel から解決され、オプションでプレイヤーの GS2-Experience ランクに基づく MaxStaminaTable でオーバーライドされるユーザーごとのスタミナ最大値。
オーバーフロー無効時は initialCapacity が下限となります。オーバーフロー有効時は maxCapacity が上限となります。
自然回復はこの値で停止します。 |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:SetMaxValueByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"staminaName": "[string]スタミナモデル名",
"userId": "[string]ユーザーID",
"maxValue": "[int]スタミナの最大値",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:SetMaxValueByUserId
request:
namespaceName: "[string]ネームスペース名"
staminaName: "[string]スタミナモデル名"
userId: "[string]ユーザーID"
maxValue: "[int]スタミナの最大値"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").acquire.set_max_value_by_user_id({
namespaceName="[string]ネームスペース名",
staminaName="[string]スタミナモデル名",
userId="[string]ユーザーID",
maxValue="[int]スタミナの最大値",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:SetRecoverIntervalByUserId
ユーザーIDを指定してスタミナの回復間隔(分)を更新
スタミナの回復間隔を指定された値（分）に設定します。監査目的で変更前のスタミナ状態がレスポンスに保持されます。スタミナが自動的に回復する頻度を制御します。
**数量指定可能なアクション：はい**
**反転可能なアクション：いいえ**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| recoverIntervalMinutes | int | | ✓| | 1 ~ 2147483646 | スタミナの回復間隔(分) |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:SetRecoverIntervalByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"staminaName": "[string]スタミナモデル名",
"userId": "[string]ユーザーID",
"recoverIntervalMinutes": "[int]スタミナの回復間隔(分)",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:SetRecoverIntervalByUserId
request:
namespaceName: "[string]ネームスペース名"
staminaName: "[string]スタミナモデル名"
userId: "[string]ユーザーID"
recoverIntervalMinutes: "[int]スタミナの回復間隔(分)"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").acquire.set_recover_interval_by_user_id({
namespaceName="[string]ネームスペース名",
staminaName="[string]スタミナモデル名",
userId="[string]ユーザーID",
recoverIntervalMinutes="[int]スタミナの回復間隔(分)",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---
### Gs2Stamina:SetRecoverValueByUserId
ユーザーIDを指定してスタミナの回復量を設定
スタミナの回復量を指定された値に設定します。監査目的で変更前のスタミナ状態がレスポンスに保持されます。回復間隔ごとに回復するスタミナ量を制御します。
**数量指定可能なアクション：はい**
**反転可能なアクション：いいえ**
| | 型 | 有効化条件 | 必須 | デフォルト | 値の制限 | 説明 |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128文字 | ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。 |
| staminaName | string | | ✓| | ~ 128文字 | スタミナモデル名
このスタミナインスタンスの回復パラメータ、容量、テーブル参照を定義する StaminaModel の名前。
ユーザーごとのスタミナ状態を対応するモデル定義に紐づけます。 |
| userId | string | | ✓| | ~ 128文字 | ユーザーID
`#{userId}` と設定することでログイン中のユーザーIDに置換されます。 |
| recoverValue | int | | ✓| | 1 ~ 2147483646 | スタミナの回復量 |
| timeOffsetToken | string | | | | ~ 1024文字 | タイムオフセットトークン |
**JSON**
```json
{
"action": "Gs2Stamina:SetRecoverValueByUserId",
"request": {
"namespaceName": "[string]ネームスペース名",
"staminaName": "[string]スタミナモデル名",
"userId": "[string]ユーザーID",
"recoverValue": "[int]スタミナの回復量",
"timeOffsetToken": "[string]タイムオフセットトークン"
}
}
```
**YAML**
```yaml
action: Gs2Stamina:SetRecoverValueByUserId
request:
namespaceName: "[string]ネームスペース名"
staminaName: "[string]スタミナモデル名"
userId: "[string]ユーザーID"
recoverValue: "[int]スタミナの回復量"
timeOffsetToken: "[string]タイムオフセットトークン"
```
**GS2-Script**
```lua
transaction.service("stamina").acquire.set_recover_value_by_user_id({
namespaceName="[string]ネームスペース名",
staminaName="[string]スタミナモデル名",
userId="[string]ユーザーID",
recoverValue="[int]スタミナの回復量",
timeOffsetToken="[string]タイムオフセットトークン",
})
```
---