GS2-Quest GS2-Deploy/CDK リファレンス

エンティティ

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

	型	必須	値の制限	説明
name	string	✓	~ 32文字	ネームスペース名
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:namespace1

from gs2_cdk import Stack, core, quest

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        quest.Namespace(
            stack=self,
            name="namespace-0001",
            transaction_setting=core.TransactionSetting(
                enable_auto_run=False,
                queue_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001',
                options=core.TransactionSettingOptions(
                    distributor_namespace_id=,
                    key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                )
            ),
            options=quest.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(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",
            transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                enableAutoRun: False,
                queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                    distributorNamespaceId: ,
                    keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                )
            ),
            options: new \Gs2Cdk\Quest\Model\Options\NamespaceOptions(
                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.core.model.TransactionSetting(
                false,
                "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"
                )
            ),
            new io.gs2.cdk.quest.model.options.NamespaceOptions() {
                {
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

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",
            new core.TransactionSetting(
                false,
                "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"
                )
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Quest.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Core.Model.TransactionSetting(
                false,
                "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                new Gs2Cdk.Core.Model.Options.TransactionSettingOptions(
                    DistributorNamespaceId = ,
                    KeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                }
            ),
            new Gs2Cdk.Gs2Quest.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

CurrentQuestMaster

現在有効なマスターデータ

GS2ではマスターデータの管理にJSON形式のファイルを使用します。ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますがよりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

JSONファイルの形式についてはドキュメントを参照ください。

	型	必須	デフォルト	値の制限	説明
namespaceName	string	✓		~ 32文字	ネームスペース名
settings	string	✓		~ 5242880文字	マスターデータ

GetAttr

	型	説明
Item	CurrentQuestMaster	更新した現在有効なクエストマスター

実装例

Type: GS2::Quest::CurrentQuestMaster
Properties:
  NamespaceName: namespace1
  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\\": \\"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(
            [
            ],
        )

print(SampleStack().yaml())  # Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Quest\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
            ],
        );
    }
}

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(
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

import core from "@/gs2cdk/core";
import quest from "@/gs2cdk/quest";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new quest.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
            ]
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Quest.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

	型	必須	デフォルト	値の制限	説明
metadata	string			~ 256文字	メタデータ
completeAcquireActions	List<AcquireAction>		[]		クエストクリア時の報酬
weight	int	✓	1	1 ~ 2147483646	抽選する重み

Reward

	型	必須	値の制限	説明
action	enum []	✓	~ 128文字	スタンプシートを使用して実行するアクションの種類
request	string	✓	~ 5242880文字	リクエストモデル
itemId	string	✓	~ 1024文字	入手するリソースGRN
value	int	✓	~ 2147483646	入手する数量

AcquireAction

	型	必須	デフォルト	値の制限	説明
action	enum []	✓		~ 128文字	スタンプシートを使用して実行するアクションの種類
request	string	✓		~ 1048576文字	リクエストのJSON

ConsumeAction

	型	必須	デフォルト	値の制限	説明
action	enum []	✓		~ 128文字	スタンプタスクで実行するアクションの種類
request	string	✓		~ 1048576文字	入手リクエストのJSON

Config

	型	必須	デフォルト	値の制限	説明
key	string			~ 64文字	名前
value	string			~ 51200文字	値

GitHubCheckoutSetting

	型	必須	値の制限	説明
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

	型	必須	デフォルト	値の制限	説明
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

	型	必須	デフォルト	値の制限	説明
loggingNamespaceId	string	✓		~ 1024文字	ネームスペースGRN

TransactionSetting

	型	必須	デフォルト	値の制限	説明
enableAutoRun	bool	✓	false		発行したスタンプシートをサーバーサイドで自動的に実行するか
distributorNamespaceId	string	{enableAutoRun}		~ 1024文字	スタンプシートの実行に使用する GS2-Distributor ネームスペース
keyId	string	!{enableAutoRun}		~ 1024文字	スタンプシートの署名に使用する GS2-Key の暗号鍵
queueNamespaceId	string	✓		~ 1024文字	スタンプシートの実行に使用する GS2-JobQueue のネームスペース

GS2-Quest GS2-Deploy/CDK リファレンス

エンティティ

Namespace

GetAttr

実装例

CurrentQuestMaster

GetAttr

実装例

Contents

Reward

AcquireAction

ConsumeAction

Config

GitHubCheckoutSetting

ScriptSetting

LogSetting

TransactionSetting