Master Data Reference of GS2-Enhance
Master Data Format
{
"version": "2020-08-22",
"rateModels": [
{
"name": "[string]Enhancement Rate Model Name",
"description": "[string?]Description",
"metadata": "[string?]Metadata",
"targetInventoryModelId": "[string]GS2-Inventory Inventory Model GRN Usable for enhancement targets",
"acquireExperienceSuffix": "[string]Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience",
"materialInventoryModelId": "[string]GRN for the GS2-Inventory model usable as enhancement material",
"acquireExperienceHierarchy": [
"[string]Hierarchical structure of JSON data defining acquisition experience values to be stored in ItemModel metadata"
],
"experienceModelId": "[string]Experience Model GRN",
"bonusRates": [
{
"rate": "[float]Experience bonus multiplier (1.0 = no bonus)",
"weight": "[int]lottery weight"
}
]
}
],
"unleashRateModels": [
{
"name": "[string]Unleash rate model name",
"description": "[string?]Description",
"metadata": "[string?]Metadata",
"targetInventoryModelId": "[string]GS2-Inventory Inventory Model GRN Usable for unleash targets",
"gradeModelId": "[string]Grade Model GRN",
"gradeEntries": [
{
"gradeValue": "[long]Target grade",
"needCount": "[int]How many items of the same type to consume"
}
]
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2020-08-22 | Format version of master data | ||
| rateModels | List<RateModel> | ~ 10000 items | Enhancement Rate Model The enhancement rate is data that defines the materials used for enhancement and the target of enhancement. Both material data and enhancement target data must be managed in GS2-Inventory. The experience value obtained from the enhancement is recorded in GS2-Inventory metadata in JSON format. Here, it is necessary to describe at which level of the metadata the experience value is stored. A correction value can be applied to the amount of experience value that can be obtained with a certain probability of great success during enhancement.The probability of that draw is also defined in this entity. | |||
| unleashRateModels | List<UnleashRateModel> | ~ 10000 items | Unleash Rate Model Unleash Rate Model is the data that defines the unleash target and the GS2-Grade Grade Model. The data for the limit breakthrough must be managed in GS2-Inventory. |
Model
RateModel
Enhancement Rate Model
The enhancement rate is data that defines the materials used for enhancement and the target of enhancement.
Both material data and enhancement target data must be managed in GS2-Inventory. The experience value obtained from the enhancement is recorded in GS2-Inventory metadata in JSON format. Here, it is necessary to describe at which level of the metadata the experience value is stored.
A correction value can be applied to the amount of experience value that can be obtained with a certain probability of great success during enhancement.
The probability of that draw is also defined in this entity.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| rateModelId | string | ✓* | ~ 1024 chars | Enhancement Rate Model GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Enhancement Rate Model Name Enhancement Rate Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| description | string | ~ 1024 chars | Description | |||
| metadata | string | ~ 2048 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. | |||
| targetInventoryModelId | string | ✓ | ~ 1024 chars | GS2-Inventory Inventory Model GRN Usable for enhancement targets | ||
| acquireExperienceSuffix | string | ✓ | ~ 1024 chars | Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience | ||
| materialInventoryModelId | string | ✓ | ~ 1024 chars | GRN for the GS2-Inventory model usable as enhancement material | ||
| acquireExperienceHierarchy | List<string> | 0 ~ 10 items | Hierarchical structure of JSON data defining acquisition experience values to be stored in ItemModel metadata GS2-Enhance features a mechanism that works in conjunction with GS2-Inventory to perform enhancements. It sets the experience value when used as enhancement material in JSON format within the ItemModel metadata. For example, to define metadata with a structure like: { “aaa”: { “bbb”: { “experienceValue”: 100 } } } Specify it as: [ “aaa”, ‘bbb’, “experienceValue” ] Details are explained in the Microservices Introduction / GS2-Enhance section. | |||
| experienceModelId | string | ✓ | ~ 1024 chars | Experience Model GRN | ||
| bonusRates | List<BonusRate> | 0 ~ 1000 items | Experience gain bonus |
BonusRate
Experience gain bonus
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| rate | float | ✓ | 1.0 | 0 ~ 10000 | Experience bonus multiplier (1.0 = no bonus) | |
| weight | int | ✓ | 1 | 0 ~ 2147483645 | lottery weight |
UnleashRateModel
Unleash Rate Model
Unleash Rate Model is the data that defines the unleash target and the GS2-Grade Grade Model. The data for the limit breakthrough must be managed in GS2-Inventory.
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| unleashRateModelId | string | ✓* | ~ 1024 chars | Unleash Rate Model GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Unleash rate model name Unleash rate model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| description | string | ~ 1024 chars | Description | |||
| metadata | string | ~ 2048 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. | |||
| targetInventoryModelId | string | ✓ | ~ 1024 chars | GS2-Inventory Inventory Model GRN Usable for unleash targets | ||
| gradeModelId | string | ✓ | ~ 1024 chars | Grade Model GRN | ||
| gradeEntries | List<UnleashRateEntryModel> | ✓ | 1 ~ 1000 items | List of Grade Entry |
UnleashRateEntryModel
Unleash rate entry model
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| gradeValue | long | ✓ | 1 ~ 1000 | Target grade | ||
| needCount | int | ✓ | 1 ~ 1000 | How many items of the same type to consume |