Master Data Reference of GS2-Formation

{
  "version": "2019-09-09",
  "moldModels": [
    {
      "name": "[string]Form storage area model name",
      "metadata": "[string?]metadata",
      "initialMaxCapacity": "[int]Initial capacity to store forms",
      "maxCapacity": "[int]Maximum capacity to store forms",
      "formModel": {
        "formModelId": "[string]Form model GRN",
        "name": "[string]Form model name",
        "metadata": "[string?]metadata",
        "slots": [
          {
            "name": "[string]Slot model name",
            "propertyRegex": "[string]Regular expressions for values that can be set as properties",
            "metadata": "[string?]metadata"
          }
        ]
      }
    }
  ],
  "propertyFormModels": [
    {
      "name": "[string]Property form model name",
      "metadata": "[string?]metadata",
      "slots": [
        {
          "name": "[string]Slot model name",
          "propertyRegex": "[string]Regular expressions for values that can be set as properties",
          "metadata": "[string?]metadata"
        }
      ]
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version2019-09-09Format version of master data
moldModelsList<MoldModel>~ 100 itemsArea for storing form
propertyFormModelsList<PropertyFormModel>~ 100 itemsProperty Form Model

FormModel

Form Model

This entity represents the form status. A slot can be defined as an area that can be organized.

In the case of weapons and armor, a slot can be a part such as right hand', left hand’, body', arm’, etc., or it can be an area such as slot', slot’, or `slot’, etc. In the case of a party, positions such as “vanguard,” “middle guard,” and “rear guard” can be represented as slots.

TypeConditionRequireDefaultLimitationDescription
formModelIdstring~ 1024 charsForm model GRN
namestring~ 128 charsForm model name
metadatastring~ 2048 charsmetadata
slotsList<SlotModel>1 ~ 10 itemsList of Slot Model

MoldModel

Area for storing form

If it is a party composition, it is intended to be saved in the form of “fire attribute party” or “water attribute party”. The number of areas that can be saved can be limited or expanded individually.

TypeConditionRequireDefaultLimitationDescription
moldModelIdstring~ 1024 charsForm storage area GRN
namestring~ 128 charsForm storage area model name
metadatastring~ 2048 charsmetadata
initialMaxCapacityint1 ~ 2147483646Initial capacity to store forms
maxCapacityint1 ~ 2147483646Maximum capacity to store forms
formModelFormModel

PropertyFormModel

Property Form Model

An entity that represents the composition status. The difference between Mold / Form is that Mold / Form defines the number of slots and records the composition in each slot, and Property Form is used to represent compositions that are difficult to determine the number of slots in advance, such as setting skills for owned equipment.

TypeConditionRequireDefaultLimitationDescription
propertyFormModelIdstring~ 1024 charsProperty form model GRN
namestring~ 128 charsProperty form model name
metadatastring~ 2048 charsmetadata
slotsList<SlotModel>1 ~ 10 itemsList of Slot Model

Slot

Slot

TypeConditionRequireDefaultLimitationDescription
namestring~ 128 charsSlot model name
propertyIdstring~ 1024 charsProperty ID
metadatastring~ 1024 charsmetadata

SlotModel

Slot Model

TypeConditionRequireDefaultLimitationDescription
namestring~ 128 charsSlot model name
propertyRegexstring“.*”~ 512 charsRegular expressions for values that can be set as properties
metadatastring~ 512 charsmetadata

SlotWithSignature

Signature Slot

TypeConditionRequireDefaultLimitationDescription
namestring~ 128 charsSlot model name
propertyTypeenum {
    “gs2_inventory”,
    “gs2_simple_inventory”,
    “gs2_dictionary”
}
~ 128 charsProperty Type
bodystring~ 1048576 charspayload
signaturestring~ 1024 charsSignature that proves ownership of the resource for the property ID
metadatastring~ 1024 charsmetadata

Enumeration type definition to specify as propertyType

Enumerator String DefinitionDescription
gs2_inventoryGS2-Inventory::ItemSet
gs2_simple_inventoryGS2-Inventory::SimpleItem
gs2_dictionaryGS2-Dictionary::Entry

AcquireAction

Acquire Action

TypeConditionRequireDefaultLimitationDescription
actionenum {
"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",
"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 charsTypes of actions to be performed in the acquire action
requeststring~ 1048576 charsJSON of request

VerifyActionResult

Verify action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
}
~ 128 charsTypes of actions to be performed in the verify task
verifyRequeststring~ 1048576 charsJSON of request
statusCodeint~ 999Status code
verifyResultstring~ 1048576 charsResult payload

Enumeration type definition to specify as action

Enumerator String DefinitionDescription

ConsumeActionResult

Consume action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
}
~ 128 charsTypes of actions to be performed in the consume action
consumeRequeststring~ 1048576 charsJSON of request
statusCodeint~ 999Status code
consumeResultstring~ 1048576 charsResult payload

Enumeration type definition to specify as action

Enumerator String DefinitionDescription

AcquireActionResult

Acquire action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
}
~ 128 charsTypes of actions to be performed in the acquire action
acquireRequeststring~ 1048576 charsJSON of request
statusCodeint~ 999Status code
acquireResultstring~ 1048576 charsResult payload

Enumeration type definition to specify as action

Enumerator String DefinitionDescription

TransactionResult

Transaction execution results

Transaction execution results executed using server-side transaction auto-execution functionality

TypeConditionRequireDefaultLimitationDescription
transactionIdstring36 ~ 36 charsTransaction ID
verifyResultsList<VerifyActionResult>~ 10 itemsList of verify action execution results
consumeResultsList<ConsumeActionResult>~ 10 itemsList of consume action execution results
acquireResultsList<AcquireActionResult>~ 100 itemsList of acquire action execution results