Master Data Reference of GS2-Enhance
{
"version": "2020-08-22",
"rateModels": [
{
"name": "[string]Enhanced Rate Name",
"description": "[string?]Description",
"metadata": "[string?]Metadata",
"targetInventoryModelId": "[string]GRN of inventory models usable for reinforcement targets",
"acquireExperienceSuffix": "[string]Suffix to be assigned to the property ID that stores the experience value obtained from GS2-Experience",
"materialInventoryModelId": "[string]GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement.",
"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 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 | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | ✓ | 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 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. |
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 |
Material
Enhance Material Model
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| materialItemSetId | string | ✓ | ~ 1024 chars | GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement | ||
| count | int | ✓ | 1 | 0 ~ 2147483645 | Number of consumption |
VerifyActionResult
Verify action execution result
ConsumeActionResult
Consume action execution result
AcquireActionResult
Acquire action execution result
TransactionResult
Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| transactionId | string | ✓ | 36 ~ 36 chars | Transaction ID | ||
| verifyResults | List<VerifyActionResult> | 0 ~ 10 items | List of verify action execution results | |||
| consumeResults | List<ConsumeActionResult> | [] | 0 ~ 10 items | List of consume action execution results | ||
| acquireResults | List<AcquireActionResult> | [] | 0 ~ 100 items | List of acquire action execution results | ||
| hasError | bool | ✓ | false | Whether an error occurred during transaction execution |
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 | 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 | GRN of inventory models usable for reinforcement 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 of item sets (quantity of items held per expiration date) that will be used as materials for enhancement. | ||
| 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 |
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 | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| unleashRateModelId | string | ✓ | ~ 1024 chars | Unleash Rate Model GRN | ||
| name | string | ✓ | ~ 128 chars | Unleash 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 |
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 |