Master Data Reference of GS2-Stamina
Reference of the format of master data and various models to be imported
Master Data Format
{
"version": "2019-02-14",
"staminaModels": [
{
"name": "[string]Stamina Model Name",
"metadata": "[string?]Metadata",
"recoverIntervalMinutes": "[int]Speed at which stamina is regained (minutes)",
"recoverValue": "[int]Amount of recovery after a period of time",
"initialCapacity": "[int]Initial maximum value of stamina",
"isOverflow": "[bool]Recover beyond the maximum",
"maxCapacity": "[int]Maximum value in overflow situation",
"maxStaminaTable": {
"name": "[string]Maximum Stamina Value Table Name",
"metadata": "[string?]Metadata",
"experienceModelId": "[string]Experience Model GRN",
"values": [
"[int]Maximum Stamina"
]
},
"recoverIntervalTable": {
"name": "[string]Stamina recovery interval table name",
"metadata": "[string?]Metadata",
"experienceModelId": "[string]Experience Model GRN",
"values": [
"[int?]Stamina recovery interval (minutes)"
]
},
"recoverValueTable": {
"name": "[string]Stamina Recovery Value Table name",
"metadata": "[string?]Metadata",
"experienceModelId": "[string]Experience Model GRN",
"values": [
"[int?]Stamina recovery value"
]
}
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2019-02-14 | Format version of master data | ||
| staminaModels | List<StaminaModel> | ~ 100 items | 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. |
Model
StaminaModel
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 |