GS2-Quest GS2-Deploy/CDK リファレンス
エンティティ
Namespace
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| name | string | ✓ | ~ 128文字 | ネームスペース名 | |
| description | string | ~ 1024文字 | 説明文 | ||
| transactionSetting | TransactionSetting | ✓ | トランザクション設定 | ||
| startQuestScript | ScriptSetting | クエスト開始したときに実行するスクリプト | |||
| completeQuestScript | ScriptSetting | クエストクリアしたときに実行するスクリプト | |||
| failedQuestScript | ScriptSetting | クエスト失敗したときに実行するスクリプト | |||
| logSetting | LogSetting | ログの出力設定 |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | Namespace | 作成したネームスペース |
実装例
Type: GS2::Quest::Namespace
Properties:
Name: namespace1
Description: null
TransactionSetting:
EnableAutoRun: false
QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
StartQuestScript: null
CompleteQuestScript: null
FailedQuestScript: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1from 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(
queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
options=core.TransactionSettingOptions(
key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
)
),
log_setting=core.LogSetting(
logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
),
),
)
print(SampleStack().yaml()) # Generate Templateclass 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(
enableAutoRun: True,
queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-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() {
{
transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(){
{
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001";
},
new io.gs2.cdk.core.model.options.TransactionSettingOptions(
"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
)
);
logSetting = new io.gs2.cdk.core.model.LogSetting(
loggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
);
}
}
);
}
}
System.out.println(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(
,
"grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
{
"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
}
),
logSetting: new core.LogSetting(
"grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Quest.Model.Namespace(
this,
"namespace-0001",
new Gs2Cdk.Gs2Quest.Model.Options.NamespaceOptions {
transactionSetting = new Gs2Cdk.Core.Model.TransactionSetting(
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions {
queueNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001"
},
new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
}
),
logSetting = new Gs2Cdk.Core.Model.LogSetting(
LoggingNamespaceId = "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateCurrentQuestMaster
現在有効なマスターデータ
GS2ではマスターデータの管理にJSON形式のファイルを使用します。 ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。
JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますが よりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。
JSONファイルの形式についてはドキュメントを参照ください。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| namespaceName | string | ✓ | ~ 128文字 | ネームスペース名 | |
| settings | string | ✓ | ~ 5242880文字 | マスターデータ |
GetAttr
| 型 | 説明 | |
|---|---|---|
| Item | CurrentQuestMaster | 更新した現在有効なクエストマスター |
実装例
Type: GS2::Quest::CurrentQuestMaster
Properties:
NamespaceName: namespace1
Settings: {
"version": "2019-05-14",
"questGroupModels": [
{
"name": "main",
"metadata": "MAIN",
"quests": [
{
"name": "1-1",
"metadata": "stage1-1",
"contents": [
{
"metadata": "normal",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 100, \"expiresAt\": null}"
}
],
"weight": 99
},
{
"metadata": "rare",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 500, \"expiresAt\": 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\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 200, \"expiresAt\": null}"
}
],
"weight": 98
},
{
"metadata": "rare",
"completeAcquireActions": [
{
"action": "Gs2Experience:AddExperienceByUserId",
"request": "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
},
{
"action": "Gs2Inventory:AcquireItemSetByUserId",
"request": "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 1000, \"expiresAt\": 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": [
]
}
]
}
]
}from gs2_cdk import Stack, core, quest
class SampleStack(Stack):
def __init__(self):
super().__init__()
quest.Namespace(
stack=self,
# 省略
).master_data(
quest_group_models=[
quest.QuestGroupModel(
name='main',
options=quest.QuestGroupModelOptions(
metadata='MAIN',
quests=[
quest.QuestModel(
name='1-1',
metadata='stage1-1',
contents=[
quest.Contents(
metadata='normal',
complete_acquire_actions=[
quest.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request='{"namespaceName": "basic", "userId": "#{userId}", "experienceName": "player", "propertyId": "player", "experienceValue": 10}'
),
quest.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='{"namespaceName": "gold", "inventoryName": "wallet", "itemName": "basic", "userId": "#{userId}", "acquireCount": 100, "expiresAt": null}'
)
],
weight=99
),
quest.Contents(
metadata='rare',
complete_acquire_actions=[
quest.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request='{"namespaceName": "basic", "userId": "#{userId}", "experienceName": "player", "propertyId": "player", "experienceValue": 10}'
),
quest.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='{"namespaceName": "gold", "inventoryName": "wallet", "itemName": "basic", "userId": "#{userId}", "acquireCount": 500, "expiresAt": null}'
)
],
weight=1
)
],
consume_actions=[
quest.ConsumeAction(
action='Gs2Stamina:ConsumeStaminaByUserId',
request='{"namespaceName": "basic", "staminaName": "quest", "userId": "#{userId}", "consumeValue": 5}'
)
],
failed_acquire_actions=[
quest.AcquireAction(
action='Gs2Stamina:RecoverStaminaByUserId',
request='{"namespaceName": "basic", "staminaName": "quest", "userId": "#{userId}", "recoverValue": 5}'
)
],
premise_quest_names=[
]
),
quest.QuestModel(
name='1-2',
metadata='stage1-2',
contents=[
quest.Contents(
metadata='normal',
complete_acquire_actions=[
quest.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request='{"namespaceName": "basic", "userId": "#{userId}", "experienceName": "player", "propertyId": "player", "experienceValue": 20}'
),
quest.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='{"namespaceName": "gold", "inventoryName": "wallet", "itemName": "basic", "userId": "#{userId}", "acquireCount": 200, "expiresAt": null}'
)
],
weight=98
),
quest.Contents(
metadata='rare',
complete_acquire_actions=[
quest.AcquireAction(
action='Gs2Experience:AddExperienceByUserId',
request='{"namespaceName": "basic", "userId": "#{userId}", "experienceName": "player", "propertyId": "player", "experienceValue": 20}'
),
quest.AcquireAction(
action='Gs2Inventory:AcquireItemSetByUserId',
request='{"namespaceName": "gold", "inventoryName": "wallet", "itemName": "basic", "userId": "#{userId}", "acquireCount": 1000, "expiresAt": null}'
)
],
weight=2
)
],
consume_actions=[
quest.ConsumeAction(
action='Gs2Stamina:ConsumeStaminaByUserId',
request='{"namespaceName": "basic", "staminaName": "quest", "userId": "#{userId}", "consumeValue": 5}'
)
],
failed_acquire_actions=[
quest.AcquireAction(
action='Gs2Stamina:RecoverStaminaByUserId',
request='{"namespaceName": "basic", "staminaName": "quest", "userId": "#{userId}", "recoverValue": 5}'
)
],
premise_quest_names=[
'1-1'
]
),
],
),
),
quest.QuestGroupModel(
name='sub',
options=quest.QuestGroupModelOptions(
metadata='SUB',
quests=[
quest.QuestModel(
name='1-1',
metadata='stage1-1',
contents=[
quest.Contents(
metadata='normal',
complete_acquire_actions=[
quest.AcquireAction(
action='Gs2JobQueue:PushByUserId',
request='{"namespaceName": "queue-0001", "userId": "#{userId}", "jobs": [{"scriptId": "script-0001", "args": {}, "maxTryCount": 3}]}'
)
],
weight=1
)
],
premise_quest_names=[
]
),
],
),
),
],
)
print(SampleStack().yaml()) # Generate Templateclass SampleStack extends \Gs2Cdk\Core\Model\Stack
{
function __construct() {
parent::__construct();
(new \Gs2Cdk\Quest\Model\Namespace_(
stack: $this,
// 省略
))->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",
metadata: "stage1-1",
contents: [
new \Gs2Cdk\Quest\Model\Contents(
metadata: "normal",
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 100, \"expiresAt\": null}"
)
],
weight: 99
),
new \Gs2Cdk\Quest\Model\Contents(
metadata: "rare",
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 500, \"expiresAt\": null}"
)
],
weight: 1
)
],
consumeActions: [
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Stamina:ConsumeStaminaByUserId",
request: "{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"consumeValue\": 5}"
)
],
failedAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Stamina:RecoverStaminaByUserId",
request: "{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"recoverValue\": 5}"
)
],
premiseQuestNames: [
]
),
new \Gs2Cdk\Quest\Model\QuestModel(
name: "1-2",
metadata: "stage1-2",
contents: [
new \Gs2Cdk\Quest\Model\Contents(
metadata: "normal",
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 200, \"expiresAt\": null}"
)
],
weight: 98
),
new \Gs2Cdk\Quest\Model\Contents(
metadata: "rare",
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
),
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 1000, \"expiresAt\": null}"
)
],
weight: 2
)
],
consumeActions: [
new \Gs2Cdk\Core\Model\ConsumeAction(
action: "Gs2Stamina:ConsumeStaminaByUserId",
request: "{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"consumeValue\": 5}"
)
],
failedAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2Stamina:RecoverStaminaByUserId",
request: "{\"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",
metadata: "stage1-1",
contents: [
new \Gs2Cdk\Quest\Model\Contents(
metadata: "normal",
completeAcquireActions: [
new \Gs2Cdk\Core\Model\AcquireAction(
action: "Gs2JobQueue:PushByUserId",
request: "{\"namespaceName\": \"queue-0001\", \"userId\": \"#{userId}\", \"jobs\": [{\"scriptId\": \"script-0001\", \"args\": {}, \"maxTryCount\": 3}]}"
)
],
weight: 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,
// 省略
).masterData(
Arrays.asList(
new io.gs2.cdk.quest.model.QuestGroupModel(
"main",
new io.gs2.cdk.quest.model.options.QuestGroupModelOptions() {
{
metadata: "MAIN";
quests: Arrays.asList(
new io.gs2.cdk.quest.model.QuestModel(
"1-1",
"stage1-1",
Arrays.asList(
new io.gs2.cdk.quest.model.Contents(
"normal",
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 100, \"expiresAt\": null}"
)
),
99
),
new io.gs2.cdk.quest.model.Contents(
"rare",
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 500, \"expiresAt\": null}"
)
),
1
)
),
Arrays.asList(
new io.gs2.cdk.core.consume_action(
"Gs2Stamina:ConsumeStaminaByUserId",
"{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"consumeValue\": 5}"
)
),
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Stamina:RecoverStaminaByUserId",
"{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"recoverValue\": 5}"
)
),
Arrays.asList(
)
),
new io.gs2.cdk.quest.model.QuestModel(
"1-2",
"stage1-2",
Arrays.asList(
new io.gs2.cdk.quest.model.Contents(
"normal",
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 200, \"expiresAt\": null}"
)
),
98
),
new io.gs2.cdk.quest.model.Contents(
"rare",
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Experience:AddExperienceByUserId",
"{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
),
new io.gs2.cdk.core.acquire_action(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 1000, \"expiresAt\": null}"
)
),
2
)
),
Arrays.asList(
new io.gs2.cdk.core.consume_action(
"Gs2Stamina:ConsumeStaminaByUserId",
"{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"consumeValue\": 5}"
)
),
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2Stamina:RecoverStaminaByUserId",
"{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"recoverValue\": 5}"
)
),
Arrays.asList(
"1-1"
)
)
);
}
}
),
new io.gs2.cdk.quest.model.QuestGroupModel(
"sub",
new io.gs2.cdk.quest.model.options.QuestGroupModelOptions() {
{
metadata: "SUB";
quests: Arrays.asList(
new io.gs2.cdk.quest.model.QuestModel(
"1-1",
"stage1-1",
Arrays.asList(
new io.gs2.cdk.quest.model.Contents(
"normal",
Arrays.asList(
new io.gs2.cdk.core.acquire_action(
"Gs2JobQueue:PushByUserId",
"{\"namespaceName\": \"queue-0001\", \"userId\": \"#{userId}\", \"jobs\": [{\"scriptId\": \"script-0001\", \"args\": {}, \"maxTryCount\": 3}]}"
)
),
1
)
),
Arrays.asList(
)
)
);
}
}
)
)
);
}
}
System.out.println(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,
// 省略
).masterData(
[
new quest.model.QuestGroupModel(
"main",
{
metadata: "MAIN",
quests: [
new quest.model.QuestModel(
"1-1",
"stage1-1",
new Contents[
new quest.model.Contents(
"normal",
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 100, \"expiresAt\": null}"
)
],
99
),
new quest.model.Contents(
"rare",
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 500, \"expiresAt\": null}"
)
],
1
)
],
new ConsumeAction[
new ConsumeAction(
"Gs2Stamina:ConsumeStaminaByUserId",
"{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"consumeValue\": 5}"
)
],
new AcquireAction[
new AcquireAction(
"Gs2Stamina:RecoverStaminaByUserId",
"{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"recoverValue\": 5}"
)
],
new string[
]
),
new quest.model.QuestModel(
"1-2",
"stage1-2",
new Contents[
new quest.model.Contents(
"normal",
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 200, \"expiresAt\": null}"
)
],
98
),
new quest.model.Contents(
"rare",
new AcquireAction[
new AcquireAction(
"Gs2Experience:AddExperienceByUserId",
"{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
),
new AcquireAction(
"Gs2Inventory:AcquireItemSetByUserId",
"{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 1000, \"expiresAt\": null}"
)
],
2
)
],
new ConsumeAction[
new ConsumeAction(
"Gs2Stamina:ConsumeStaminaByUserId",
"{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"consumeValue\": 5}"
)
],
new AcquireAction[
new AcquireAction(
"Gs2Stamina:RecoverStaminaByUserId",
"{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"recoverValue\": 5}"
)
],
new string[
"1-1"
]
),
]
}
),
new quest.model.QuestGroupModel(
"sub",
{
metadata: "SUB",
quests: [
new quest.model.QuestModel(
"1-1",
"stage1-1",
new Contents[
new quest.model.Contents(
"normal",
new AcquireAction[
new AcquireAction(
"Gs2JobQueue:PushByUserId",
"{\"namespaceName\": \"queue-0001\", \"userId\": \"#{userId}\", \"jobs\": [{\"scriptId\": \"script-0001\", \"args\": {}, \"maxTryCount\": 3}]}"
)
],
1
)
],
new string[
]
),
]
}
)
]
);
}
}
console.log(new SampleStack().yaml()); // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
public SampleStack() {
new Gs2Cdk.Gs2Quest.Model.Namespace(
this,
// 省略
).MasterData(
new [] {
new Gs2Cdk.Gs2Quest.Model.QuestGroupModel(
"main",
new Gs2Cdk.Gs2Quest.Model.Options.QuestGroupModelOptions {
metadata = "MAIN",
quests = new Gs2Cdk.Gs2Quest.Model.QuestModel[] {
new Gs2Cdk.Gs2Quest.Model.QuestModel(
name: "1-1",
metadata: "stage1-1",
contents: new Gs2Cdk.Gs2Quest.Model.Contents[] {
new Gs2Cdk.Gs2Quest.Model.Contents(
metadata: "normal",
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 100, \"expiresAt\": null}"
)
},
weight: 99
),
new Gs2Cdk.Gs2Quest.Model.Contents(
metadata: "rare",
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 10}"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 500, \"expiresAt\": null}"
)
},
weight: 1
)
},
consumeActions: new Gs2Cdk.Core.Model.ConsumeAction[] {
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Stamina:ConsumeStaminaByUserId",
request: "{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"consumeValue\": 5}"
)
},
failedAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Stamina:RecoverStaminaByUserId",
request: "{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"recoverValue\": 5}"
)
},
premiseQuestNames: new string[] {
}
),
new Gs2Cdk.Gs2Quest.Model.QuestModel(
name: "1-2",
metadata: "stage1-2",
contents: new Gs2Cdk.Gs2Quest.Model.Contents[] {
new Gs2Cdk.Gs2Quest.Model.Contents(
metadata: "normal",
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 200, \"expiresAt\": null}"
)
},
weight: 98
),
new Gs2Cdk.Gs2Quest.Model.Contents(
metadata: "rare",
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Experience:AddExperienceByUserId",
request: "{\"namespaceName\": \"basic\", \"userId\": \"#{userId}\", \"experienceName\": \"player\", \"propertyId\": \"player\", \"experienceValue\": 20}"
),
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Inventory:AcquireItemSetByUserId",
request: "{\"namespaceName\": \"gold\", \"inventoryName\": \"wallet\", \"itemName\": \"basic\", \"userId\": \"#{userId}\", \"acquireCount\": 1000, \"expiresAt\": null}"
)
},
weight: 2
)
},
consumeActions: new Gs2Cdk.Core.Model.ConsumeAction[] {
new Gs2Cdk.Core.Model.ConsumeAction(
action: "Gs2Stamina:ConsumeStaminaByUserId",
request: "{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"consumeValue\": 5}"
)
},
failedAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2Stamina:RecoverStaminaByUserId",
request: "{\"namespaceName\": \"basic\", \"staminaName\": \"quest\", \"userId\": \"#{userId}\", \"recoverValue\": 5}"
)
},
premiseQuestNames: new string[] {
"1-1"
}
),
}
}
),
new Gs2Cdk.Gs2Quest.Model.QuestGroupModel(
"sub",
new Gs2Cdk.Gs2Quest.Model.Options.QuestGroupModelOptions {
metadata = "SUB",
quests = new Gs2Cdk.Gs2Quest.Model.QuestModel[] {
new Gs2Cdk.Gs2Quest.Model.QuestModel(
name: "1-1",
metadata: "stage1-1",
contents: new Gs2Cdk.Gs2Quest.Model.Contents[] {
new Gs2Cdk.Gs2Quest.Model.Contents(
metadata: "normal",
completeAcquireActions: new Gs2Cdk.Core.Model.AcquireAction[] {
new Gs2Cdk.Core.Model.AcquireAction(
action: "Gs2JobQueue:PushByUserId",
request: "{\"namespaceName\": \"queue-0001\", \"userId\": \"#{userId}\", \"jobs\": [{\"scriptId\": \"script-0001\", \"args\": {}, \"maxTryCount\": 3}]}"
)
},
weight: 1
)
},
premiseQuestNames: new string[] {
}
),
}
}
)
}
);
}
}
Debug.Log(new SampleStack().Yaml()); // Generate TemplateContents
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| metadata | string | ~ 256文字 | メタデータ | ||
| completeAcquireActions | List<AcquireAction> | [] | ~ 10 items | クエストクリア時の報酬 | |
| weight | int | ✓ | 1 | 1 ~ 2147483646 | 抽選する重み |
Reward
報酬
AcquireAction
入手アクション
ConsumeAction
消費アクション
VerifyAction
検証アクション
Config
コンフィグ設定
スタンプシートの変数に適用する設定値
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| key | string | ✓ | ~ 64文字 | 名前 | |
| value | string | ~ 51200文字 | 値 |
GitHubCheckoutSetting
GitHubからマスターデータをチェックアウトする設定
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| apiKeyId | string | ✓ | ~ 1024文字 | GitHub のAPIキーGRN | |
| repositoryName | string | ✓ | ~ 1024文字 | リポジトリ名 | |
| sourcePath | string | ✓ | ~ 1024文字 | ソースコードのファイルパス | |
| referenceType | enum [ “commit_hash”, “branch”, “tag” ] | ✓ | ~ 128文字 | コードの取得元 | |
| commitHash | string | {referenceType} == “commit_hash” | ~ 1024文字 | コミットハッシュ | |
| branchName | string | {referenceType} == “branch” | ~ 1024文字 | ブランチ名 | |
| tagName | string | {referenceType} == “tag” | ~ 1024文字 | タグ名 |
ScriptSetting
スクリプト設定
GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。 このモデルは、スクリプトの実行をトリガーするための設定を保持します。
スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。 同期実行は、スクリプトの実行が完了するまで処理がブロックされます。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることができます。
一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。 しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。
非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。 Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| triggerScriptId | string | ~ 1024文字 | スクリプトGRN | ||
| doneTriggerTargetType | enum [ “none”, “gs2_script”, “aws” ] | ✓ | “none” | ~ 128文字 | 完了通知の通知先 |
| doneTriggerScriptId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | スクリプトGRN | |
| doneTriggerQueueNamespaceId | string | {doneTriggerTargetType} == “gs2_script” | ~ 1024文字 | ネームスペースGRN |
LogSetting
ログの書き出し設定
ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| loggingNamespaceId | string | ✓ | ~ 1024文字 | ネームスペースGRN |
TransactionSetting
トランザクション設定
| 型 | 必須 | デフォルト | 値の制限 | 説明 | |
|---|---|---|---|---|---|
| enableAutoRun | bool | ✓ | false | 発行したスタンプシートをサーバーサイドで自動的に実行するか | |
| distributorNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:distributor:default” | ~ 1024文字 | スタンプシートの実行に使用する GS2-Distributor ネームスペース |
| queueNamespaceId | string | ✓ | “grn:gs2:{region}:{ownerId}:queue:default” | ~ 1024文字 | スタンプシートの実行に使用する GS2-JobQueue のネームスペース |