Master Data Reference of GS2-Experience

Tags:

Master Data

{
  "version": "2019-01-11",
  "experienceModels": [
    {
      "name": "[string]Experience Model Name",
      "metadata": "[string?]metadata",
      "defaultExperience": "[long]Initial Experience Value",
      "defaultRankCap": "[long]Initial value of rank cap",
      "maxRankCap": "[long]Maximum rank cap",
      "rankThreshold": {
        "metadata": "[string?]metadata",
        "values": [
          "[long]Rank Up Experience Threshold"
        ]
      },
      "acquireActionRates": [
        {
          "name": "[string]Remuneration addition table name",
          "mode": "[string]Remuneration addition table type",
          "rates": [
            "[double]Addition amount (multiplier)"
          ],
          "bigRates": [
            "[string]Addition amount (multiplier)"
          ]
        }
      ]
    }
  ]
}

	Type	Condition	Require	Default	Limitation	Description
version			✓	2019-01-11		Format version of master data
experienceModels	List<ExperienceModel>				~ 100 items	Experience Model

ExperienceModel

Experience Model

An experience model is an entity that sets the threshold of experience required for rank advancement and for each default and maximum rank cap.

	Type	Require	Default	Limitation	Description
experienceModelId	string	✓		~ 1024 chars	Experience Model GRN
name	string	✓		~ 128 chars	Experience Model Name
metadata	string			~ 2048 chars	metadata
defaultExperience	long	✓	0	~ 9223372036854775805	Initial Experience Value
defaultRankCap	long	✓		~ 9223372036854775805	Initial value of rank cap
maxRankCap	long	✓		~ 9223372036854775805	Maximum rank cap
rankThreshold	Threshold	✓			rank-up threshold
acquireActionRates	List<AcquireActionRate>			~ 100 items	List of Remuneration addition table

Threshold

Rank Up Threshold

	Type	Condition	Require	Default	Limitation	Description
metadata	string				~ 2048 chars	metadata
values	List<long>		✓		1 ~ 10000 items	List of Rank Up Experience Threshold

AcquireActionRate

Remuneration addition table master

You can adjust the amount of rewards according to the rank.

	Type	Condition	Require	Default	Limitation	Description
name	string		✓		~ 128 chars	Remuneration addition table name
mode	enum { “double”, “big” }		✓	“double”	~ 128 chars	Remuneration addition table type
rates	List<double>	{mode} == “double”	✓		1 ~ 10000 items	Amount added per rank (multiplier)
bigRates	List<string>	{mode} == “big”	✓		1 ~ 10000 items	Amount added per rank (multiplier)

Enumeration type definition to specify as mode

Enumerator String Definition	Description
double	Floating point number less than 2^48
big	Floating point number less than 1024 digits

VerifyActionResult

Verify action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the verify task
verifyRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
verifyResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

ConsumeActionResult

Consume action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the consume action
consumeRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
consumeResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

AcquireActionResult

Acquire action execution result

	Type	Require	Limitation	Description
action	enum { }	✓	~ 128 chars	Types of actions to be performed in the acquire action
acquireRequest	string	✓	~ 1048576 chars	JSON of request
statusCode	int		~ 999	Status code
acquireResult	string		~ 1048576 chars	Result payload

Enumeration type definition to specify as action

Enumerator String Definition	Description

TransactionResult

Transaction execution results

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

	Type	Require	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

AcquireAction

Acquire Action

	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", "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
request	string		✓		~ 1048576 chars	JSON of request