Master Data Reference of GS2-Enhance

Reference of the format of master data and various models to be imported

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"
        }
      ]
    }
  ]
}
TypeConditionRequiredDefaultValue LimitsDescription
versionstring
2020-08-22Format version of master data
rateModelsList<RateModel>~ 10000 itemsEnhancement 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.
unleashRateModelsList<UnleashRateModel>~ 10000 itemsUnleash 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.

TypeConditionRequiredDefaultValue LimitsDescription
rateModelIdstring
✓*
~ 1024 charsEnhancement Rate Model GRN
* Automatically configured on the server
namestring
~ 128 charsEnhancement Rate Model Name
Enhancement Rate Model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
descriptionstring~ 1024 charsDescription
metadatastring~ 2048 charsMetadata
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.
targetInventoryModelIdstring
~ 1024 charsGS2-Inventory Inventory Model GRN Usable for enhancement targets
acquireExperienceSuffixstring
~ 1024 charsSuffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience
materialInventoryModelIdstring
~ 1024 charsGRN for the GS2-Inventory model usable as enhancement material
acquireExperienceHierarchyList<string>0 ~ 10 itemsHierarchical 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.
experienceModelIdstring
~ 1024 charsExperience Model GRN
bonusRatesList<BonusRate>0 ~ 1000 itemsExperience gain bonus

BonusRate

Experience gain bonus

TypeConditionRequiredDefaultValue LimitsDescription
ratefloat
1.00 ~ 10000Experience bonus multiplier (1.0 = no bonus)
weightint
10 ~ 2147483645lottery 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.

TypeConditionRequiredDefaultValue LimitsDescription
unleashRateModelIdstring
✓*
~ 1024 charsUnleash Rate Model GRN
* Automatically configured on the server
namestring
~ 128 charsUnleash rate model name
Unleash rate model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
descriptionstring~ 1024 charsDescription
metadatastring~ 2048 charsMetadata
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.
targetInventoryModelIdstring
~ 1024 charsGS2-Inventory Inventory Model GRN Usable for unleash targets
gradeModelIdstring
~ 1024 charsGrade Model GRN
gradeEntriesList<UnleashRateEntryModel>
1 ~ 1000 itemsList of Grade Entry

UnleashRateEntryModel

Unleash rate entry model

TypeConditionRequiredDefaultValue LimitsDescription
gradeValuelong
1 ~ 1000Target grade
needCountint
1 ~ 1000How many items of the same type to consume