GS2-Stamina Transaction Actions
VerifyAction
Gs2Stamina:VerifyStaminaValueByUserId
Verify the value of the current Stamina by specifying a user ID
Validates that the current stamina value for the specified user meets the specified condition against the given threshold without modifying any state.
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| value | int | ✓ | 0 ~ 2147483646 | Value to be verified | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | true | Whether to multiply the value used for verification when specifying the quantity | |||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:VerifyStaminaValueByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"userId": "[string]User ID",
"staminaName": "[string]Stamina Model Name",
"verifyType": "[string]Type of verification",
"value": "[int]Value to be verified",
"multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:VerifyStaminaValueByUserId
request:
namespaceName: "[string]Namespace name"
userId: "[string]User ID"
staminaName: "[string]Stamina Model Name"
verifyType: "[string]Type of verification"
value: "[int]Value to be verified"
multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").verify.verify_stamina_value_by_user_id({
namespaceName="[string]Namespace name",
userId="[string]User ID",
staminaName="[string]Stamina Model Name",
verifyType="[string]Type of verification",
value="[int]Value to be verified",
multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:VerifyStaminaMaxValueByUserId
Verify the value of the max stamina by specifying a user ID
Validates that the maximum stamina capacity (including buff modifications) for the specified user meets the specified condition against the given threshold without modifying any state.
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| value | int | ✓ | 0 ~ 2147483646 | Value to be verified | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | true | Whether to multiply the value used for verification when specifying the quantity | |||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:VerifyStaminaMaxValueByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"userId": "[string]User ID",
"staminaName": "[string]Stamina Model Name",
"verifyType": "[string]Type of verification",
"value": "[int]Value to be verified",
"multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:VerifyStaminaMaxValueByUserId
request:
namespaceName: "[string]Namespace name"
userId: "[string]User ID"
staminaName: "[string]Stamina Model Name"
verifyType: "[string]Type of verification"
value: "[int]Value to be verified"
multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").verify.verify_stamina_max_value_by_user_id({
namespaceName="[string]Namespace name",
userId="[string]User ID",
staminaName="[string]Stamina Model Name",
verifyType="[string]Type of verification",
value="[int]Value to be verified",
multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId
Verify the value of the recovery interval minutes by specifying a user ID
Validates that the stamina recovery interval (minutes) for the specified user meets the specified condition against the given threshold without modifying any state.
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| value | int | ✓ | 0 ~ 2147483646 | Value to be verified | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | true | Whether to multiply the value used for verification when specifying the quantity | |||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"userId": "[string]User ID",
"staminaName": "[string]Stamina Model Name",
"verifyType": "[string]Type of verification",
"value": "[int]Value to be verified",
"multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId
request:
namespaceName: "[string]Namespace name"
userId: "[string]User ID"
staminaName: "[string]Stamina Model Name"
verifyType: "[string]Type of verification"
value: "[int]Value to be verified"
multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").verify.verify_stamina_recover_interval_minutes_by_user_id({
namespaceName="[string]Namespace name",
userId="[string]User ID",
staminaName="[string]Stamina Model Name",
verifyType="[string]Type of verification",
value="[int]Value to be verified",
multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:VerifyStaminaRecoverValueByUserId
Verify the value of the recovery value by specifying a user ID
Validates that the stamina recovery amount (including buff modifications) for the specified user meets the specified condition against the given threshold without modifying any state.
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| value | int | ✓ | 0 ~ 2147483646 | Value to be verified | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | true | Whether to multiply the value used for verification when specifying the quantity | |||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:VerifyStaminaRecoverValueByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"userId": "[string]User ID",
"staminaName": "[string]Stamina Model Name",
"verifyType": "[string]Type of verification",
"value": "[int]Value to be verified",
"multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:VerifyStaminaRecoverValueByUserId
request:
namespaceName: "[string]Namespace name"
userId: "[string]User ID"
staminaName: "[string]Stamina Model Name"
verifyType: "[string]Type of verification"
value: "[int]Value to be verified"
multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").verify.verify_stamina_recover_value_by_user_id({
namespaceName="[string]Namespace name",
userId="[string]User ID",
staminaName="[string]Stamina Model Name",
verifyType="[string]Type of verification",
value="[int]Value to be verified",
multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:VerifyStaminaOverflowValueByUserId
Verify the value of the overflow value by specifying a user ID
Validates that the stamina overflow amount for the specified user meets the specified condition against the given threshold without modifying any state.
Whether the action allows quantity specification: YES
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||||||||||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||||||||||||||||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||||||||||||||||
| verifyType | String Enum enum { “less”, “lessEqual”, “greater”, “greaterEqual”, “equal”, “notEqual” } | ✓ | Type of verification
| |||||||||||||||||
| value | int | ✓ | 0 ~ 2147483646 | Value to be verified | ||||||||||||||||
| multiplyValueSpecifyingQuantity | bool | true | Whether to multiply the value used for verification when specifying the quantity | |||||||||||||||||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:VerifyStaminaOverflowValueByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"userId": "[string]User ID",
"staminaName": "[string]Stamina Model Name",
"verifyType": "[string]Type of verification",
"value": "[int]Value to be verified",
"multiplyValueSpecifyingQuantity": "[bool]Whether to multiply the value used for verification when specifying the quantity",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:VerifyStaminaOverflowValueByUserId
request:
namespaceName: "[string]Namespace name"
userId: "[string]User ID"
staminaName: "[string]Stamina Model Name"
verifyType: "[string]Type of verification"
value: "[int]Value to be verified"
multiplyValueSpecifyingQuantity: "[bool]Whether to multiply the value used for verification when specifying the quantity"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").verify.verify_stamina_overflow_value_by_user_id({
namespaceName="[string]Namespace name",
userId="[string]User ID",
staminaName="[string]Stamina Model Name",
verifyType="[string]Type of verification",
value="[int]Value to be verified",
multiplyValueSpecifyingQuantity="[bool]Whether to multiply the value used for verification when specifying the quantity",
timeOffsetToken="[string]Time offset token",
})ConsumeAction
Gs2Stamina:DecreaseMaxValueByUserId
Subtract the maximum value of stamina by specifying the user ID
Reduces the maximum stamina capacity by the specified amount for the given user. May be used to apply debuffs or penalties to stamina capacity.
Whether the action allows quantity specification: YES
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| decreaseValue | int | ✓ | 0 ~ 2147483646 | Maximum amount of stamina to be decreased | ||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:DecreaseMaxValueByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"staminaName": "[string]Stamina Model Name",
"userId": "[string]User ID",
"decreaseValue": "[int]Maximum amount of stamina to be decreased",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:DecreaseMaxValueByUserId
request:
namespaceName: "[string]Namespace name"
staminaName: "[string]Stamina Model Name"
userId: "[string]User ID"
decreaseValue: "[int]Maximum amount of stamina to be decreased"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").consume.decrease_max_value_by_user_id({
namespaceName="[string]Namespace name",
staminaName="[string]Stamina Model Name",
userId="[string]User ID",
decreaseValue="[int]Maximum amount of stamina to be decreased",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:ConsumeStaminaByUserId
Consume Stamina by specifying a user ID
Deducts the specified amount from the current stamina value for the given user. Returns an Insufficient error if the current stamina value is less than the consume amount.
Whether the action allows quantity specification: YES
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| consumeValue | int | ✓ | 1 ~ 2147483646 | Amount of stamina consumed | ||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:ConsumeStaminaByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"staminaName": "[string]Stamina Model Name",
"userId": "[string]User ID",
"consumeValue": "[int]Amount of stamina consumed",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:ConsumeStaminaByUserId
request:
namespaceName: "[string]Namespace name"
staminaName: "[string]Stamina Model Name"
userId: "[string]User ID"
consumeValue: "[int]Amount of stamina consumed"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").consume.consume_stamina_by_user_id({
namespaceName="[string]Namespace name",
staminaName="[string]Stamina Model Name",
userId="[string]User ID",
consumeValue="[int]Amount of stamina consumed",
timeOffsetToken="[string]Time offset token",
})AcquireAction
Gs2Stamina:RecoverStaminaByUserId
Recover Stamina by specifying a user ID
Recovers stamina by the specified amount up to the maximum capacity. If the recovery causes the value to exceed the maximum and overflow mode is enabled, the excess is tracked as an overflow value.
Whether the action allows quantity specification: YES
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| recoverValue | int | ✓ | 1 ~ 2147483646 | Amount of stamina recovery | ||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"staminaName": "[string]Stamina Model Name",
"userId": "[string]User ID",
"recoverValue": "[int]Amount of stamina recovery",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:RecoverStaminaByUserId
request:
namespaceName: "[string]Namespace name"
staminaName: "[string]Stamina Model Name"
userId: "[string]User ID"
recoverValue: "[int]Amount of stamina recovery"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").acquire.recover_stamina_by_user_id({
namespaceName="[string]Namespace name",
staminaName="[string]Stamina Model Name",
userId="[string]User ID",
recoverValue="[int]Amount of stamina recovery",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:RaiseMaxValueByUserId
Add the maximum value of stamina by specifying the user ID
Permanently increases the maximum stamina capacity by the specified amount. Used for permanent stat increases such as level-up rewards or item effects.
Whether the action allows quantity specification: YES
Whether the action is reversible: YES
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| raiseValue | int | ✓ | 0 ~ 2147483646 | Maximum amount of stamina to be increased | ||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:RaiseMaxValueByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"staminaName": "[string]Stamina Model Name",
"userId": "[string]User ID",
"raiseValue": "[int]Maximum amount of stamina to be increased",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:RaiseMaxValueByUserId
request:
namespaceName: "[string]Namespace name"
staminaName: "[string]Stamina Model Name"
userId: "[string]User ID"
raiseValue: "[int]Maximum amount of stamina to be increased"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").acquire.raise_max_value_by_user_id({
namespaceName="[string]Namespace name",
staminaName="[string]Stamina Model Name",
userId="[string]User ID",
raiseValue="[int]Maximum amount of stamina to be increased",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:SetMaxValueByUserId
Update the maximum value of stamina by specifying a user ID
Sets the maximum stamina capacity to the specified value. The old stamina state is preserved in the response for audit purposes. Used for administrative overrides or special event adjustments.
Whether the action allows quantity specification: YES
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| maxValue | int | ✓ | 1 ~ 2147483646 | Maximum Stamina The per-user maximum stamina value, resolved from the StaminaModel and optionally overridden by a MaxStaminaTable based on the player’s GS2-Experience rank. When overflow is disabled, this value is floored at initialCapacity. When overflow is enabled, it is capped at maxCapacity. Natural time-based recovery stops at this value. | ||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:SetMaxValueByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"staminaName": "[string]Stamina Model Name",
"userId": "[string]User ID",
"maxValue": "[int]Maximum Stamina",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:SetMaxValueByUserId
request:
namespaceName: "[string]Namespace name"
staminaName: "[string]Stamina Model Name"
userId: "[string]User ID"
maxValue: "[int]Maximum Stamina"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").acquire.set_max_value_by_user_id({
namespaceName="[string]Namespace name",
staminaName="[string]Stamina Model Name",
userId="[string]User ID",
maxValue="[int]Maximum Stamina",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:SetRecoverIntervalByUserId
Update stamina recovery interval (minutes) by specifying a user ID
Sets the stamina recovery interval to the specified value in minutes. The old stamina state is preserved in the response for audit purposes. Controls how frequently the stamina recovers automatically.
Whether the action allows quantity specification: YES
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| recoverIntervalMinutes | int | ✓ | 1 ~ 2147483646 | Stamina recovery interval (minutes) | ||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:SetRecoverIntervalByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"staminaName": "[string]Stamina Model Name",
"userId": "[string]User ID",
"recoverIntervalMinutes": "[int]Stamina recovery interval (minutes)",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:SetRecoverIntervalByUserId
request:
namespaceName: "[string]Namespace name"
staminaName: "[string]Stamina Model Name"
userId: "[string]User ID"
recoverIntervalMinutes: "[int]Stamina recovery interval (minutes)"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").acquire.set_recover_interval_by_user_id({
namespaceName="[string]Namespace name",
staminaName="[string]Stamina Model Name",
userId="[string]User ID",
recoverIntervalMinutes="[int]Stamina recovery interval (minutes)",
timeOffsetToken="[string]Time offset token",
})Gs2Stamina:SetRecoverValueByUserId
Set the amount of stamina recovery by specifying the user ID
Sets the stamina recovery amount to the specified value. The old stamina state is preserved in the response for audit purposes. Controls how much stamina is recovered per recovery interval.
Whether the action allows quantity specification: YES
Whether the action is reversible: NO
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| staminaName | string | ✓ | ~ 128 chars | Stamina Model Name The name of the StaminaModel that defines the recovery parameters, capacity, and table references for this stamina instance. This links the per-user stamina state to its corresponding model definition. | ||
| userId | string | ✓ | ~ 128 chars | User ID Set #{userId} to replace the currently logged in user ID. | ||
| recoverValue | int | ✓ | 1 ~ 2147483646 | Amount of stamina recovery | ||
| timeOffsetToken | string | ~ 1024 chars | Time offset token |
{
"action": "Gs2Stamina:SetRecoverValueByUserId",
"request": {
"namespaceName": "[string]Namespace name",
"staminaName": "[string]Stamina Model Name",
"userId": "[string]User ID",
"recoverValue": "[int]Amount of stamina recovery",
"timeOffsetToken": "[string]Time offset token"
}
}action: Gs2Stamina:SetRecoverValueByUserId
request:
namespaceName: "[string]Namespace name"
staminaName: "[string]Stamina Model Name"
userId: "[string]User ID"
recoverValue: "[int]Amount of stamina recovery"
timeOffsetToken: "[string]Time offset token"transaction.service("stamina").acquire.set_recover_value_by_user_id({
namespaceName="[string]Namespace name",
staminaName="[string]Stamina Model Name",
userId="[string]User ID",
recoverValue="[int]Amount of stamina recovery",
timeOffsetToken="[string]Time offset token",
})