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"
        }
      ]
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version2020-08-22Format version of master data
rateModelsList<RateModel>
unleashRateModelsList<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.

TypeConditionRequireDefaultLimitationDescription
rateModelIdstring~ 1024 charsEnhance Rate Model GRN
namestring~ 128 charsEnhanced Rate Name
descriptionstring~ 1024 charsDescription
metadatastring~ 2048 charsmetadata
targetInventoryModelIdstring~ 1024 charsInventory available for enhancement targets
acquireExperienceSuffixstring~ 1024 charsSuffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience
materialInventoryModelIdstring~ 1024 charsInventory model GRN
acquireExperienceHierarchyList<string>~ 10 itemsHierarchical structure of JSON data defining acquisition experience values to be stored in ItemModel metadata
experienceModelIdstring~ 1024 charsExperience Model GRN
bonusRatesList<BonusRate>~ 1000 itemsExperience gain bonus

UnleashRateModel

Enhancement Rates

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.

TypeConditionRequireDefaultLimitationDescription
unleashRateModelIdstring~ 1024 charsUnleash Rate Model GRN
namestring~ 128 charsEnhanced Rate Name
descriptionstring~ 1024 charsDescription
metadatastring~ 2048 charsmetadata
targetInventoryModelIdstring~ 1024 charsInventory available for unleash targets
gradeModelIdstring~ 1024 charsGrade model
gradeEntriesList<UnleashRateEntryModel>1 ~ 1000 itemsList of Grade Entry

BonusRate

Experience gain bonus

TypeConditionRequireDefaultLimitationDescription
ratefloat1.0~ 10000Experience bonus multiplier (1.0 = no bonus)
weightint1~ 2147483645lottery weight

Material

Balance Parameter Value Model

TypeConditionRequireDefaultLimitationDescription
materialItemSetIdstring~ 1024 charsQuantity of items held per expiration date GRN
countint1~ 2147483645Number of consumption

UnleashRateEntryModel

Unleash rate entry model

TypeConditionRequireDefaultLimitationDescription
gradeValuelong1 ~ 1000Target grade
needCountint1 ~ 1000How many items of the same type to consume