Deploy/CDK Reference of GS2-Stamina
The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
Entity
Resources operated in Deploy process
Namespace
Namespace
A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. 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 generation request
| 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 settings | ||||
| overflowTriggerScript | string | ~ 1024 chars | GS2-Script script GRN to handle overflow stamina during recovery process | |||
| logSetting | LogSetting | Log output settings |
GetAttr
Generation results of resources that can be obtained with 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 Template
class 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 Template
class 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 Template
from 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 settings
Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous acquisition 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 * Required if enableAutoRun is true | |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | ✓* | false | Whether to execute transactions asynchronously * Required if enableAtomicCommit is true | |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | ✓* | false | Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true | |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | ✓* | false | Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor namespace GRN used for transaction execution | |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | Namespace GRN in GS2-JobQueue used to run the transaction |
LogSetting
Log Export Settings
Manages log data export settings. This type holds the GS2-Log namespace identifier (Namespace ID) 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, and debugging.
| 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 Master Data
Currently active master data describing the stamina model definitions within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings 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 operating your game and export JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-Stamina for the JSON file format.Request
Resource generation request
| 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 used to reflect results after upload * Required if mode is “preUpload” |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentStaminaMaster | Updated and currently available Stamina Master |
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{
Metadata: pointy.String("PLAYER_LEVEL"),
},
RecoverIntervalTable: &stamina.RecoverIntervalTable{
Metadata: pointy.String("STAMINA_RECOVER_INTERVAL"),
},
RecoverValueTable: &stamina.RecoverValueTable{
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{
Metadata: pointy.String("SPECIAL"),
},
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
class 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 Template
class 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 Template
from 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 * Automatically configured on 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 | Speed at which stamina is regained (minutes) | ||
| recoverValue | int | ✓ | 1 | 0 ~ 2147483646 | Amount of recovery after a period of time | |
| initialCapacity | int | ✓ | 0 ~ 2147483646 | Initial maximum value of stamina | ||
| isOverflow | bool | ✓ | Recover beyond the maximum | |||
| maxCapacity | int | {isOverflow} == true | ✓* | 0 ~ 2147483646 | Maximum value in overflow situation * Required if isOverflow is true | |
| maxStaminaTable | MaxStaminaTable | Maximum Stamina Table used when working with GS2-Experience | ||||
| recoverIntervalTable | RecoverIntervalTable | Recovery interval table used when working with GS2-Experience | ||||
| recoverValueTable | RecoverValueTable | Recovery amount table used when working with GS2-Experience |
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 Value Table Name Maximum Stamina Value Table Unique 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 GRN | ||
| values | List<int> | ✓ | 1 ~ 1024 items | List of Maximum Stamina |
RecoverIntervalTable
Stamina 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 GRN | ||
| values | List<int> | ✓ | 1 ~ 1024 items | Stamina recovery interval table for each rank |
RecoverValueTable
Stamina Recovery Value 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 Value Table name Stamina Recovery Value 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 GRN | ||
| values | List<int> | ✓ | 1 ~ 1024 items | Stamina recovery value table for each rank |