Master Data Reference of GS2-Enhance
Reference of the format of master data and various models to be imported
{
"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]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]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 | Condition | Require | Default | Limitation | Description |
---|
version | | | ✓ | 2020-08-22 | | Format version of master data |
rateModels | List<RateModel> | | | | ~ 10000 items | Enhancement Rate Model |
unleashRateModels | List<UnleashRateModel> | | | | ~ 10000 items | Unleash Rates |
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 | Require | Default | 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 | GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement. |
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 | Condition | Require | Default | 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 | GRN of item sets (quantity of items held per expiration date) that will be used as materials for enhancement |
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 |
VerifyActionResult
Verify action execution result
| Type | Condition | Require | Default | Limitation | Description |
---|
action | enum { "Gs2Dictionary:VerifyEntryByUserId", "Gs2Distributor:IfExpressionByUserId", "Gs2Distributor:AndExpressionByUserId", "Gs2Distributor:OrExpressionByUserId", "Gs2Enchant:VerifyRarityParameterStatusByUserId", "Gs2Experience:VerifyRankByUserId", "Gs2Experience:VerifyRankCapByUserId", "Gs2Grade:VerifyGradeByUserId", "Gs2Grade:VerifyGradeUpMaterialByUserId", "Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName", "Gs2Guild:VerifyIncludeMemberByUserId", "Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId", "Gs2Inventory:VerifyItemSetByUserId", "Gs2Inventory:VerifyReferenceOfByUserId", "Gs2Inventory:VerifySimpleItemByUserId", "Gs2Inventory:VerifyBigItemByUserId", "Gs2Limit:VerifyCounterByUserId", "Gs2Matchmaking:VerifyIncludeParticipantByUserId", "Gs2Mission:VerifyCompleteByUserId", "Gs2Mission:VerifyCounterValueByUserId", "Gs2Ranking2:VerifyGlobalRankingScoreByUserId", "Gs2Ranking2:VerifyClusterRankingScoreByUserId", "Gs2Ranking2:VerifySubscribeRankingScoreByUserId", "Gs2Schedule:VerifyTriggerByUserId", "Gs2Schedule:VerifyEventByUserId", "Gs2SerialKey:VerifyCodeByUserId", "Gs2Stamina:VerifyStaminaValueByUserId", "Gs2Stamina:VerifyStaminaMaxValueByUserId", "Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId", "Gs2Stamina:VerifyStaminaRecoverValueByUserId", "Gs2Stamina:VerifyStaminaOverflowValueByUserId", }
| | ✓ | | ~ 128 chars | Types of actions to be performed in the verify task |
verifyRequest | string | | ✓ | | ~ 524288 chars | JSON of request |
statusCode | int | | | | ~ 999 | Status code |
verifyResult | string | | | | ~ 1048576 chars | Result payload |
ConsumeActionResult
Consume action execution result
| Type | Condition | Require | Default | Limitation | Description |
---|
action | enum { "Gs2AdReward:ConsumePointByUserId", "Gs2Dictionary:DeleteEntriesByUserId", "Gs2Enhance:DeleteProgressByUserId", "Gs2Exchange:DeleteAwaitByUserId", "Gs2Experience:SubExperienceByUserId", "Gs2Experience:SubRankCapByUserId", "Gs2Formation:SubMoldCapacityByUserId", "Gs2Grade:SubGradeByUserId", "Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName", "Gs2Idle:DecreaseMaximumIdleMinutesByUserId", "Gs2Inbox:OpenMessageByUserId", "Gs2Inbox:DeleteMessageByUserId", "Gs2Inventory:ConsumeItemSetByUserId", "Gs2Inventory:ConsumeSimpleItemsByUserId", "Gs2Inventory:ConsumeBigItemByUserId", "Gs2JobQueue:DeleteJobByUserId", "Gs2Limit:CountUpByUserId", "Gs2LoginReward:MarkReceivedByUserId", "Gs2Mission:ReceiveByUserId", "Gs2Mission:BatchReceiveByUserId", "Gs2Mission:DecreaseCounterByUserId", "Gs2Mission:ResetCounterByUserId", "Gs2Money:WithdrawByUserId", "Gs2Money:RecordReceipt", "Gs2Money2:WithdrawByUserId", "Gs2Money2:VerifyReceiptByUserId", "Gs2Quest:DeleteProgressByUserId", "Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId", "Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId", "Gs2Schedule:DeleteTriggerByUserId", "Gs2SerialKey:UseByUserId", "Gs2Showcase:IncrementPurchaseCountByUserId", "Gs2SkillTree:MarkRestrainByUserId", "Gs2Stamina:DecreaseMaxValueByUserId", "Gs2Stamina:ConsumeStaminaByUserId", }
| | ✓ | | ~ 128 chars | Types of actions to be performed in the consume action |
consumeRequest | string | | ✓ | | ~ 524288 chars | JSON of request |
statusCode | int | | | | ~ 999 | Status code |
consumeResult | string | | | | ~ 1048576 chars | Result payload |
AcquireActionResult
Acquire action execution result
| Type | Condition | Require | Default | Limitation | Description |
---|
action | enum { "Gs2AdReward:AcquirePointByUserId", "Gs2Dictionary:AddEntriesByUserId", "Gs2Enchant:ReDrawBalanceParameterStatusByUserId", "Gs2Enchant:SetBalanceParameterStatusByUserId", "Gs2Enchant:ReDrawRarityParameterStatusByUserId", "Gs2Enchant:AddRarityParameterStatusByUserId", "Gs2Enchant:SetRarityParameterStatusByUserId", "Gs2Enhance:DirectEnhanceByUserId", "Gs2Enhance:UnleashByUserId", "Gs2Enhance:CreateProgressByUserId", "Gs2Exchange:ExchangeByUserId", "Gs2Exchange:IncrementalExchangeByUserId", "Gs2Exchange:CreateAwaitByUserId", "Gs2Exchange:AcquireForceByUserId", "Gs2Exchange:SkipByUserId", "Gs2Experience:AddExperienceByUserId", "Gs2Experience:SetExperienceByUserId", "Gs2Experience:AddRankCapByUserId", "Gs2Experience:SetRankCapByUserId", "Gs2Experience:MultiplyAcquireActionsByUserId", "Gs2Formation:AddMoldCapacityByUserId", "Gs2Formation:SetMoldCapacityByUserId", "Gs2Formation:AcquireActionsToFormProperties", "Gs2Formation:SetFormByUserId", "Gs2Formation:AcquireActionsToPropertyFormProperties", "Gs2Friend:UpdateProfileByUserId", "Gs2Grade:AddGradeByUserId", "Gs2Grade:ApplyRankCapByUserId", "Gs2Grade:MultiplyAcquireActionsByUserId", "Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName", "Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName", "Gs2Idle:IncreaseMaximumIdleMinutesByUserId", "Gs2Idle:SetMaximumIdleMinutesByUserId", "Gs2Idle:ReceiveByUserId", "Gs2Inbox:SendMessageByUserId", "Gs2Inventory:AddCapacityByUserId", "Gs2Inventory:SetCapacityByUserId", "Gs2Inventory:AcquireItemSetByUserId", "Gs2Inventory:AcquireItemSetWithGradeByUserId", "Gs2Inventory:AddReferenceOfByUserId", "Gs2Inventory:DeleteReferenceOfByUserId", "Gs2Inventory:AcquireSimpleItemsByUserId", "Gs2Inventory:SetSimpleItemsByUserId", "Gs2Inventory:AcquireBigItemByUserId", "Gs2Inventory:SetBigItemByUserId", "Gs2JobQueue:PushByUserId", "Gs2Limit:CountDownByUserId", "Gs2Limit:DeleteCounterByUserId", "Gs2LoginReward:DeleteReceiveStatusByUserId", "Gs2LoginReward:UnmarkReceivedByUserId", "Gs2Lottery:DrawByUserId", "Gs2Lottery:ResetBoxByUserId", "Gs2Mission:RevertReceiveByUserId", "Gs2Mission:IncreaseCounterByUserId", "Gs2Mission:SetCounterByUserId", "Gs2Money:DepositByUserId", "Gs2Money:RevertRecordReceipt", "Gs2Money2:DepositByUserId", "Gs2Quest:CreateProgressByUserId", "Gs2Schedule:TriggerByUserId", "Gs2Schedule:ExtendTriggerByUserId", "Gs2Script:InvokeScript", "Gs2SerialKey:RevertUseByUserId", "Gs2SerialKey:IssueOnce", "Gs2Showcase:DecrementPurchaseCountByUserId", "Gs2Showcase:ForceReDrawByUserId", "Gs2SkillTree:MarkReleaseByUserId", "Gs2Stamina:RecoverStaminaByUserId", "Gs2Stamina:RaiseMaxValueByUserId", "Gs2Stamina:SetMaxValueByUserId", "Gs2Stamina:SetRecoverIntervalByUserId", "Gs2Stamina:SetRecoverValueByUserId", "Gs2StateMachine:StartStateMachineByUserId", }
| | ✓ | | ~ 128 chars | Types of actions to be performed in the acquire action |
acquireRequest | string | | ✓ | | ~ 524288 chars | JSON of request |
statusCode | int | | | | ~ 999 | Status code |
acquireResult | string | | | | ~ 1048576 chars | Result payload |
TransactionResult
Transaction execution results
Transaction execution results executed using server-side transaction auto-execution functionality
| Type | Condition | Require | Default | Limitation | Description |
---|
transactionId | string | | ✓ | | 36 ~ 36 chars | Transaction ID |
verifyResults | List<VerifyActionResult> | | | | ~ 10 items | List of verify action execution results |
consumeResults | List<ConsumeActionResult> | | | [] | ~ 10 items | List of consume action execution results |
acquireResults | List<AcquireActionResult> | | | [] | ~ 100 items | List of acquire action execution results |
hasError | bool | | ✓ | false | | Whether an error occurred during transaction execution |