Master Data Reference of GS2-Idle
Reference of the format of master data and various models to be imported
Master Data Format
{
"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)",
"rewardResetMode": "[string enum]Policy for resetting waiting time after receiving rewards",
"acquireActions": [
{
"acquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON string of the request used when executing the action"
}
]
}
],
"idlePeriodScheduleId": "[string?]GS2-Schedule event GRN with time period used for idle rewards calculation",
"receivePeriodScheduleId": "[string?]GS2-Schedule Event GRN that sets the period during which idle rewards can be obtained"
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2023-06-06 | Format version of master data | ||
| categoryModels | List<CategoryModel> | ~ 100 items | Category Model A Category Model is an entity that defines a waiting category in which idle rewards can be earned over time. The settings include information such as the reward for each waiting time and the maximum idle time. |
Model
CategoryModel
Category Model
A Category Model is an entity that defines a waiting category in which idle rewards can be earned over time. The settings include information such as the reward for each waiting time and the maximum idle time.
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| categoryModelId | string | ✓* | ~ 1024 chars | Category Model GRN * Required (system-assigned) | ||||||||
| name | string | ✓ | ~ 128 chars | Category Model name Category model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| metadata | string | ~ 2048 chars | Metadata Arbitrary values can be set in the metadata. Since they do not affect GS2’s behavior, they can be used to store information used in the game. | |||||||||
| rewardIntervalMinutes | int | ✓ | 0 ~ 2147483646 | Interval at which idle rewards can be obtained (minutes) | ||||||||
| defaultMaximumIdleMinutes | int | ✓ | 0 ~ 2147483646 | Maximum time to get idle rewards (minutes) | ||||||||
| rewardResetMode | String Enum enum { “Reset”, “CarryOver” } | ✓ | “Reset” | Policy for resetting waiting time after receiving rewards
| ||||||||
| acquireActions | List<AcquireActionList> | ✓ | [] | 1 ~ 100 items | List of acquire actions for each waiting time Assuming that the waiting time is “X minutes”, “X / rewardIntervalMinutes” will be the number of rewards that can be received, but by looping the elements specified in this array, different rewards can be given 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 Event GRN that sets the period during which idle rewards can be obtained |
AcquireActionList
Acquisition Action List
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| acquireActions | List<AcquireAction> | [] | 0 ~ 100 items | List of Acquire Action |
AcquireAction
Acquire Action