Master Data Reference of GS2-Idle
{
"version": "2023-06-06",
"categoryModels": [
{
"name": "[string]Category Model Name",
"metadata": "[string?]metadata",
"rewardIntervalMinutes": "[int]Interval at which idle rewards can be obtained (minutes)",
"defaultMaximumIdleMinutes": "[int]Maximum time to get idle rewards (minutes)",
"acquireActions": [
{
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
]
}
],
"idlePeriodScheduleId": "[string?]GS2-Schedule event GRN with time period used for idle rewards calculation",
"receivePeriodScheduleId": "[string?]GS2-Schedule EventGRN that sets the period during which idle rewards can be obtained"
}
]
}
| Type | Condition | Require | Default | Limitation | Description |
---|
version | | | ✓ | 2023-06-06 | | Format version of master data |
categoryModels | List<CategoryModel> | | | | ~ 100 items | Category Model Master |
CategoryModel
Category Model Master
A category model is an entity that sets the idle category that can be obtained as a reward for leaving.
The settings include information such as the reward for each waiting time and the maximum idle time.
| Type | Condition | Require | Default | Limitation | Description |
---|
categoryModelId | string | | ✓ | | ~ 1024 chars | Category Model GRN |
name | string | | ✓ | | ~ 128 chars | Category Model Name |
metadata | string | | | | ~ 2048 chars | metadata |
rewardIntervalMinutes | int | | ✓ | | ~ 2147483646 | Interval at which idle rewards can be obtained (minutes) |
defaultMaximumIdleMinutes | int | | ✓ | | ~ 2147483646 | Maximum time to get idle rewards (minutes) |
acquireActions | List<AcquireActionList> | | ✓ | | 1 ~ 100 items | List of acquire actions for each waiting time |
idlePeriodScheduleId | string | | | | ~ 1024 chars | GS2-Schedule event GRN with time period used for idle rewards calculation |
receivePeriodScheduleId | string | | | | ~ 1024 chars | GS2-Schedule EventGRN that sets the period during which idle rewards can be obtained |
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 |
AcquireActionList
Acquisition Action List
| Type | Condition | Require | Default | Limitation | Description |
---|
acquireActions | List<AcquireAction> | | | | ~ 100 items | List of Acquire Action |