GS2-Stamina Deploy/CDK Reference
The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
Entities
Resources managed by the Deploy operation
Namespace
Namespace
A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts. Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the namespace differs, the data is treated as a completely independent data space.
Therefore, you must create a namespace before you can start using each service.
Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ |
~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
||
| description | string | ~ 1024 chars | Description | |||
| transactionSetting | TransactionSetting | Transaction Setting Configuration for controlling how transactions are processed when executing stamina operations. |
||||
| overflowTriggerScript | string | ~ 1024 chars | Overflow Trigger Script GRN of a GS2-Script to invoke when stamina overflows during recovery. This script is triggered when time-based recovery would push stamina above the maximum value, allowing custom handling of the excess (e.g., converting overflow to items). Script Trigger Reference - overflow |
|||
| logSetting | LogSetting | Log Output Setting Configuration for logging stamina-related operations such as consume, recover, and overflow events to GS2-Log. |
GetAttr
Resource creation results that can be retrieved using the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Namespace created |
Implementation Example
Type: GS2::Stamina::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting: null
OverflowTriggerScript: grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/stamina"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
stamina.NewNamespace(
&SampleStack,
"namespace-0001",
stamina.NamespaceOptions{
OverflowTriggerScript: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script"),
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(SampleStack.Yaml()) // Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Stamina\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Stamina\Model\Options\NamespaceOptions(
overflowTriggerScript: "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script",
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
)
);
}
}
print((new SampleStack())->yaml()); // Generate Templateclass SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.stamina.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.stamina.model.options.NamespaceOptions()
.withOverflowTriggerScript("grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script")
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Stamina.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Stamina.Model.Options.NamespaceOptions
{
overflowTriggerScript = "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script",
logSetting = new Gs2Cdk.Core.Model.LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import stamina from "@/gs2cdk/stamina";
class SampleStack extends core.Stack
{
public constructor() {
super();
new stamina.model.Namespace(
this,
"namespace-0001",
{
overflowTriggerScript: "grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script",
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Templatefrom gs2_cdk import Stack, core, stamina
class SampleStack(Stack):
def __init__(self):
super().__init__()
stamina.Namespace(
stack=self,
name='namespace-0001',
options=stamina.NamespaceOptions(
overflow_trigger_script='grn:gs2:ap-northeast-1:YourOwnerId:script:namespace-0001:script:script',
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate TemplateTransactionSetting
Transaction Setting
Transaction Setting controls execution methods, consistency, asynchronous processing, and conflict avoidance mechanisms of transactions. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous processing of Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| enableAutoRun | bool | false | Whether to automatically execute issued transactions on the server side | |||
| enableAtomicCommit | bool | {enableAutoRun} == true | false | Whether to commit the execution of transactions atomically * Enabled only if enableAutoRun is true |
||
| transactionUseDistributor | bool | {enableAtomicCommit} == true | false | Whether to execute transactions asynchronously * Enabled only if enableAtomicCommit is true |
||
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | false | Whether to execute the commit processing of the script result asynchronously * Enabled only if transactionUseDistributor is true |
||
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | false | Whether to use GS2-JobQueue to execute the acquire action * Enabled only if enableAtomicCommit is true |
||
| distributorNamespaceId | string | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor Namespace GRN used to execute transactions | ||
| queueNamespaceId | string | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute transactions |
LogSetting
Log Output Setting
Log Output Setting defines how log data is exported. This type holds the GS2-Log namespace identifier (Namespace ID), which is used to export log data. Specify the GS2-Log namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId). Configuring this setting ensures that log data for API requests and responses occurring within the specified namespace is output to the target GS2-Log namespace. GS2-Log provides real-time logs that can be used for system monitoring, analysis, debugging, and other operational purposes.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ |
~ 1024 chars | GS2-Log namespace
GRN
to output logs Must be specified in GRN format starting with “grn:gs2:”. |
CurrentStaminaMaster
Currently active Stamina Model master data
This master data defines the Stamina Models currently active within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data are updated on the server.
To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for game operations and export JSON files in the appropriate format.
Note
Please refer to GS2-Stamina Master Data Reference for the JSON file format.Request
Resource creation and update requests
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ |
~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
||||||||
| mode | string (enum) enum { “direct”, “preUpload” } |
“direct” | Update mode
|
|||||||||
| settings | string | {mode} == “direct” | ✓* |
~ 5242880 chars | Master Data * Required if mode is “direct” |
|||||||
| uploadToken | string | {mode} == “preUpload” | ✓* |
~ 1024 chars | Token obtained by pre-upload Used to apply the uploaded master data. * Required if mode is “preUpload” |
GetAttr
Resource creation results that can be retrieved using the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentStaminaMaster | Updated master data of the currently active Stamina Models |
Implementation Example
Type: GS2::Stamina::CurrentStaminaMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2019-02-14",
"staminaModels": [
{
"name": "quest",
"recoverIntervalMinutes": 15,
"recoverValue": 1,
"initialCapacity": 50,
"isOverflow": true,
"metadata": "QUEST",
"maxCapacity": 999,
"maxStaminaTable":
{
"name": "playerLevel",
"metadata": "PLAYER_LEVEL",
"experienceModelId": "playerLevel",
"values": [
51,
52,
53,
54,
55
]
},
"recoverIntervalTable":
{
"name": "staminaRecoverInterval",
"metadata": "STAMINA_RECOVER_INTERVAL",
"experienceModelId": "playerLevel",
"values": [
41,
42,
43,
44,
45
]
},
"recoverValueTable":
{
"name": "staminaRecoverValue",
"metadata": "STAMINA_RECOVER_VALUE",
"experienceModelId": "playerLevel",
"values": [
31,
32,
33,
34,
35
]
}
},
{
"name": "raidBattle",
"recoverIntervalMinutes": 60,
"recoverValue": 1,
"initialCapacity": 10,
"isOverflow": false,
"metadata": "RAID_BATTLE"
},
{
"name": "special",
"recoverIntervalMinutes": 30,
"recoverValue": 3,
"initialCapacity": 100,
"isOverflow": true,
"metadata": "SPECIAL",
"maxCapacity": 999,
"maxStaminaTable":
{
"name": "special",
"metadata": "SPECIAL",
"experienceModelId": "special",
"values": [
102,
104,
106,
108,
110
]
}
}
]
}
UploadToken: nullimport (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/stamina"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
stamina.NewNamespace(
&SampleStack,
"namespace-0001",
stamina.NamespaceOptions{},
).MasterData(
[]stamina.StaminaModel{
stamina.NewStaminaModel(
"quest",
15,
1,
50,
true,
stamina.StaminaModelOptions{
Metadata: pointy.String("QUEST"),
MaxCapacity: pointy.Int32(999),
MaxStaminaTable: &stamina.MaxStaminaTable{
Name: "playerLevel",
ExperienceModelId: "playerLevel",
Values: []int32{
51,
52,
53,
54,
55,
},
Metadata: pointy.String("PLAYER_LEVEL"),
},
RecoverIntervalTable: &stamina.RecoverIntervalTable{
Name: "staminaRecoverInterval",
ExperienceModelId: "playerLevel",
Values: []int32{
41,
42,
43,
44,
45,
},
Metadata: pointy.String("STAMINA_RECOVER_INTERVAL"),
},
RecoverValueTable: &stamina.RecoverValueTable{
Name: "staminaRecoverValue",
ExperienceModelId: "playerLevel",
Values: []int32{
31,
32,
33,
34,
35,
},
Metadata: pointy.String("STAMINA_RECOVER_VALUE"),
},
},
),
stamina.NewStaminaModel(
"raidBattle",
60,
1,
10,
false,
stamina.StaminaModelOptions{
Metadata: pointy.String("RAID_BATTLE"),
},
),
stamina.NewStaminaModel(
"special",
30,
3,
100,
true,
stamina.StaminaModelOptions{
Metadata: pointy.String("SPECIAL"),
MaxCapacity: pointy.Int32(999),
MaxStaminaTable: &stamina.MaxStaminaTable{
Name: "special",
ExperienceModelId: "special",
Values: []int32{
102,
104,
106,
108,
110,
},
Metadata: pointy.String("SPECIAL"),
},
},
),
},
)
println(SampleStack.Yaml()) // Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Stamina\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\Stamina\Model\StaminaModel(
name:"quest",
recoverIntervalMinutes:15,
recoverValue:1,
initialCapacity:50,
isOverflow:true,
options: new \Gs2Cdk\Stamina\Model\Options\StaminaModelOptions(
metadata:"QUEST",
maxCapacity:999,
maxStaminaTable:new \Gs2Cdk\Stamina\Model\MaxStaminaTable(
name: "playerLevel",
experienceModelId: "playerLevel",
values: [
51,
52,
53,
54,
55,
],
options: new \Gs2Cdk\Stamina\Model\Options\MaxStaminaTableOptions(
metadata: "PLAYER_LEVEL",
),
),
recoverIntervalTable:new \Gs2Cdk\Stamina\Model\RecoverIntervalTable(
name: "staminaRecoverInterval",
experienceModelId: "playerLevel",
values: [
41,
42,
43,
44,
45,
],
options: new \Gs2Cdk\Stamina\Model\Options\RecoverIntervalTableOptions(
metadata: "STAMINA_RECOVER_INTERVAL",
),
),
recoverValueTable:new \Gs2Cdk\Stamina\Model\RecoverValueTable(
name: "staminaRecoverValue",
experienceModelId: "playerLevel",
values: [
31,
32,
33,
34,
35,
],
options: new \Gs2Cdk\Stamina\Model\Options\RecoverValueTableOptions(
metadata: "STAMINA_RECOVER_VALUE",
),
)
)
),
new \Gs2Cdk\Stamina\Model\StaminaModel(
name:"raidBattle",
recoverIntervalMinutes:60,
recoverValue:1,
initialCapacity:10,
isOverflow:false,
options: new \Gs2Cdk\Stamina\Model\Options\StaminaModelOptions(
metadata:"RAID_BATTLE"
)
),
new \Gs2Cdk\Stamina\Model\StaminaModel(
name:"special",
recoverIntervalMinutes:30,
recoverValue:3,
initialCapacity:100,
isOverflow:true,
options: new \Gs2Cdk\Stamina\Model\Options\StaminaModelOptions(
metadata:"SPECIAL",
maxCapacity:999,
maxStaminaTable:new \Gs2Cdk\Stamina\Model\MaxStaminaTable(
name: "special",
experienceModelId: "special",
values: [
102,
104,
106,
108,
110,
],
options: new \Gs2Cdk\Stamina\Model\Options\MaxStaminaTableOptions(
metadata: "SPECIAL",
),
)
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Templateclass SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.stamina.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.stamina.model.StaminaModel(
"quest",
15,
1,
50,
true,
new io.gs2.cdk.stamina.model.options.StaminaModelOptions()
.withMetadata("QUEST")
.withMaxCapacity(999)
.withMaxStaminaTable(new io.gs2.cdk.stamina.model.MaxStaminaTable(
"playerLevel",
"playerLevel",
Arrays.asList(
51,
52,
53,
54,
55
),
new io.gs2.cdk.stamina.model.options.MaxStaminaTableOptions()
.withMetadata("PLAYER_LEVEL")
))
.withRecoverIntervalTable(new io.gs2.cdk.stamina.model.RecoverIntervalTable(
"staminaRecoverInterval",
"playerLevel",
Arrays.asList(
41,
42,
43,
44,
45
),
new io.gs2.cdk.stamina.model.options.RecoverIntervalTableOptions()
.withMetadata("STAMINA_RECOVER_INTERVAL")
))
.withRecoverValueTable(new io.gs2.cdk.stamina.model.RecoverValueTable(
"staminaRecoverValue",
"playerLevel",
Arrays.asList(
31,
32,
33,
34,
35
),
new io.gs2.cdk.stamina.model.options.RecoverValueTableOptions()
.withMetadata("STAMINA_RECOVER_VALUE")
))
),
new io.gs2.cdk.stamina.model.StaminaModel(
"raidBattle",
60,
1,
10,
false,
new io.gs2.cdk.stamina.model.options.StaminaModelOptions()
.withMetadata("RAID_BATTLE")
),
new io.gs2.cdk.stamina.model.StaminaModel(
"special",
30,
3,
100,
true,
new io.gs2.cdk.stamina.model.options.StaminaModelOptions()
.withMetadata("SPECIAL")
.withMaxCapacity(999)
.withMaxStaminaTable(new io.gs2.cdk.stamina.model.MaxStaminaTable(
"special",
"special",
Arrays.asList(
102,
104,
106,
108,
110
),
new io.gs2.cdk.stamina.model.options.MaxStaminaTableOptions()
.withMetadata("SPECIAL")
))
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Stamina.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Stamina.Model.StaminaModel[] {
new Gs2Cdk.Gs2Stamina.Model.StaminaModel(
name: "quest",
recoverIntervalMinutes: 15,
recoverValue: 1,
initialCapacity: 50,
isOverflow: true,
options: new Gs2Cdk.Gs2Stamina.Model.Options.StaminaModelOptions
{
metadata = "QUEST",
maxCapacity = 999,
maxStaminaTable = new Gs2Cdk.Gs2Stamina.Model.MaxStaminaTable(
name: "playerLevel",
experienceModelId: "playerLevel",
values: new int[]
{
51,
52,
53,
54,
55,
},
options: new Gs2Cdk.Gs2Stamina.Model.Options.MaxStaminaTableOptions
{
metadata = "PLAYER_LEVEL"
}
),
recoverIntervalTable = new Gs2Cdk.Gs2Stamina.Model.RecoverIntervalTable(
name: "staminaRecoverInterval",
experienceModelId: "playerLevel",
values: new int[]
{
41,
42,
43,
44,
45,
},
options: new Gs2Cdk.Gs2Stamina.Model.Options.RecoverIntervalTableOptions
{
metadata = "STAMINA_RECOVER_INTERVAL"
}
),
recoverValueTable = new Gs2Cdk.Gs2Stamina.Model.RecoverValueTable(
name: "staminaRecoverValue",
experienceModelId: "playerLevel",
values: new int[]
{
31,
32,
33,
34,
35,
},
options: new Gs2Cdk.Gs2Stamina.Model.Options.RecoverValueTableOptions
{
metadata = "STAMINA_RECOVER_VALUE"
}
)
}
),
new Gs2Cdk.Gs2Stamina.Model.StaminaModel(
name: "raidBattle",
recoverIntervalMinutes: 60,
recoverValue: 1,
initialCapacity: 10,
isOverflow: false,
options: new Gs2Cdk.Gs2Stamina.Model.Options.StaminaModelOptions
{
metadata = "RAID_BATTLE"
}
),
new Gs2Cdk.Gs2Stamina.Model.StaminaModel(
name: "special",
recoverIntervalMinutes: 30,
recoverValue: 3,
initialCapacity: 100,
isOverflow: true,
options: new Gs2Cdk.Gs2Stamina.Model.Options.StaminaModelOptions
{
metadata = "SPECIAL",
maxCapacity = 999,
maxStaminaTable = new Gs2Cdk.Gs2Stamina.Model.MaxStaminaTable(
name: "special",
experienceModelId: "special",
values: new int[]
{
102,
104,
106,
108,
110,
},
options: new Gs2Cdk.Gs2Stamina.Model.Options.MaxStaminaTableOptions
{
metadata = "SPECIAL"
}
)
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport core from "@/gs2cdk/core";
import stamina from "@/gs2cdk/stamina";
class SampleStack extends core.Stack
{
public constructor() {
super();
new stamina.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new stamina.model.StaminaModel(
"quest",
15,
1,
50,
true,
{
metadata: "QUEST",
maxCapacity: 999,
maxStaminaTable: new stamina.model.MaxStaminaTable(
"playerLevel",
"playerLevel",
[
51,
52,
53,
54,
55,
],
{
metadata: "PLAYER_LEVEL"
}
),
recoverIntervalTable: new stamina.model.RecoverIntervalTable(
"staminaRecoverInterval",
"playerLevel",
[
41,
42,
43,
44,
45,
],
{
metadata: "STAMINA_RECOVER_INTERVAL"
}
),
recoverValueTable: new stamina.model.RecoverValueTable(
"staminaRecoverValue",
"playerLevel",
[
31,
32,
33,
34,
35,
],
{
metadata: "STAMINA_RECOVER_VALUE"
}
)
}
),
new stamina.model.StaminaModel(
"raidBattle",
60,
1,
10,
false,
{
metadata: "RAID_BATTLE"
}
),
new stamina.model.StaminaModel(
"special",
30,
3,
100,
true,
{
metadata: "SPECIAL",
maxCapacity: 999,
maxStaminaTable: new stamina.model.MaxStaminaTable(
"special",
"special",
[
102,
104,
106,
108,
110,
],
{
metadata: "SPECIAL"
}
)
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Templatefrom gs2_cdk import Stack, core, stamina
class SampleStack(Stack):
def __init__(self):
super().__init__()
stamina.Namespace(
stack=self,
name="namespace-0001",
).master_data(
stamina_models=[
stamina.StaminaModel(
name='quest',
recover_interval_minutes=15,
recover_value=1,
initial_capacity=50,
is_overflow=True,
options=stamina.StaminaModelOptions(
metadata = 'QUEST',
max_capacity = 999,
max_stamina_table = stamina.MaxStaminaTable(
name='playerLevel',
experience_model_id='playerLevel',
values=[
51,
52,
53,
54,
55,
],
options=stamina.MaxStaminaTableOptions(
metadata='PLAYER_LEVEL',
),
),
recover_interval_table = stamina.RecoverIntervalTable(
name='staminaRecoverInterval',
experience_model_id='playerLevel',
values=[
41,
42,
43,
44,
45,
],
options=stamina.RecoverIntervalTableOptions(
metadata='STAMINA_RECOVER_INTERVAL',
),
),
recover_value_table = stamina.RecoverValueTable(
name='staminaRecoverValue',
experience_model_id='playerLevel',
values=[
31,
32,
33,
34,
35,
],
options=stamina.RecoverValueTableOptions(
metadata='STAMINA_RECOVER_VALUE',
),
)
),
),
stamina.StaminaModel(
name='raidBattle',
recover_interval_minutes=60,
recover_value=1,
initial_capacity=10,
is_overflow=False,
options=stamina.StaminaModelOptions(
metadata = 'RAID_BATTLE'
),
),
stamina.StaminaModel(
name='special',
recover_interval_minutes=30,
recover_value=3,
initial_capacity=100,
is_overflow=True,
options=stamina.StaminaModelOptions(
metadata = 'SPECIAL',
max_capacity = 999,
max_stamina_table = stamina.MaxStaminaTable(
name='special',
experience_model_id='special',
values=[
102,
104,
106,
108,
110,
],
options=stamina.MaxStaminaTableOptions(
metadata='SPECIAL',
),
)
),
),
],
)
print(SampleStack().yaml()) # Generate TemplateStaminaModel
Stamina Model
Parameters such as the maximum value of stamina, recovery interval, and amount of recovery can be defined. You can also control the maximum value and the amount of recovery in conjunction with GS2-Experience.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| staminaModelId | string | * |
~ 1024 chars | Stamina Model
GRN
* Set automatically by the server |
||
| name | string | ✓ |
~ 128 chars | Stamina Model name Stamina Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
||
| metadata | string | ~ 128 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
|||
| recoverIntervalMinutes | int | ✓ |
0 ~ 2147483646 | Recover Interval Minutes The number of minutes between each stamina recovery tick. Every time this interval elapses, the player’s stamina increases by the recover value amount. Can be overridden per-user via GS2-Experience rank using a RecoverIntervalTable. Set to 0 to disable automatic time-based recovery. |
||
| recoverValue | int | 1 | 0 ~ 2147483646 | Recover Value The amount of stamina recovered per recovery tick. Each time the recover interval elapses, stamina increases by this value until the maximum is reached. Can be overridden per-user via GS2-Experience rank using a RecoverValueTable. Defaults to 1. |
||
| initialCapacity | int | ✓ |
0 ~ 2147483646 | Initial Capacity The default maximum stamina value for all players. When overflow is disabled, this serves as the floor for the per-user maximum value. Can be overridden per-user via GS2-Experience rank using a MaxStaminaTable. |
||
| isOverflow | bool | ✓ |
Is Overflow Whether stamina can exceed the initial capacity through means such as item usage. When enabled, stamina can be set above initialCapacity up to maxCapacity. Natural time-based recovery still caps at the normal maximum. When disabled, the per-user maximum value is clamped to at least initialCapacity. |
|||
| maxCapacity | int | {isOverflow} == true | ✓* |
0 ~ 2147483646 | Max Capacity The absolute upper limit of stamina when overflow is enabled. Even with overflow, stamina cannot exceed this value. Only shown when isOverflow is true. For example, if initialCapacity is 100 and maxCapacity is 200, items can boost stamina up to 200 but natural recovery stops at 100. * Required if isOverflow is true |
|
| maxStaminaTable | MaxStaminaTable | Max Stamina Table Reference to a MaxStaminaTable that dynamically determines the maximum stamina value based on the player’s GS2-Experience rank. When set, the player’s max stamina is looked up from the table using their current rank index, overriding initialCapacity. If not set, all players share the same initialCapacity as their maximum. |
||||
| recoverIntervalTable | RecoverIntervalTable | Recover Interval Table Reference to a RecoverIntervalTable that dynamically determines the recovery interval based on the player’s GS2-Experience rank. When set, the player’s recovery interval is looked up from the table using their current rank index, overriding recoverIntervalMinutes. If not set, all players share the same recoverIntervalMinutes. |
||||
| recoverValueTable | RecoverValueTable | Recover Value Table Reference to a RecoverValueTable that dynamically determines the recovery amount based on the player’s GS2-Experience rank. When set, the player’s recovery value is looked up from the table using their current rank index, overriding recoverValue. If not set, all players share the same recoverValue. |
MaxStaminaTable
Maximum Stamina Table
This entity defines the maximum value of stamina for each rank of GS2-Experience.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ |
~ 128 chars | Maximum Stamina Table Name Maximum Stamina Table-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
||
| metadata | string | ~ 128 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
|||
| experienceModelId | string | ✓ |
~ 1024 chars | Experience Model ID The GRN of the GS2-Experience ExperienceModel used to look up the player’s current rank. The rank index is used as an array index into the values list to determine the per-user maximum stamina. |
||
| values | List<int> | ✓ |
1 ~ 1024 items | Maximum Stamina Values by Rank An array of maximum stamina values indexed by the player’s GS2-Experience rank index. The value at index i is used as the maximum stamina for players at rank i. The array length should match the number of ranks defined in the referenced ExperienceModel. |
RecoverIntervalTable
Recovery Interval Table
This entity defines the stamina recovery interval for each rank of GS2-Experience.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ |
~ 128 chars | Stamina recovery interval table name Stamina recovery interval table-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
||
| metadata | string | ~ 128 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
|||
| experienceModelId | string | ✓ |
~ 1024 chars | Experience Model ID The GRN of the GS2-Experience ExperienceModel used to look up the player’s current rank. The rank index is used as an array index into the values list to determine the per-user recovery interval. |
||
| values | List<int> | ✓ |
1 ~ 1024 items | Recovery Interval Values by Rank An array of recovery interval values (in minutes) indexed by the player’s GS2-Experience rank index. The value at index i is used as the recovery interval for players at rank i, overriding the model’s default recoverIntervalMinutes. |
RecoverValueTable
Stamina Recovery Amount Table
This entity defines the amount of stamina recovery for each rank of GS2-Experience.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ |
~ 128 chars | Stamina Recovery Amount Table name Stamina Recovery Amount Table-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
||
| metadata | string | ~ 128 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. |
|||
| experienceModelId | string | ✓ |
~ 1024 chars | Experience Model ID The GRN of the GS2-Experience ExperienceModel used to look up the player’s current rank. The rank index is used as an array index into the values list to determine the per-user recovery amount. |
||
| values | List<int> | ✓ |
1 ~ 1024 items | Recovery Amount Values by Rank An array of recovery amount values indexed by the player’s GS2-Experience rank index. The value at index i is used as the recovery amount per tick for players at rank i, overriding the model’s default recoverValue. |