Master Data Reference of GS2-Enhance

{
  "version": "2020-08-22",
  "rateModels": [
    {
      "name": "[string]Enhanced Rate Name",
      "description": "[string?]Description",
      "metadata": "[string?]metadata",
      "targetInventoryModelId": "[string]Inventory available for enhancement targets",
      "acquireExperienceSuffix": "[string]Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience",
      "materialInventoryModelId": "[string]Inventory model GRN",
      "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]Enhanced Rate Name",
      "description": "[string?]Description",
      "metadata": "[string?]metadata",
      "targetInventoryModelId": "[string]Inventory available for unleash targets",
      "gradeModelId": "[string]Grade model",
      "gradeEntries": [
        {
          "gradeValue": "[long]Target grade",
          "needCount": "[int]How many items of the same type to consume"
        }
      ]
    }
  ]
}

	Type	Require	Default
version	✓	2020-08-22	Format version of master data
rateModels	List<RateModel>
unleashRateModels	List<UnleashRateModel>

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	Require	Limitation	Description
rateModelId	string	✓	~ 1024 chars	Enhance Rate Model GRN
name	string	✓	~ 128 chars	Enhanced Rate Name
description	string		~ 1024 chars	Description
metadata	string		~ 2048 chars	metadata
targetInventoryModelId	string	✓	~ 1024 chars	Inventory available 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	Inventory model GRN
acquireExperienceHierarchy	List<string>		~ 10 items	Hierarchical structure of JSON data defining acquisition experience values to be stored in ItemModel metadata
experienceModelId	string	✓	~ 1024 chars	Experience Model GRN
bonusRates	List<BonusRate>		~ 1000 items	Experience gain bonus

UnleashRateModel

Unleash Rates

The limit breakthrough rate is the data that defines the limit breakthrough target and the GS2-Grade limit breakthrough model. The data for the limit breakthrough must be managed in GS2-Inventory.

	Type	Require	Limitation	Description
unleashRateModelId	string	✓	~ 1024 chars	Unleash Rate Model GRN
name	string	✓	~ 128 chars	Enhanced Rate Name
description	string		~ 1024 chars	Description
metadata	string		~ 2048 chars	metadata
targetInventoryModelId	string	✓	~ 1024 chars	Inventory available for unleash targets
gradeModelId	string	✓	~ 1024 chars	Grade model
gradeEntries	List<UnleashRateEntryModel>	✓	1 ~ 1000 items	List of Grade Entry

BonusRate

Experience gain bonus

	Type	Condition	Require	Default	Limitation	Description
rate	float		✓	1.0	~ 10000	Experience bonus multiplier (1.0 = no bonus)
weight	int		✓	1	~ 2147483645	lottery weight

Material

Balance Parameter Value Model

	Type	Condition	Require	Default	Limitation	Description
materialItemSetId	string		✓		~ 1024 chars	Quantity of items held per expiration date GRN
count	int		✓	1	~ 2147483645	Number of consumption

UnleashRateEntryModel

Unleash rate entry model

	Type	Condition	Require	Default	Limitation	Description
gradeValue	long		✓		1 ~ 1000	Target grade
needCount	int		✓		1 ~ 1000	How many items of the same type to consume