Master Data Reference of GS2-Quest
{
"version": "2019-05-14",
"groups": [
{
"name": "[string]Quest Group Name",
"metadata": "[string?]metadata",
"quests": [
{
"questModelId": "[string]Quest Model GRN",
"name": "[string]Quest Model Name",
"metadata": "[string?]metadata",
"contents": [
{
"metadata": "[string?]metadata",
"completeAcquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
],
"weight": "[int]Weight to be drawn"
}
],
"challengePeriodEventId": "[string?]GS2-Schedule event GRN that sets the time period during which the quest can be attempted.",
"firstCompleteAcquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
],
"verifyActions": [
{
"action": "[string]Types of actions to be performed in the verify task",
"request": "[string]JSON of request"
}
],
"consumeActions": [
{
"action": "[string]Types of actions to be performed in the consume action",
"request": "[string]JSON of request"
}
],
"failedAcquireActions": [
{
"action": "[string]Types of actions to be performed in the acquire action",
"request": "[string]JSON of request"
}
],
"premiseQuestNames": [
"[string]Quest Model Name"
]
}
],
"challengePeriodEventId": "[string?]GS2-Schedule event GRN that sets the time period during which the quest can be attempted."
}
]
}
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
version | ✓ | 2019-05-14 | Format version of master data | |||
groups | List<QuestGroupModel> | ~ 10 items | Quest Group Model |
Contents
Contents
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
metadata | string | ~ 256 chars | metadata | |||
completeAcquireActions | List<AcquireAction> | [] | ~ 10 items | Rewards for completing quests | ||
weight | int | ✓ | 1 | 1 ~ 2147483646 | Weight to be drawn |
Reward
Reward
QuestGroupModel
Quest Group Model
A quest group is an entity for grouping multiple quests, and only one quest progression can be executed simultaneously within the group. This means that if you need to be able to progress quests in parallel, you must separate the groups.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
questGroupModelId | string | ✓ | ~ 1024 chars | Quest Group GRN | ||
name | string | ✓ | ~ 128 chars | Quest Group Name | ||
metadata | string | ~ 1024 chars | metadata | |||
quests | List<QuestModel> | ~ 1000 items | Quests belonging to the group | |||
challengePeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN that sets the time period during which the quest can be attempted. |
QuestModel
Quest Model
A quest is an entity that holds the consideration required to start ingame and the reward for completing it.
The reward obtained upon completion of the quest can have multiple variations and can be drawn at the start of the quest. For example, the same content can be used to manage the clear flag of a quest, but two types of content can be prepared based on whether or not a rare monster appears.
Type | Condition | Require | Default | Limitation | Description | |
---|---|---|---|---|---|---|
questModelId | string | ✓ | ~ 1024 chars | Quest Model GRN | ||
name | string | ✓ | ~ 128 chars | Quest Model Name | ||
metadata | string | ~ 1024 chars | metadata | |||
contents | List<Contents> | ✓ | 1 ~ 10 items | Quest Description | ||
challengePeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN that sets the time period during which the quest can be attempted. | |||
firstCompleteAcquireActions | List<AcquireAction> | [] | ~ 10 items | List of First Clear Reward Actions | ||
verifyActions | List<VerifyAction> | [] | ~ 10 items | List of verification actions for quest participation conditions | ||
consumeActions | List<ConsumeAction> | [] | ~ 10 items | Quest entry fee | ||
failedAcquireActions | List<AcquireAction> | [] | ~ 100 items | Reward for quest failure | ||
premiseQuestNames | List<string> | [] | ~ 10 items | Name of the quest that must be completed in order to attempt the quest |
AcquireAction
Acquire Action
ConsumeAction
Consume Action
VerifyAction
Verify Action