> For the complete documentation index, see [llms.txt](/llms.txt)
# GS2-Quest Deploy/CDK Reference
The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
## Entities
Resources managed by the Deploy operation
### Namespace
Namespace
A Namespace allows multiple independent instances of the same service within a single project by separating data spaces and usage contexts.
Each GS2 service is managed on a per-namespace basis. Even when using the same service, if the Namespace differs, the data is treated as a completely independent data space.
Therefore, you must create a Namespace before you can start using each service.
#### Request
Resource creation and update requests
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| name | string | | ✓| | ~ 128 chars | Namespace name
Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| description | string | | | | ~ 1024 chars | Description |
| transactionSetting | [TransactionSetting](#transactionsetting) | | ✓| | | Transaction Setting
Configuration for controlling how transactions are processed when granting quest rewards. |
| startQuestScript | [ScriptSetting](#scriptsetting) | | | | | Script setting to be executed when the quest is started
Script Trigger Reference - [`startQuest`](../script/#startquest) |
| completeQuestScript | [ScriptSetting](#scriptsetting) | | | | | Script setting to be executed when a quest is completed
Script Trigger Reference - [`completeQuest`](../script/#completequest) |
| failedQuestScript | [ScriptSetting](#scriptsetting) | | | | | Script setting to be executed when a quest fails
Script Trigger Reference - [`failedQuest`](../script/#failedquest) |
| logSetting | [LogSetting](#logsetting) | | | | | Log Output Setting
Specifies the GS2-Log Namespace for outputting API request and response logs. Used for tracking quest start, completion, and failure events. |
#### GetAttr
Resource creation results that can be retrieved using the [!GetAttr](/articles/tech/deploy/#getattr) tag
| | Type | Description |
| --- | --- | --- |
| Item | [Namespace](../sdk#namespace) | Namespace created
#### Implementation Example
**GS2-Deploy(YAML)**
```yaml
Type: GS2::Quest::Namespace
Properties:
Name: namespace-0001
Description: null
TransactionSetting:
EnableAutoRun: true
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
StartQuestScript: null
CompleteQuestScript: null
FailedQuestScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
```
**Go**
```go
import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/quest"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
quest.NewNamespace(
&SampleStack,
"namespace-0001",
quest.NamespaceOptions{
TransactionSetting: core.NewTransactionSetting(
core.TransactionSettingOptions{
QueueNamespaceId: pointy.String("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"),
},
),
LogSetting: &core.LogSetting{
LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
},
},
)
println(SampleStack.Yaml()) // Generate Template
```
**PHP**
```php
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
new \Gs2Cdk\Quest\Model\Namespace_(
stack: $this,
name: "namespace-0001",
options: new \Gs2Cdk\Quest\Model\Options\NamespaceOptions(
transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
new \Gs2Cdk\Core\Model\TransactionSettingOptions(
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
)
),
logSetting: new \Gs2Cdk\Core\Model\LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
)
);
}
}
print((new SampleStack())->yaml()); // Generate Template
```
**Java**
```java
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.quest.model.Namespace(
this,
"namespace-0001",
new io.gs2.cdk.quest.model.options.NamespaceOptions()
.withTransactionSetting(new io.gs2.cdk.core.model.TransactionSetting(
new io.gs2.cdk.core.model.options.TransactionSettingOptions()
.withQueueNamespaceId("grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001")
))
.withLogSetting(new io.gs2.cdk.core.model.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
))
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
```
**C#**
```csharp
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Quest.Model.Namespace(
stack: this,
name: "namespace-0001",
options: new Gs2Cdk.Gs2Quest.Model.Options.NamespaceOptions
{
transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
options: new Gs2Cdk.Core.Model.TransactionSettingOptions
{
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
```
**TypeScript**
```typescript
import core from "@/gs2cdk/core";
import quest from "@/gs2cdk/quest";
class SampleStack extends core.Stack
{
public constructor() {
super();
new quest.model.Namespace(
this,
"namespace-0001",
{
transactionSetting: new core.TransactionSetting(
{
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
}
),
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
```
**Python**
```python
from gs2_cdk import Stack, core, quest
class SampleStack(Stack):
def __init__(self):
super().__init__()
quest.Namespace(
stack=self,
name='namespace-0001',
options=quest.NamespaceOptions(
transaction_setting=core.TransactionSetting(
options=core.TransactionSettingOptions(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
)
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Template
```
#### TransactionSetting
Transaction Setting
Transaction Setting controls execution methods, consistency, asynchronous processing, and conflict avoidance mechanisms of transactions.
Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous processing of Acquire Actions via GS2-JobQueue enables robust transaction management tailored to game logic.
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| enableAutoRun | bool | | | false | | Whether to automatically execute issued transactions on the server side |
| enableAtomicCommit | bool | {enableAutoRun} == true | | false | | Whether to commit transactions atomically
* Enabled only if enableAutoRun is true |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | | false | | Whether to execute transactions asynchronously
* Enabled only if enableAtomicCommit is true |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | | false | | Whether to execute the commit processing of the script result asynchronously
* Enabled only if transactionUseDistributor is true |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | | false | | Whether to use GS2-JobQueue to execute the acquire action
* Enabled only if enableAtomicCommit is true |
| distributorNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:distributor:default" | ~ 1024 chars | GS2-Distributor Namespace GRN used to execute transactions |
| queueNamespaceId | string | | | "grn:gs2:{region}:{ownerId}:queue:default" | ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute transactions |
#### ScriptSetting
Script Setting
In GS2, you can associate custom scripts with microservice events and execute them.
This model holds the settings for triggering script execution.
There are two main ways to execute a script: synchronous execution and asynchronous execution.
Because synchronous execution blocks processing until the script finishes executing,
you can use the script result to stop the API execution or control the API response.
In contrast, asynchronous execution does not block processing until the script has finished executing.
However, because the script result cannot be used to stop the API execution or modify the API response,
asynchronous execution does not affect the API response flow and is generally recommended.
There are two types of asynchronous execution methods: GS2-Script and Amazon EventBridge.
By using Amazon EventBridge, you can write processing in languages other than Lua.
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| triggerScriptId | string | | | | ~ 1024 chars | GS2-Script script GRN executed synchronously when the API is executed
Must be specified in GRN format starting with "grn:gs2:". |
| doneTriggerTargetType | string (enum)
enum {
"none",
"gs2_script",
"aws"
}
| | | "none" | | Asynchronous script execution method
Specifies the type of script to use for asynchronous execution.
You can choose from "Do not use an asynchronous execution script (none)", "Use GS2-Script (gs2_script)", and "Use Amazon EventBridge (aws)"."none": None / "gs2_script": GS2-Script / "aws": Amazon EventBridge / |
| doneTriggerScriptId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024 chars | GS2-Script script GRN for asynchronous execution
Must be specified in GRN format starting with "grn:gs2:".
* Enabled only if doneTriggerTargetType is "gs2_script" |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == "gs2_script" | | | ~ 1024 chars | GS2-JobQueue Namespace GRN used to execute asynchronous scripts
If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue Namespace GRN.
GS2-JobQueue is generally not required unless you have a specific reason to use it.
* Enabled only if doneTriggerTargetType is "gs2_script" |
#### LogSetting
Log Output Setting
Log Output Setting defines how log data is exported. This type holds the GS2-Log Namespace identifier (Namespace ID), which is used to export log data.
Specify the GS2-Log Namespace where log data is collected and stored in the GRN format for the Log Namespace ID (loggingNamespaceId).
Configuring this setting ensures that log data for API requests and responses occurring within the specified Namespace is output to the target GS2-Log Namespace.
GS2-Log provides real-time logs that can be used for system monitoring, analysis, debugging, and other operational purposes.
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| loggingNamespaceId | string | | ✓ | | ~ 1024 chars | GS2-Log Namespace GRN to output logs
Must be specified in GRN format starting with "grn:gs2:". |
---
### CurrentQuestMaster
Currently active Quest Model master data
This master data defines the Quest Models currently active within the Namespace.
GS2 uses JSON format files for managing master data.
By uploading these files, you can apply the master data to the server.
To create JSON files, GS2 provides a master data editor within the management console.
Additionally, you can create tools better suited for game operations and export JSON files in the appropriate format.
**ℹ️ Note**
Please refer to [GS2-Quest Master Data Reference](api_reference/quest/master_data/) for the JSON file format.
#### Request
Resource creation and update requests
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| namespaceName | string | | ✓| | ~ 128 chars | Namespace name
Unique Namespace name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| mode | string (enum)
enum {
"direct",
"preUpload"
}
| | | "direct" | | Update mode"direct": Directly update master data / "preUpload": Upload master data and then update / |
| settings | string | {mode} == "direct" | ✓*| | ~ 5242880 bytes (5MB) | Master Data
* Required if mode is "direct" |
| uploadToken | string | {mode} == "preUpload" | ✓*| | ~ 1024 chars | Token obtained by pre-upload
Used to apply the uploaded master data.
* Required if mode is "preUpload" |
#### GetAttr
Resource creation results that can be retrieved using the [!GetAttr](/articles/tech/deploy/#getattr) tag
| | Type | Description |
| --- | --- | --- |
| Item | [CurrentQuestMaster](../sdk#currentquestmaster) | Updated master data of the currently active Quest Models
#### Implementation Example
**GS2-Deploy(YAML)**
```yaml
Type: GS2::Quest::CurrentQuestMaster
Properties:
NamespaceName: namespace-0001
Mode: direct
Settings: {
"version": "2019-05-14",
"groups": [
{
"name": "main",
"metadata": "MAIN",
"quests": [
{
"name": "1-1",
"metadata": "stage1-1",
"contents": [
{
"metadata": "normal",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expiresAt": 0,
"createNewItemSet": false,
"itemSetName": "",
"userId": "#{userId}"
}
}
],
"weight": 99
},
{
"metadata": "rare",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expiresAt": 0,
"createNewItemSet": false,
"itemSetName": "",
"userId": "#{userId}"
}
}
],
"weight": 1
}
],
"consumeActions": [
{
"action": "Gs2Stamina:ConsumeStaminaByUserId",
"request": {
"namespaceName": "basic",
"staminaName": "quest",
"userId": "#{userId}",
"consumeValue": 5
}
}
],
"failedAcquireActions": [
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "basic",
"staminaName": "quest",
"userId": "#{userId}",
"recoverValue": 5
}
}
],
"premiseQuestNames": [
]
},
{
"name": "1-2",
"metadata": "stage1-2",
"contents": [
{
"metadata": "normal",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expiresAt": 0,
"createNewItemSet": false,
"itemSetName": "",
"userId": "#{userId}"
}
}
],
"weight": 98
},
{
"metadata": "rare",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30,
"truncateExperienceWhenRankUp": false,
"userId": "#{userId}"
}
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expiresAt": 0,
"createNewItemSet": false,
"itemSetName": "",
"userId": "#{userId}"
}
}
],
"weight": 2
}
],
"consumeActions": [
{
"action": "Gs2Stamina:ConsumeStaminaByUserId",
"request": {
"namespaceName": "basic",
"staminaName": "quest",
"consumeValue": 5,
"userId": "#{userId}"
}
}
],
"failedAcquireActions": [
{
"action": "Gs2Stamina:RecoverStaminaByUserId",
"request": {
"namespaceName": "basic",
"staminaName": "quest",
"userId": "#{userId}",
"recoverValue": 5
}
}
],
"premiseQuestNames": [
"1-1"
]
}
]
},
{
"name": "sub",
"metadata": "SUB",
"quests": [
{
"name": "1-1",
"metadata": "stage1-1",
"contents": [
{
"metadata": "normal",
"completeAcquireActions": [
{
"action": "Gs2JobQueue:PushByUserId",
"request": {
"namespaceName": "queue-0001",
"userId": "#{userId}",
"jobs": [{'scriptId': 'script-0001', 'args': {}, 'maxTryCount': 3}]
}
}
],
"weight": 1
}
],
"premiseQuestNames": [
]
}
]
}
]
}
UploadToken: null
```
**Go**
```go
import (
"github.com/gs2io/gs2-golang-cdk/core"
"github.com/gs2io/gs2-golang-cdk/quest"
"github.com/gs2io/gs2-golang-cdk/experience"
"github.com/gs2io/gs2-golang-cdk/inventory"
"github.com/gs2io/gs2-golang-cdk/stamina"
"github.com/openlyinc/pointy"
)
SampleStack := core.NewStack()
quest.NewNamespace(
&SampleStack,
"namespace-0001",
quest.NamespaceOptions{},
).MasterData(
[]quest.QuestGroupModel{
quest.NewQuestGroupModel(
"main",
quest.QuestGroupModelOptions{
Metadata: pointy.String("MAIN"),
Quests: []quest.QuestModel{
quest.NewQuestModel(
"1-1",
[]quest.Contents{
quest.NewContents(
99,
quest.ContentsOptions{
Metadata: pointy.String("normal"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
inventory.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
pointy.Int64(0),
pointy.Bool(false),
pointy.String(""),
),
},
},
),
quest.NewContents(
1,
quest.ContentsOptions{
Metadata: pointy.String("rare"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
inventory.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
pointy.Int64(0),
pointy.Bool(false),
pointy.String(""),
),
},
},
),
},
quest.QuestModelOptions{
Metadata: pointy.String("stage1-1"),
ConsumeActions: []core.ConsumeAction{
stamina.ConsumeStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
FailedAcquireActions: []core.AcquireAction{
stamina.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
PremiseQuestNames: []string{},
},
),
quest.NewQuestModel(
"1-2",
[]quest.Contents{
quest.NewContents(
98,
quest.ContentsOptions{
Metadata: pointy.String("normal"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
inventory.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
pointy.Int64(0),
pointy.Bool(false),
pointy.String(""),
),
},
},
),
quest.NewContents(
2,
quest.ContentsOptions{
Metadata: pointy.String("rare"),
CompleteAcquireActions: []core.AcquireAction{
experience.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
pointy.Int64(30),
pointy.Bool(false),
),
inventory.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
pointy.Int64(0),
pointy.Bool(false),
pointy.String(""),
),
},
},
),
},
quest.QuestModelOptions{
Metadata: pointy.String("stage1-2"),
ConsumeActions: []core.ConsumeAction{
stamina.ConsumeStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
FailedAcquireActions: []core.AcquireAction{
stamina.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
),
},
PremiseQuestNames: []string{
"1-1",
},
},
),
},
},
),
quest.NewQuestGroupModel(
"sub",
quest.QuestGroupModelOptions{
Metadata: pointy.String("SUB"),
Quests: []quest.QuestModel{
quest.NewQuestModel(
"1-1",
[]quest.Contents{
quest.NewContents(
1,
quest.ContentsOptions{
Metadata: pointy.String("normal"),
CompleteAcquireActions: []core.AcquireAction{
jobQueue.PushByUserId(
"queue-0001",
&[]jobQueue.JobEntry{ jobQueue.NewJobEntry("script-0001", "", 3, jobQueue.JobEntryOptions{},), },
),
},
},
),
},
quest.QuestModelOptions{
Metadata: pointy.String("stage1-1"),
PremiseQuestNames: []string{},
},
),
},
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
```
**PHP**
```php
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Quest\Model\Namespace_(
stack: $this,
name: "namespace-0001"
))->masterData(
[
new \Gs2Cdk\Quest\Model\QuestGroupModel(
name:"main",
options: new \Gs2Cdk\Quest\Model\Options\QuestGroupModelOptions(
metadata:"MAIN",
quests:[
new \Gs2Cdk\Quest\Model\QuestModel(
name: "1-1",
contents: [
new \Gs2Cdk\Quest\Model\Contents(
weight: 99,
options: new \Gs2Cdk\Quest\Model\Options\ContentsOptions(
metadata: "normal",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
expiresAt: 0,
createNewItemSet: false,
itemSetName: "",
userId: "#{userId}"
),
],
),
),
new \Gs2Cdk\Quest\Model\Contents(
weight: 1,
options: new \Gs2Cdk\Quest\Model\Options\ContentsOptions(
metadata: "rare",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
expiresAt: 0,
createNewItemSet: false,
itemSetName: "",
userId: "#{userId}"
),
],
),
),
],
options: new \Gs2Cdk\Quest\Model\Options\QuestModelOptions(
metadata: "stage1-1",
consumeActions: [
new \Gs2Cdk\Stamina\StampSheet\ConsumeStaminaByUserId(
namespaceName: "basic",
staminaName: "quest",
userId: "#{userId}",
consumeValue: 5
),
],
failedAcquireActions: [
new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
namespaceName: "basic",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 5
),
],
premiseQuestNames: [],
),
),
new \Gs2Cdk\Quest\Model\QuestModel(
name: "1-2",
contents: [
new \Gs2Cdk\Quest\Model\Contents(
weight: 98,
options: new \Gs2Cdk\Quest\Model\Options\ContentsOptions(
metadata: "normal",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
expiresAt: 0,
createNewItemSet: false,
itemSetName: "",
userId: "#{userId}"
),
],
),
),
new \Gs2Cdk\Quest\Model\Contents(
weight: 2,
options: new \Gs2Cdk\Quest\Model\Options\ContentsOptions(
metadata: "rare",
completeAcquireActions: [
new \Gs2Cdk\Experience\StampSheet\AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
expiresAt: 0,
createNewItemSet: false,
itemSetName: "",
userId: "#{userId}"
),
],
),
),
],
options: new \Gs2Cdk\Quest\Model\Options\QuestModelOptions(
metadata: "stage1-2",
consumeActions: [
new \Gs2Cdk\Stamina\StampSheet\ConsumeStaminaByUserId(
namespaceName: "basic",
staminaName: "quest",
consumeValue: 5,
userId: "#{userId}"
),
],
failedAcquireActions: [
new \Gs2Cdk\Stamina\StampSheet\RecoverStaminaByUserId(
namespaceName: "basic",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 5
),
],
premiseQuestNames: [
"1-1",
],
),
),
]
)
),
new \Gs2Cdk\Quest\Model\QuestGroupModel(
name:"sub",
options: new \Gs2Cdk\Quest\Model\Options\QuestGroupModelOptions(
metadata:"SUB",
quests:[
new \Gs2Cdk\Quest\Model\QuestModel(
name: "1-1",
contents: [
new \Gs2Cdk\Quest\Model\Contents(
weight: 1,
options: new \Gs2Cdk\Quest\Model\Options\ContentsOptions(
metadata: "normal",
completeAcquireActions: [
new \Gs2Cdk\JobQueue\StampSheet\PushByUserId(
namespaceName: "queue-0001",
jobs: [ new \Gs2Cdk\JobQueue\Model\JobEntry(scriptId: "script-0001", args: "", maxTryCount: 3)],
userId: "#{userId}"
),
],
),
),
],
options: new \Gs2Cdk\Quest\Model\Options\QuestModelOptions(
metadata: "stage1-1",
premiseQuestNames: [],
),
),
]
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
```
**Java**
```java
class SampleStack extends io.gs2.cdk.core.model.Stack
{
public SampleStack() {
super();
new io.gs2.cdk.quest.model.Namespace(
this,
"namespace-0001"
).masterData(
Arrays.asList(
new io.gs2.cdk.quest.model.QuestGroupModel(
"main",
new io.gs2.cdk.quest.model.options.QuestGroupModelOptions()
.withMetadata("MAIN")
.withQuests(Arrays.asList(
new io.gs2.cdk.quest.model.QuestModel(
"1-1",
Arrays.asList(
new io.gs2.cdk.quest.model.Contents(
99,
new io.gs2.cdk.quest.model.options.ContentsOptions()
.withMetadata("normal")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
),
new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1L,
0L,
false,
"",
"#{userId}"
)
))
),
new io.gs2.cdk.quest.model.Contents(
1,
new io.gs2.cdk.quest.model.options.ContentsOptions()
.withMetadata("rare")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
),
new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1L,
0L,
false,
"",
"#{userId}"
)
))
)
),
new io.gs2.cdk.quest.model.options.QuestModelOptions()
.withMetadata("stage1-1")
.withConsumeActions(Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.ConsumeStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}"
)
))
.withFailedAcquireActions(Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}"
)
))
.withPremiseQuestNames(new ArrayList())
),
new io.gs2.cdk.quest.model.QuestModel(
"1-2",
Arrays.asList(
new io.gs2.cdk.quest.model.Contents(
98,
new io.gs2.cdk.quest.model.options.ContentsOptions()
.withMetadata("normal")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
),
new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1L,
0L,
false,
"",
"#{userId}"
)
))
),
new io.gs2.cdk.quest.model.Contents(
2,
new io.gs2.cdk.quest.model.options.ContentsOptions()
.withMetadata("rare")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30L,
false,
"#{userId}"
),
new io.gs2.cdk.inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1L,
0L,
false,
"",
"#{userId}"
)
))
)
),
new io.gs2.cdk.quest.model.options.QuestModelOptions()
.withMetadata("stage1-2")
.withConsumeActions(Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.ConsumeStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}"
)
))
.withFailedAcquireActions(Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
"#{userId}"
)
))
.withPremiseQuestNames(Arrays.asList(
"1-1"
))
)
))
),
new io.gs2.cdk.quest.model.QuestGroupModel(
"sub",
new io.gs2.cdk.quest.model.options.QuestGroupModelOptions()
.withMetadata("SUB")
.withQuests(Arrays.asList(
new io.gs2.cdk.quest.model.QuestModel(
"1-1",
Arrays.asList(
new io.gs2.cdk.quest.model.Contents(
1,
new io.gs2.cdk.quest.model.options.ContentsOptions()
.withMetadata("normal")
.withCompleteAcquireActions(Arrays.asList(
new io.gs2.cdk.jobQueue.stampSheet.PushByUserId(
"queue-0001",
Arrays.asList(new io.gs2.cdk.jobQueue.model.JobEntry("script-0001", "", 3)),
"#{userId}"
)
))
)
),
new io.gs2.cdk.quest.model.options.QuestModelOptions()
.withMetadata("stage1-1")
.withPremiseQuestNames(new ArrayList())
)
))
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Template
```
**C#**
```csharp
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Quest.Model.Namespace(
stack: this,
name: "namespace-0001"
).MasterData(
new Gs2Cdk.Gs2Quest.Model.QuestGroupModel[] {
new Gs2Cdk.Gs2Quest.Model.QuestGroupModel(
name: "main",
options: new Gs2Cdk.Gs2Quest.Model.Options.QuestGroupModelOptions
{
metadata = "MAIN",
quests = new Gs2Cdk.Gs2Quest.Model.QuestModel[]
{
new Gs2Cdk.Gs2Quest.Model.QuestModel(
name: "1-1",
contents: new Gs2Cdk.Gs2Quest.Model.Contents[]
{
new Gs2Cdk.Gs2Quest.Model.Contents(
weight: 99,
options: new Gs2Cdk.Gs2Quest.Model.Options.ContentsOptions
{
metadata = "normal",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
expiresAt: 0,
createNewItemSet: false,
itemSetName: "",
userId: "#{userId}"
)
}
}
),
new Gs2Cdk.Gs2Quest.Model.Contents(
weight: 1,
options: new Gs2Cdk.Gs2Quest.Model.Options.ContentsOptions
{
metadata = "rare",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
expiresAt: 0,
createNewItemSet: false,
itemSetName: "",
userId: "#{userId}"
)
}
}
)
},
options: new Gs2Cdk.Gs2Quest.Model.Options.QuestModelOptions
{
metadata = "stage1-1",
consumeActions = new Gs2Cdk.Core.Model.ConsumeAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.ConsumeStaminaByUserId(
namespaceName: "basic",
staminaName: "quest",
userId: "#{userId}",
consumeValue: 5
)
},
failedAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
namespaceName: "basic",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 5
)
},
premiseQuestNames = new string[] {}
}
),
new Gs2Cdk.Gs2Quest.Model.QuestModel(
name: "1-2",
contents: new Gs2Cdk.Gs2Quest.Model.Contents[]
{
new Gs2Cdk.Gs2Quest.Model.Contents(
weight: 98,
options: new Gs2Cdk.Gs2Quest.Model.Options.ContentsOptions
{
metadata = "normal",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
expiresAt: 0,
createNewItemSet: false,
itemSetName: "",
userId: "#{userId}"
)
}
}
),
new Gs2Cdk.Gs2Quest.Model.Contents(
weight: 2,
options: new Gs2Cdk.Gs2Quest.Model.Options.ContentsOptions
{
metadata = "rare",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Experience.StampSheet.AddExperienceByUserId(
namespaceName: "namespace-0001",
experienceName: "player",
propertyId: "player",
experienceValue: 30,
truncateExperienceWhenRankUp: false,
userId: "#{userId}"
),
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
expiresAt: 0,
createNewItemSet: false,
itemSetName: "",
userId: "#{userId}"
)
}
}
)
},
options: new Gs2Cdk.Gs2Quest.Model.Options.QuestModelOptions
{
metadata = "stage1-2",
consumeActions = new Gs2Cdk.Core.Model.ConsumeAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.ConsumeStaminaByUserId(
namespaceName: "basic",
staminaName: "quest",
consumeValue: 5,
userId: "#{userId}"
)
},
failedAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2Stamina.StampSheet.RecoverStaminaByUserId(
namespaceName: "basic",
staminaName: "quest",
userId: "#{userId}",
recoverValue: 5
)
},
premiseQuestNames = new string[]
{
"1-1"
}
}
)
}
}
),
new Gs2Cdk.Gs2Quest.Model.QuestGroupModel(
name: "sub",
options: new Gs2Cdk.Gs2Quest.Model.Options.QuestGroupModelOptions
{
metadata = "SUB",
quests = new Gs2Cdk.Gs2Quest.Model.QuestModel[]
{
new Gs2Cdk.Gs2Quest.Model.QuestModel(
name: "1-1",
contents: new Gs2Cdk.Gs2Quest.Model.Contents[]
{
new Gs2Cdk.Gs2Quest.Model.Contents(
weight: 1,
options: new Gs2Cdk.Gs2Quest.Model.Options.ContentsOptions
{
metadata = "normal",
completeAcquireActions = new Gs2Cdk.Core.Model.AcquireAction[]
{
new Gs2Cdk.Gs2JobQueue.StampSheet.PushByUserId(
namespaceName: "queue-0001",
jobs: new [] { new Gs2Cdk.Gs2JobQueue.Model.JobEntry(scriptId: "script-0001", args: "", maxTryCount: 3) },
userId: "#{userId}"
)
}
}
)
},
options: new Gs2Cdk.Gs2Quest.Model.Options.QuestModelOptions
{
metadata = "stage1-1",
premiseQuestNames = new string[] {}
}
)
}
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Template
```
**TypeScript**
```typescript
import core from "@/gs2cdk/core";
import quest from "@/gs2cdk/quest";
class SampleStack extends core.Stack
{
public constructor() {
super();
new quest.model.Namespace(
this,
"namespace-0001",
).masterData(
[
new quest.model.QuestGroupModel(
"main",
{
metadata: "MAIN",
quests: [
new quest.model.QuestModel(
"1-1",
[
new quest.model.Contents(
99,
{
metadata: "normal",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
0,
false,
"",
null,
"#{userId}"
),
]
}
),
new quest.model.Contents(
1,
{
metadata: "rare",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
0,
false,
"",
null,
"#{userId}"
),
]
}
),
],
{
metadata: "stage1-1",
consumeActions: [
new stamina.stampSheet.ConsumeStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
],
failedAcquireActions: [
new stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
],
premiseQuestNames: []
}
),
new quest.model.QuestModel(
"1-2",
[
new quest.model.Contents(
98,
{
metadata: "normal",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
0,
false,
"",
null,
"#{userId}"
),
]
}
),
new quest.model.Contents(
2,
{
metadata: "rare",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30,
false,
null,
"#{userId}"
),
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
0,
false,
"",
null,
"#{userId}"
),
]
}
),
],
{
metadata: "stage1-2",
consumeActions: [
new stamina.stampSheet.ConsumeStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
],
failedAcquireActions: [
new stamina.stampSheet.RecoverStaminaByUserId(
"namespace-0001",
"quest",
5,
null,
"#{userId}"
),
],
premiseQuestNames: [
"1-1",
]
}
),
]
}
),
new quest.model.QuestGroupModel(
"sub",
{
metadata: "SUB",
quests: [
new quest.model.QuestModel(
"1-1",
[
new quest.model.Contents(
1,
{
metadata: "normal",
completeAcquireActions: [
new jobQueue.stampSheet.PushByUserId(
"namespace-0001",
[ new jobQueue.model.JobEntry( "script-0001", "", 3) ],
"#{userId}"
),
]
}
),
],
{
metadata: "stage1-1",
premiseQuestNames: []
}
),
]
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
```
**Python**
```python
from gs2_cdk import Stack, core, quest, job_queue
class SampleStack(Stack):
def __init__(self):
super().__init__()
quest.Namespace(
stack=self,
name="namespace-0001",
).master_data(
groups=[
quest.QuestGroupModel(
name='main',
options=quest.QuestGroupModelOptions(
metadata = 'MAIN',
quests = [
quest.QuestModel(
name='1-1',
contents=[
quest.Contents(
weight=99,
options=quest.ContentsOptions(
metadata='normal',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
expires_at=0,
create_new_item_set=False,
item_set_name="",
user_id='#{userId}'
),
],
),
),
quest.Contents(
weight=1,
options=quest.ContentsOptions(
metadata='rare',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
expires_at=0,
create_new_item_set=False,
item_set_name="",
user_id='#{userId}'
),
],
),
),
],
options=quest.QuestModelOptions(
metadata='stage1-1',
consume_actions=[
stamina.ConsumeStaminaByUserId(
namespace_name='basic',
stamina_name='quest',
user_id='#{userId}',
consume_value=5
),
],
failed_acquire_actions=[
stamina.RecoverStaminaByUserId(
namespace_name='basic',
stamina_name='quest',
user_id='#{userId}',
recover_value=5
),
],
premise_quest_names=[],
),
),
quest.QuestModel(
name='1-2',
contents=[
quest.Contents(
weight=98,
options=quest.ContentsOptions(
metadata='normal',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
expires_at=0,
create_new_item_set=False,
item_set_name="",
user_id='#{userId}'
),
],
),
),
quest.Contents(
weight=2,
options=quest.ContentsOptions(
metadata='rare',
complete_acquire_actions=[
experience.AddExperienceByUserId(
namespace_name='namespace-0001',
experience_name='player',
property_id='player',
experience_value=30,
truncate_experience_when_rank_up=False,
user_id='#{userId}'
),
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
expires_at=0,
create_new_item_set=False,
item_set_name="",
user_id='#{userId}'
),
],
),
),
],
options=quest.QuestModelOptions(
metadata='stage1-2',
consume_actions=[
stamina.ConsumeStaminaByUserId(
namespace_name='basic',
stamina_name='quest',
consume_value=5,
user_id='#{userId}'
),
],
failed_acquire_actions=[
stamina.RecoverStaminaByUserId(
namespace_name='basic',
stamina_name='quest',
user_id='#{userId}',
recover_value=5
),
],
premise_quest_names=[
'1-1',
],
),
),
]
),
),
quest.QuestGroupModel(
name='sub',
options=quest.QuestGroupModelOptions(
metadata = 'SUB',
quests = [
quest.QuestModel(
name='1-1',
contents=[
quest.Contents(
weight=1,
options=quest.ContentsOptions(
metadata='normal',
complete_acquire_actions=[
job_queue.PushByUserId(
namespace_name='queue-0001',
jobs=[{'scriptId': 'script-0001', 'args': {}, 'maxTryCount': 3}],
user_id='#{userId}'
),
],
),
),
],
options=quest.QuestModelOptions(
metadata='stage1-1',
premise_quest_names=[],
),
),
]
),
),
],
)
print(SampleStack().yaml()) # Generate Template
```
#### 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 | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| questGroupModelId | string | | * | | ~ 1024 chars | Quest Group Model GRN
* Set automatically by the server |
| name | string | | ✓ | | ~ 128 chars | Quest Group Model name
Unique Quest Group Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| metadata | string | | | | ~ 1024 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. |
| quests | [List<QuestModel>](#questmodel) | | | [] | 0 ~ 1000 items | Quests belonging to the group
List of quest models that belong to this quest group. Only one quest within the group can be in progress at a time. |
| challengePeriodEventId | string | | | | ~ 1024 chars | Challenge Period Event GRN
GS2-Schedule event GRN that sets the time period during which quests in this group can be attempted. When specified, quests in this group can only be started while the event is active. |
#### QuestModel
Quest Model
A Quest Model is an entity that defines the cost required to start a quest and the rewards obtained upon completion.
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 | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| questModelId | string | | * | | ~ 1024 chars | Quest Model GRN
* Set automatically by the server |
| name | string | | ✓ | | ~ 128 chars | Quest Model name
Unique Quest Model name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). |
| metadata | string | | | | ~ 1024 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. |
| contents | [List<Contents>](#contents) | | | [] | 1 ~ 10 items | Quest content variations
List of content variations for this quest. When the quest starts, one variation is selected by weighted random draw. Each variation can define different completion rewards, allowing different outcomes (e.g., rare monster appearances) for the same quest. |
| challengePeriodEventId | string | | | | ~ 1024 chars | Challenge Period Event GRN
GS2-Schedule event GRN that sets the time period during which this quest can be attempted. When specified, the quest can only be started while the event is active. This setting takes precedence over the quest group's challenge period. |
| firstCompleteAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 10 items | First Completion Acquire Actions
List of acquire actions executed only on the first completion of this quest. These are bonus rewards granted in addition to the normal completion rewards, useful for first-clear bonuses. |
| verifyActions | [List<VerifyAction>](#verifyaction) | | | [] | 0 ~ 10 items | List of Verify Actions
List of verify actions that serve as preconditions for starting this quest. All verify actions must pass before the quest can begin. Used to enforce requirements such as level checks or item possession. |
| consumeActions | [List<ConsumeAction>](#consumeaction) | | | [] | 0 ~ 10 items | List of Acquire Actions
Consume actions executed as the cost of starting this quest. These are consumed when the quest begins, such as stamina or currency costs. |
| failedAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 100 items | Failed Acquire Actions
Acquire actions executed when the quest fails. Used to provide consolation rewards or partial refunds of the quest participation cost upon failure. |
| premiseQuestNames | List<string> | | | [] | 0 ~ 10 items | Prerequisite Quest Names
List of quest names within the same group that must be completed before this quest can be attempted. Used to create sequential quest chains or branching quest paths. |
#### Contents
Contents
Represents one variation of quest content. Each quest can have multiple content variations with different rewards, and one is selected by weighted random draw at quest start. The metadata supports template variable substitution with user ID and config values.
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| metadata | string | | | | ~ 256 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. |
| completeAcquireActions | [List<AcquireAction>](#acquireaction) | | | [] | 0 ~ 10 items | Complete Acquire Actions
Acquire actions executed as rewards when the quest is completed with this content variation. These define the actual rewards the player receives upon clearing the quest. |
| weight | int | | | 1 | 1 ~ 2147483646 | Draw Weight
The relative weight used in the random selection of this content variation at quest start. Higher values increase the probability of this variation being selected. For example, a variation with weight 9 is 9 times more likely to be selected than one with weight 1. |
#### AcquireAction
Acquire Action
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| action | string (enum)
enum {
}
| | ✓ | | | Type of Acquire Action |
| request | string | | ✓ | | ~ 524288 chars | JSON string of the request used when executing the action |
#### ConsumeAction
Consume Action
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| action | string (enum)
enum {
}
| | ✓ | | | Type of Consume Action |
| request | string | | ✓ | | ~ 524288 chars | JSON string of the request used when executing the action |
#### VerifyAction
Verify Action
| | Type | Condition | Required | Default | Value Limits | Description |
| --- | --- | --- | --- | --- | --- | --- |
| action | string (enum)
enum {
}
| | ✓ | | | Type of Verify Action |
| request | string | | ✓ | | ~ 524288 chars | JSON string of the request used when executing the action |
---