Master Data Reference of GS2-Limit
Reference of the format of master data and various models to be imported
Master Data Format
{
"version": "2019-04-05",
"limitModels": [
{
"name": "[string]Limit Model Name",
"metadata": "[string?]Metadata",
"resetType": "[string]Reset timing",
"resetDayOfMonth": "[int]Date to reset (If the value exceeds the days of the month, it is treated as the last day.)",
"resetDayOfWeek": "[string]Day of the week to reset",
"resetHour": "[int]Reset hour",
"anchorTimestamp": "[long]Base date and time for counting elapsed days",
"days": "[int]Number of days to reset"
}
]
}| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| version | string | ✓ | 2019-04-05 | Format version of master data | ||
| limitModels | List<LimitModel> | ~ 100 items | Limit Model You can set the timing for resetting the usage count for frequency limits. The reset interval can be selected from five options: “Daily”, “Weekly”, “Monthly”, “Fixed number of days” or “Not Reset”. Additionally, the maximum value for frequency limits is not fixed in the master data. This is to dynamically change the maximum allowed count based on the in-game context. For example, in a step-up gacha: - Items purchasable when the purchase counter is under 3 - When the above items are unavailable, another item purchasable if the purchase counter is under 5 The design assumes the ability to switch the “maximum count” based on the situation. |
Model
LimitModel
Limit Model
You can set the timing for resetting the usage count for frequency limits. The reset interval can be selected from five options: “Daily”, “Weekly”, “Monthly”, “Fixed number of days” or “Not Reset”.
Additionally, the maximum value for frequency limits is not fixed in the master data. This is to dynamically change the maximum allowed count based on the in-game context. For example, in a step-up gacha:
- Items purchasable when the purchase counter is under 3
- When the above items are unavailable, another item purchasable if the purchase counter is under 5
The design assumes the ability to switch the “maximum count” based on the situation.
| Type | Condition | Required | Default | Value Limits | Description | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| limitModelId | string | ✓* | ~ 1024 chars | Limit Model GRN * Automatically configured on the server | ||||||||||||||||||
| name | string | ✓ | ~ 128 chars | Limit Model Name | ||||||||||||||||||
| metadata | string | ~ 2048 chars | Metadata | |||||||||||||||||||
| resetType | String Enum enum { “notReset”, “daily”, “weekly”, “monthly”, “days” } | ✓ | Reset timing
| |||||||||||||||||||
| resetDayOfMonth | int | {resetType} == “monthly” | ✓* | 1 ~ 31 | Date to reset (If the value exceeds the days of the month, it is treated as the last day.) * Required if resetType is “monthly” | |||||||||||||||||
| resetDayOfWeek | String Enum enum { “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, “saturday” } | {resetType} == “weekly” | ✓* | Day of the week to reset
* Required if resetType is “weekly” | ||||||||||||||||||
| resetHour | int | {resetType} in [“monthly”, “weekly”, “daily”] | ✓* | 0 ~ 23 | Reset hour * Required if resetType is “monthly”,“weekly”,“daily” | |||||||||||||||||
| anchorTimestamp | long | {resetType} == “days” | ✓* | Base date and time for counting elapsed days Unix time, milliseconds * Required if resetType is “days” | ||||||||||||||||||
| days | int | {resetType} == “days” | ✓* | 1 ~ 2147483646 | Number of days to reset * Required if resetType is “days” |