Deploy/CDK Reference of GS2-Quest
The template format used when creating stacks with GS2-Deploy, and implementation examples of template output in various languages using CDK
Entity
Resources operated in Deploy process
Namespace
Namespace
A namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. 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 generation request
| Type | Condition | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| name | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||
| description | string | ~ 1024 chars | Description | |||
| transactionSetting | TransactionSetting | ✓ | Transaction settings | |||
| startQuestScript | ScriptSetting | Script setting to be executed when the quest is started | ||||
| completeQuestScript | ScriptSetting | Script setting to be executed when a quest is completed | ||||
| failedQuestScript | ScriptSetting | Script to run when a quest fails | ||||
| logSetting | LogSetting | Log output settings |
GetAttr
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | Namespace | Created namespace |
Implementation Example
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-0001import (
"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
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
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 Templatepublic 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 Templateimport 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
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 TemplateTransactionSetting
Transaction settings
Transaction settings control how transactions are executed, their consistency, asynchronous processing, and conflict avoidance mechanisms. Combining features like AutoRun, AtomicCommit, asynchronous execution using GS2-Distributor, batch application of script results, and asynchronous acquisition 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 the execution of transactions atomically * Required if enableAutoRun is true | |
| transactionUseDistributor | bool | {enableAtomicCommit} == true | ✓* | false | Whether to execute transactions asynchronously * Required if enableAtomicCommit is true | |
| commitScriptResultInUseDistributor | bool | {transactionUseDistributor} == true | ✓* | false | Whether to execute the commit processing of the script result asynchronously * Required if transactionUseDistributor is true | |
| acquireActionUseJobQueue | bool | {enableAtomicCommit} == true | ✓* | false | Whether to use GS2-JobQueue to execute the acquire action * Required if enableAtomicCommit is true | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024 chars | GS2-Distributor namespace GRN used for transaction execution | |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024 chars | Namespace GRN in GS2-JobQueue used to run the transaction |
ScriptSetting
Script settings
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. Synchronous execution blocks processing until the script has finished executing. Instead, you can use the script’s execution results to halt API execution or control the API’s response content.
In contrast, asynchronous execution does not block processing until the script has finished executing. Since the script result cannot be used to stop the API execution or modify the API response, asynchronous execution does not affect the API’s response flow. For this reason, asynchronous execution 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
for synchronous execution Must be specified in GRN format starting with “grn:gs2:”. | |||||||||||
| doneTriggerTargetType | String Enum enum { “none”, “gs2_script”, “aws” } | ✓ | “none” | How to execute asynchronous scripts Specifies the type of script to use for asynchronous execution. You can choose from “Do not use asynchronous execution scripts (none)”, “Use GS2-Script (gs2_script)”, and “Use Amazon EventBridge (aws)”.
| ||||||||||
| 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 if doneTriggerTargetType is “gs2_script” | ||||||||||
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024 chars | GS2-JobQueue namespace GRN
to execute asynchronous execution scripts If you want to execute asynchronous execution scripts via GS2-JobQueue instead of executing them directly, specify the GS2-JobQueue namespace GRN. There is little reason to use GS2-JobQueue, so you don’t need to specify it unless you have a specific reason. * Enabled if doneTriggerTargetType is “gs2_script” |
LogSetting
Log Export Settings
Manages log data export settings. This type holds the GS2-Log namespace identifier (Namespace ID) 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, and debugging.
| 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 Master Data
Currently active master data describing the quest model definitions within the namespace. GS2 uses JSON format files for managing master data. By uploading these files, the master data settings are updated on the server.
To create JSON files, GS2 provides a master data editor within the management console. Additionally, you can create tools better suited for operating your game and export JSON files in the appropriate format.
Note
Please refer to Master Data Reference of GS2-Quest for the JSON file format.Request
Resource generation request
| Type | Condition | Required | Default | Value Limits | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128 chars | Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.). | ||||||||
| mode | String Enum enum { “direct”, “preUpload” } | ✓ | “direct” | Update mode
| ||||||||
| settings | string | {mode} == “direct” | ✓* | ~ 5242880 chars | 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
Generation results of resources that can be obtained with the !GetAttr tag
| Type | Description | |
|---|---|---|
| Item | CurrentQuestMaster | Updated Currently Active Quest Model Master Data |
Implementation Example
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
}
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expireAt": null,
"createNewItemSet": false,
"itemSetName": null
}
}
],
"weight": 99
},
{
"metadata": "rare",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30
}
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expireAt": null,
"createNewItemSet": false,
"itemSetName": null
}
}
],
"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
}
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expireAt": null,
"createNewItemSet": false,
"itemSetName": null
}
}
],
"weight": 98
},
{
"metadata": "rare",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": {
"namespaceName": "namespace-0001",
"experienceName": "player",
"propertyId": "player",
"experienceValue": 30
}
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": {
"namespaceName": "namespace-0001",
"inventoryName": "inventory-0001",
"itemName": "item-0001",
"acquireCount": 1,
"expireAt": null,
"createNewItemSet": false,
"itemSetName": null
}
}
],
"weight": 2
}
],
"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": [
"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: nullimport (
"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{},
).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,
nil,
pointy.Bool(false),
nil,
),
},
},
),
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,
nil,
pointy.Bool(false),
nil,
),
},
},
),
},
quest.QuestModelOptions{
Metadata: pointy.String("stage1-1"),
ConsumeActions: []core.ConsumeAction{
stamina.ConsumeStaminaByUserId(
"basic",
"quest",
"#{userId}",
5,
),
},
FailedAcquireActions: []core.AcquireAction{
stamina.RecoverStaminaByUserId(
"basic",
"quest",
"#{userId}",
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,
nil,
pointy.Bool(false),
nil,
),
},
},
),
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,
nil,
pointy.Bool(false),
nil,
),
},
},
),
},
quest.QuestModelOptions{
Metadata: pointy.String("stage1-2"),
ConsumeActions: []core.ConsumeAction{
stamina.ConsumeStaminaByUserId(
"basic",
"quest",
"#{userId}",
5,
),
},
FailedAcquireActions: []core.AcquireAction{
stamina.RecoverStaminaByUserId(
"basic",
"quest",
"#{userId}",
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{
job_queue.PushByUserId(
"queue-0001",
"#{userId}",
[{'scriptId': 'script-0001', 'args': {}, 'maxTryCount': 3}],
),
},
},
),
},
quest.QuestModelOptions{
Metadata: pointy.String("stage1-1"),
PremiseQuestNames: []string{},
},
),
},
},
),
},
)
println(SampleStack.Yaml()) // Generate Template
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
),
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
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
),
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
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
),
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
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
),
new \Gs2Cdk\Inventory\StampSheet\AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
userId: "#{userId}"
),
],
)
),
],
options: new \Gs2Cdk\Quest\Model\Options\QuestModelOptions(
metadata: "stage1-2",
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: [
"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",
userId: "#{userId}",
jobs: [{'scriptId': 'script-0001', 'args': {}, 'maxTryCount': 3}]
),
],
)
),
],
options: new \Gs2Cdk\Quest\Model\Options\QuestModelOptions(
metadata: "stage1-1",
premiseQuestNames: [],
)
),
]
)
)
]
);
}
}
print((new SampleStack())->yaml()); // Generate Template
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(
"basic",
"quest",
"#{userId}",
5
)
))
.withFailedAcquireActions(Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"basic",
"quest",
"#{userId}",
5
)
))
.withPremiseQuestNames(new ArrayList<String>())
),
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(
"basic",
"quest",
"#{userId}",
5
)
))
.withFailedAcquireActions(Arrays.asList(
new io.gs2.cdk.stamina.stampSheet.RecoverStaminaByUserId(
"basic",
"quest",
"#{userId}",
5
)
))
.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",
"#{userId}",
[{'scriptId': 'script-0001', 'args': {}, 'maxTryCount': 3}]
)
))
)
),
new io.gs2.cdk.quest.model.options.QuestModelOptions()
.withMetadata("stage1-1")
.withPremiseQuestNames(new ArrayList<String>())
)
))
)
)
);
}
}
System.out.println(new SampleStack().yaml()); // Generate Templatepublic 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
),
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
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
),
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
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
),
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
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
),
new Gs2Cdk.Gs2Inventory.StampSheet.AcquireItemSetByUserId(
namespaceName: "namespace-0001",
inventoryName: "inventory-0001",
itemName: "item-0001",
acquireCount: 1,
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",
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[]
{
"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",
userId: "#{userId}",
jobs: [{'scriptId': 'script-0001', 'args': {}, 'maxTryCount': 3}]
)
}
}
)
},
options: new Gs2Cdk.Gs2Quest.Model.Options.QuestModelOptions
{
metadata = "stage1-1",
premiseQuestNames = new string[] {}
}
)
}
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate Templateimport 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
),
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
null,
null,
"#{userId}"
),
]
}
),
new quest.model.Contents(
1,
{
metadata: "rare",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30
),
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
null,
null,
"#{userId}"
),
]
}
),
],
{
metadata: "stage1-1",
consumeActions: [
new stamina.stampSheet.ConsumeStaminaByUserId(
"basic",
"quest",
"#{userId}",
5
),
],
failedAcquireActions: [
new stamina.stampSheet.RecoverStaminaByUserId(
"basic",
"quest",
"#{userId}",
5
),
],
premiseQuestNames: []
}
),
new quest.model.QuestModel(
"1-2",
[
new quest.model.Contents(
98,
{
metadata: "normal",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30
),
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
null,
null,
"#{userId}"
),
]
}
),
new quest.model.Contents(
2,
{
metadata: "rare",
completeAcquireActions: [
new experience.stampSheet.AddExperienceByUserId(
"namespace-0001",
"player",
"player",
30
),
new inventory.stampSheet.AcquireItemSetByUserId(
"namespace-0001",
"inventory-0001",
"item-0001",
1,
null,
null,
"#{userId}"
),
]
}
),
],
{
metadata: "stage1-2",
consumeActions: [
new stamina.stampSheet.ConsumeStaminaByUserId(
"basic",
"quest",
"#{userId}",
5
),
],
failedAcquireActions: [
new stamina.stampSheet.RecoverStaminaByUserId(
"basic",
"quest",
"#{userId}",
5
),
],
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(
"queue-0001",
"#{userId}",
[{'scriptId': 'script-0001', 'args': {}, 'maxTryCount': 3}]
),
]
}
),
],
{
metadata: "stage1-1",
premiseQuestNames: []
}
),
]
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
from gs2_cdk import Stack, core, quest
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
),
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
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
),
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
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
),
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
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
),
inventory.AcquireItemSetByUserId(
namespace_name='namespace-0001',
inventory_name='inventory-0001',
item_name='item-0001',
acquire_count=1,
user_id='#{userId}'
),
],
),
),
],
options=quest.QuestModelOptions(
metadata='stage1-2',
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=[
'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',
user_id='#{userId}',
jobs=[{'scriptId': 'script-0001', 'args': {}, 'maxTryCount': 3}]
),
],
),
),
],
options=quest.QuestModelOptions(
metadata='stage1-1',
premise_quest_names=[],
),
),
]
),
),
],
)
print(SampleStack().yaml()) # Generate TemplateQuestGroupModel
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 GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Quest Group Model Name Quest Group Model-specific 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> | [] | 0 ~ 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 in-game 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 | Required | Default | Value Limits | Description | |
|---|---|---|---|---|---|---|
| questModelId | string | ✓* | ~ 1024 chars | Quest Model GRN * Automatically configured on the server | ||
| name | string | ✓ | ~ 128 chars | Quest Model Name Quest Model-specific 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> | ✓ | [] | 1 ~ 10 items | Quest content variations | |
| challengePeriodEventId | string | ~ 1024 chars | GS2-Schedule event GRN that sets the time period during which the quest can be attempted. | |||
| firstCompleteAcquireActions | List<AcquireAction> | [] | 0 ~ 10 items | List of First Clear Reward Actions | ||
| verifyActions | List<VerifyAction> | [] | 0 ~ 10 items | List of verification actions for quest participation conditions | ||
| consumeActions | List<ConsumeAction> | [] | 0 ~ 10 items | Quest entry fee | ||
| failedAcquireActions | List<AcquireAction> | [] | 0 ~ 100 items | Reward for quest failure | ||
| premiseQuestNames | List<string> | [] | 0 ~ 10 items | List of quest names that must be cleared beforehand to challenge a quest |
Contents
Contents
| 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> | [] | 0 ~ 10 items | Rewards for completing quests | ||
| weight | int | ✓ | 1 | 1 ~ 2147483646 | Weight to be drawn |
AcquireAction
Acquire Action
ConsumeAction
Consume Action
VerifyAction
Verify Action