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

GS2-Deployのスタックを作成する際に使用するテンプレートのフォーマットと、CDKによる各種言語のテンプレート出力の実装例
Tags:

エンティティ

Deploy処理で操作の対象となるリソース

Namespace

ネームスペース

ネームスペースは、一つのプロジェクト内で同じサービスを異なる用途で複数利用するためのエンティティです。
GS2 の各サービスはネームスペース単位で管理されます。ネームスペースが異なれば、同じサービスでも完全に独立したデータ空間として扱われます。

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

Request

リソースの生成・更新リクエスト

型有効化条件必須デフォルト値の制限説明
namestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
descriptionstring~ 1024文字説明文
transactionSettingTransactionSetting
✓
トランザクション設定
ノード解放・拘束操作の実行時に使用されるトランザクション処理の設定。
消費アクション（解放コスト）と入手アクション（拘束時の返却）が GS2 トランザクションシステムを通じてどのように処理されるかを定義します。
releaseScriptScriptSettingノード開放時に実行するスクリプトの設定
Script トリガーリファレンス - release
restrainScriptScriptSettingノード開放状態を未解放状態に戻すときに実行するスクリプトの設定
Script トリガーリファレンス - restrain
logSettingLogSettingログ出力設定
ノード解放・拘束・リセットなどのスキルツリー操作のログ出力設定。
設定した場合、操作ログが指定した GS2-Log ネームスペースに出力されます。

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemNamespace作成したネームスペース

実装例

Type: GS2::SkillTree::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: 
    EnableAutoRun: true
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
  ReleaseScript: null
  RestrainScript: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/skillTree"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
skillTree.NewNamespace(
    &SampleStack,
    "namespace-0001",
    skillTree.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\SkillTree\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\SkillTree\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.skillTree.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.skillTree.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
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SkillTree.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2SkillTree.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
import core from "@/gs2cdk/core";
import skillTree from "@/gs2cdk/skillTree";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new skillTree.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, skill_tree

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        skill_tree.Namespace(
            stack=self,
            name='namespace-0001',
            options=skill_tree.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

トランザクション設定

トランザクション設定は、トランザクションの実行方法・整合性・非同期処理・競合回避の仕組みを制御する設定です。
自動実行（AutoRun）、アトミック実行（AtomicCommit）、GS2-Distributor を利用した非同期実行、スクリプト結果の一括適用、GS2-JobQueue による入手アクションの非同期化などを組み合わせ、ゲームロジックに応じた堅牢なトランザクション管理を可能にします。

型有効化条件必須デフォルト値の制限説明
enableAutoRunboolfalse発行したトランザクションをサーバーサイドで自動的に実行するか
enableAtomicCommitbool{enableAutoRun} == truefalseトランザクションの実行をアトミックにコミットするか
※ enableAutoRun が true であれば 有効
transactionUseDistributorbool{enableAtomicCommit} == truefalseトランザクションを非同期処理で実行する
※ enableAtomicCommit が true であれば 有効
commitScriptResultInUseDistributorbool{transactionUseDistributor} == truefalseスクリプトの結果コミット処理を非同期処理で実行するか
※ transactionUseDistributor が true であれば 有効
acquireActionUseJobQueuebool{enableAtomicCommit} == truefalse入手アクションを実行する際に GS2-JobQueue を使用するか
※ enableAtomicCommit が true であれば 有効
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字トランザクションの実行に使用する GS2-Distributor ネームスペース GRN
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字トランザクションの実行に使用する GS2-JobQueue のネームスペース GRN

ScriptSetting

スクリプト設定

GS2 ではマイクロサービスのイベントに関連づけて、カスタムスクリプトを実行することができます。
このモデルは、スクリプトの実行をトリガーするための設定を保持します。

スクリプトの実行方式は大きく2種類あり、それは「同期実行」と「非同期実行」です。
同期実行は、スクリプトの実行が完了するまで処理がブロックされます。
代わりに、スクリプトの実行結果を使って API の実行を止めたり、API のレスポンス内容を制御することができます。

一方、非同期実行ではスクリプトの完了を待つために処理がブロックされることはありません。
ただし、スクリプトの実行結果を利用して API の実行を停止したり、API の応答内容を変更することはできません。
非同期実行は API の応答フローに影響を与えないため、原則として非同期実行を推奨します。

非同期実行には実行方式が2種類あり、GS2-Script と Amazon EventBridge があります。
Amazon EventBridge を使用することで、Lua 以外の言語で処理を記述することができます。

型有効化条件必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字API 実行時に同期的に実行される GS2-Script のスクリプト GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
doneTriggerTargetType文字列列挙型
enum {
  “none”,
  “gs2_script”,
  “aws”
}
“none”非同期スクリプトの実行方法
非同期実行で使用するスクリプトの種類を指定します。
「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。
定義説明
“none”なし
“gs2_script”GS2-Script
“aws”Amazon EventBridge
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字非同期実行する GS2-Script スクリプト GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。
※ doneTriggerTargetType が “gs2_script” であれば 有効
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字非同期実行スクリプトを実行する GS2-JobQueue ネームスペース GRN
非同期実行スクリプトを直接実行するのではなく、GS2-JobQueue を経由する場合は GS2-JobQueue のネームスペースGRN を指定します。
GS2-JobQueue を利用する理由は多くはありませんので、特に理由がなければ指定する必要はありません。
※ doneTriggerTargetType が “gs2_script” であれば 有効

LogSetting

ログの出力設定

ログデータの出力設定を管理します。この型は、ログデータを書き出すために使用される GS2-Log ネームスペースの識別子（Namespace ID）を保持します。
ログネームスペースID(loggingNamespaceId)には、ログデータを収集し保存する GS2-Log のネームスペースを、GRNの形式で指定します。
この設定をすることで、設定されたネームスペース内で発生したAPIリクエスト・レスポンスのログデータが、対象の GS2-Log ネームスペース側へ出力されるようになります。
GS2-Log ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

型有効化条件必須デフォルト値の制限説明
loggingNamespaceIdstring
✓
~ 1024文字ログを出力する GS2-Log のネームスペース GRN
「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

CurrentTreeMaster

現在アクティブなノードモデルのマスターデータ

現在ネームスペース内で有効な、ノードモデルの定義を記述したマスターデータです。
GS2ではマスターデータの管理にJSON形式のファイルを使用します。
ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

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

Request

リソースの生成・更新リクエスト

型有効化条件必須デフォルト値の制限説明
namespaceNamestring
✓
~ 128文字ネームスペース名
ネームスペース固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
mode文字列列挙型
enum {
  “direct”,
  “preUpload”
}
“direct”更新モード
定義説明
“direct”マスターデータを直接更新
“preUpload”マスターデータをアップロードしてから更新
settingsstring{mode} == “direct”
✓※
~ 5242880文字マスターデータ
※ mode が “direct” であれば必須
uploadTokenstring{mode} == “preUpload”
✓※
~ 1024文字事前アップロードで取得したトークン
アップロードしたマスターデータを適用するために使用されます。
※ mode が “preUpload” であれば必須

GetAttr

!GetAttrタグで取得可能なリソースの生成結果

型説明
ItemCurrentTreeMaster更新された現在アクティブなノードモデルのマスターデータ

実装例

Type: GS2::SkillTree::CurrentTreeMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2023-09-06",
    "nodeModels": [
      {
        "name": "node-0001",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "inventory-0001",
              "itemName": "item-0001",
              "consumeCount": 1,
              "itemSetName": "#{itemSetName}",
              "userId": "#{userId}"
            }
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0001"
      },
      {
        "name": "node-0002",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "inventory-0001",
              "itemName": "item-0001",
              "consumeCount": 1,
              "itemSetName": "#{itemSetName}",
              "userId": "#{userId}"
            }
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0002",
        "premiseNodeNames": [
          "node-0001"
        ]
      },
      {
        "name": "node-0003",
        "releaseConsumeActions": [
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "inventory-0001",
              "itemName": "item-0001",
              "consumeCount": 1,
              "itemSetName": "#{itemSetName}",
              "userId": "#{userId}"
            }
          },
          {
            "action": "Gs2Inventory:ConsumeItemSetByUserId",
            "request": {
              "namespaceName": "namespace-0001",
              "inventoryName": "inventory-0001",
              "itemName": "item-0001",
              "consumeCount": 1,
              "itemSetName": "#{itemSetName}",
              "userId": "#{userId}"
            }
          }
        ],
        "restrainReturnRate": 0.5,
        "metadata": "NODE-0003",
        "premiseNodeNames": [
          "node-0002"
        ]
      }
    ]
  }
  UploadToken: null
import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/skillTree"
    "github.com/gs2io/gs2-golang-cdk/inventory"
    "github.com/openlyinc/pointy"
)


SampleStack := core.NewStack()
skillTree.NewNamespace(
    &SampleStack,
    "namespace-0001",
    skillTree.NamespaceOptions{},
).MasterData(
    []skillTree.NodeModel{
        skillTree.NewNodeModel(
            "node-0001",
            []core.ConsumeAction{
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    "#{itemSetName}",
                    "#{userId}",
                ),
            },
            0.5,
            skillTree.NodeModelOptions{
                Metadata: pointy.String("NODE-0001"),
            },
        ),
        skillTree.NewNodeModel(
            "node-0002",
            []core.ConsumeAction{
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    "#{itemSetName}",
                    "#{userId}",
                ),
            },
            0.5,
            skillTree.NodeModelOptions{
                Metadata: pointy.String("NODE-0002"),
                PremiseNodeNames: []string{
                    "node-0001",
                },
            },
        ),
        skillTree.NewNodeModel(
            "node-0003",
            []core.ConsumeAction{
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    "#{itemSetName}",
                    "#{userId}",
                ),
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    "#{itemSetName}",
                    "#{userId}",
                ),
            },
            0.5,
            skillTree.NodeModelOptions{
                Metadata: pointy.String("NODE-0003"),
                PremiseNodeNames: []string{
                    "node-0002",
                },
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\SkillTree\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0001",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "inventory-0001",
                            itemName: "item-0001",
                            consumeCount: 1,
                            itemSetName: "#{itemSetName}",
                            userId: "#{userId}"
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0001"
                    )
                ),
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0002",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "inventory-0001",
                            itemName: "item-0001",
                            consumeCount: 1,
                            itemSetName: "#{itemSetName}",
                            userId: "#{userId}"
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0002",
                        premiseNodeNames:[
                            "node-0001",
                        ]
                    )
                ),
                new \Gs2Cdk\SkillTree\Model\NodeModel(
                    name:"node-0003",
                    releaseConsumeActions:[
                        new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "inventory-0001",
                            itemName: "item-0001",
                            consumeCount: 1,
                            itemSetName: "#{itemSetName}",
                            userId: "#{userId}"
                        ),
                        new \Gs2Cdk\Inventory\StampSheet\ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "inventory-0001",
                            itemName: "item-0001",
                            consumeCount: 1,
                            itemSetName: "#{itemSetName}",
                            userId: "#{userId}"
                        ),
                    ],
                    restrainReturnRate:0.5,
                    options: new \Gs2Cdk\SkillTree\Model\Options\NodeModelOptions(
                        metadata:"NODE-0003",
                        premiseNodeNames:[
                            "node-0002",
                        ]
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.skillTree.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0001",
                    Arrays.asList(
                        new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1L,
                            "#{itemSetName}",
                            "#{userId}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions()
                        .withMetadata("NODE-0001")
                ),
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0002",
                    Arrays.asList(
                        new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1L,
                            "#{itemSetName}",
                            "#{userId}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions()
                        .withMetadata("NODE-0002")
                        .withPremiseNodeNames(Arrays.asList(
                            "node-0001"
                        ))
                ),
                new io.gs2.cdk.skillTree.model.NodeModel(
                    "node-0003",
                    Arrays.asList(
                        new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1L,
                            "#{itemSetName}",
                            "#{userId}"
                        ),
                        new io.gs2.cdk.inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1L,
                            "#{itemSetName}",
                            "#{userId}"
                        )
                    ),
                    0.5f,
                    new io.gs2.cdk.skillTree.model.options.NodeModelOptions()
                        .withMetadata("NODE-0003")
                        .withPremiseNodeNames(Arrays.asList(
                            "node-0002"
                        ))
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2SkillTree.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2SkillTree.Model.NodeModel[] {
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    name: "node-0001",
                    releaseConsumeActions: new Gs2Cdk.Core.Model.ConsumeAction[]
                    {
                        new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "inventory-0001",
                            itemName: "item-0001",
                            consumeCount: 1,
                            itemSetName: "#{itemSetName}",
                            userId: "#{userId}"
                        )
                    },
                    restrainReturnRate: 0.5f,
                    options: new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions
                    {
                        metadata = "NODE-0001"
                    }
                ),
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    name: "node-0002",
                    releaseConsumeActions: new Gs2Cdk.Core.Model.ConsumeAction[]
                    {
                        new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "inventory-0001",
                            itemName: "item-0001",
                            consumeCount: 1,
                            itemSetName: "#{itemSetName}",
                            userId: "#{userId}"
                        )
                    },
                    restrainReturnRate: 0.5f,
                    options: new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions
                    {
                        metadata = "NODE-0002",
                        premiseNodeNames = new string[]
                        {
                            "node-0001"
                        }
                    }
                ),
                new Gs2Cdk.Gs2SkillTree.Model.NodeModel(
                    name: "node-0003",
                    releaseConsumeActions: new Gs2Cdk.Core.Model.ConsumeAction[]
                    {
                        new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "inventory-0001",
                            itemName: "item-0001",
                            consumeCount: 1,
                            itemSetName: "#{itemSetName}",
                            userId: "#{userId}"
                        ),
                        new Gs2Cdk.Gs2Inventory.StampSheet.ConsumeItemSetByUserId(
                            namespaceName: "namespace-0001",
                            inventoryName: "inventory-0001",
                            itemName: "item-0001",
                            consumeCount: 1,
                            itemSetName: "#{itemSetName}",
                            userId: "#{userId}"
                        )
                    },
                    restrainReturnRate: 0.5f,
                    options: new Gs2Cdk.Gs2SkillTree.Model.Options.NodeModelOptions
                    {
                        metadata = "NODE-0003",
                        premiseNodeNames = new string[]
                        {
                            "node-0002"
                        }
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template
import core from "@/gs2cdk/core";
import skillTree from "@/gs2cdk/skillTree";
import inventory from "@/gs2cdk/inventory";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new skillTree.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new skillTree.model.NodeModel(
                    "node-0001",
                    [
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{itemSetName}",
                            "#{userId}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0001"
                    }
                ),
                new skillTree.model.NodeModel(
                    "node-0002",
                    [
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{itemSetName}",
                            "#{userId}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0002",
                        premiseNodeNames: [
                            "node-0001",
                        ]
                    }
                ),
                new skillTree.model.NodeModel(
                    "node-0003",
                    [
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{itemSetName}",
                            "#{userId}"
                        ),
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{itemSetName}",
                            "#{userId}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0003",
                        premiseNodeNames: [
                            "node-0002",
                        ]
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
from gs2_cdk import Stack, core, skill_tree, inventory

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        skill_tree.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            node_models=[
                skill_tree.NodeModel(
                    name='node-0001',
                    release_consume_actions=[
                        inventory.ConsumeItemSetByUserId(
                            namespace_name='namespace-0001',
                            inventory_name='inventory-0001',
                            item_name='item-0001',
                            consume_count=1,
                            item_set_name='#{itemSetName}',
                            user_id='#{userId}'
                        ),
                    ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata = 'NODE-0001'
                    ),
                ),
                skill_tree.NodeModel(
                    name='node-0002',
                    release_consume_actions=[
                        inventory.ConsumeItemSetByUserId(
                            namespace_name='namespace-0001',
                            inventory_name='inventory-0001',
                            item_name='item-0001',
                            consume_count=1,
                            item_set_name='#{itemSetName}',
                            user_id='#{userId}'
                        ),
                    ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata = 'NODE-0002',
                        premise_node_names = [
                            'node-0001',
                        ]
                    ),
                ),
                skill_tree.NodeModel(
                    name='node-0003',
                    release_consume_actions=[
                        inventory.ConsumeItemSetByUserId(
                            namespace_name='namespace-0001',
                            inventory_name='inventory-0001',
                            item_name='item-0001',
                            consume_count=1,
                            item_set_name='#{itemSetName}',
                            user_id='#{userId}'
                        ),
                        inventory.ConsumeItemSetByUserId(
                            namespace_name='namespace-0001',
                            inventory_name='inventory-0001',
                            item_name='item-0001',
                            consume_count=1,
                            item_set_name='#{itemSetName}',
                            user_id='#{userId}'
                        ),
                    ],
                    restrain_return_rate=0.5,
                    options=skill_tree.NodeModelOptions(
                        metadata = 'NODE-0003',
                        premise_node_names = [
                            'node-0002',
                        ]
                    ),
                ),
            ],
        )

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

NodeModel

ノードモデル

スキルツリー内のノードを定義するモデルで、解放コスト・前提条件・返却動作を含みます。
各ノードには検証アクション（解放前の条件チェック）、消費アクション（支払うコスト）、先に解放が必要な前提ノードを設定できます。
ノードを拘束（未解放状態に戻す）すると、消費したリソースが返却率に基づいて部分的に返却されます。
返却入手アクションは消費アクションに返却率を乗じて自動的に計算されます。

型有効化条件必須デフォルト値の制限説明
nodeModelIdstring
※
~ 1024文字ノードモデル GRN
※ サーバーが自動で設定
namestring
✓
~ 128文字ノードモデル名
ノードモデル固有の名前。英数字および -(ハイフン) _(アンダースコア) .(ピリオド)で指定します。
metadatastring~ 2048文字メタデータ
メタデータには任意の値を設定できます。
これらの値は GS2 の動作には影響しないため、ゲーム内で利用する情報の保存先として使用できます。
releaseVerifyActionsList<VerifyAction>[]0 ~ 10 items解放検証アクションリスト
このノードを解放する前に実行され、条件が満たされているかを確認する検証アクションのリスト。
例えば、プレイヤーが特定のレベルに達しているか、特定のアイテムを所持しているかを検証できます。
いずれかの検証アクションが失敗すると、ノード解放は拒否されます。最大10アクション。
releaseConsumeActionsList<ConsumeAction>[]1 ~ 10 items解放消費アクションリスト
このノードを解放する際に実行される消費アクションのリストで、解放コストを表します。
これらのアクションは返却入手アクションの計算にも使用されます。ノードを拘束する際、各消費アクションが返却率に基づいて逆転されます。
最低1つの消費アクションが必要です。最大10アクション。
returnAcquireActionsList<AcquireAction>0 ~ 10 items返却入手アクションリスト
このノードを拘束（取り消し）する際に実行される入手アクションのリストで、プレイヤーに返却されるリソースを表します。
このフィールドは解放消費アクションに返却率を乗じて自動生成されます。
例えば、解放コストが100ゴールドで返却率が0.8の場合、拘束時に80ゴールドが返却されます。
最大10アクション。
restrainReturnRatefloat1.00.0 ~ 1.0返却率
このノードを拘束（未解放状態に戻す）した際に消費リソースが返却される割合。
1.0 は全額返却、0.5 は半額返却、0.0 は返却なしを意味します。
デフォルトは 1.0（全額返却）。有効範囲: 0.0〜1.0。
premiseNodeNamesList<string>[]0 ~ 10 items前提ノードモデル名リスト
このノードを解放する前に解放済みでなければならない他のノードモデルの名前。
スキルツリーの依存関係グラフを定義します。前提ノードがすべて解放済みでなければ、このノードは解放できません。
最大10の前提ノード。

ConsumeAction

消費アクション

型有効化条件必須デフォルト値の制限説明
action文字列列挙型
enum {
"Gs2AdReward:ConsumePointByUserId",
"Gs2Dictionary:DeleteEntriesByUserId",
"Gs2Enhance:DeleteProgressByUserId",
"Gs2Exchange:DeleteAwaitByUserId",
"Gs2Experience:SubExperienceByUserId",
"Gs2Experience:SubRankCapByUserId",
"Gs2Formation:SubMoldCapacityByUserId",
"Gs2Grade:SubGradeByUserId",
"Gs2Guild:DecreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:DecreaseMaximumIdleMinutesByUserId",
"Gs2Inbox:OpenMessageByUserId",
"Gs2Inbox:DeleteMessageByUserId",
"Gs2Inventory:ConsumeItemSetByUserId",
"Gs2Inventory:ConsumeSimpleItemsByUserId",
"Gs2Inventory:ConsumeBigItemByUserId",
"Gs2JobQueue:DeleteJobByUserId",
"Gs2Limit:CountUpByUserId",
"Gs2LoginReward:MarkReceivedByUserId",
"Gs2Mission:ReceiveByUserId",
"Gs2Mission:BatchReceiveByUserId",
"Gs2Mission:DecreaseCounterByUserId",
"Gs2Mission:ResetCounterByUserId",
"Gs2Money:WithdrawByUserId",
"Gs2Money:RecordReceipt",
"Gs2Money2:WithdrawByUserId",
"Gs2Money2:VerifyReceiptByUserId",
"Gs2Quest:DeleteProgressByUserId",
"Gs2Ranking2:CreateGlobalRankingReceivedRewardByUserId",
"Gs2Ranking2:CreateClusterRankingReceivedRewardByUserId",
"Gs2Schedule:DeleteTriggerByUserId",
"Gs2SerialKey:UseByUserId",
"Gs2Showcase:IncrementPurchaseCountByUserId",
"Gs2SkillTree:MarkRestrainByUserId",
"Gs2Stamina:DecreaseMaxValueByUserId",
"Gs2Stamina:ConsumeStaminaByUserId",
}
✓
消費アクションで実行するアクションの種類
requeststring
✓
~ 524288文字アクション実行時に使用されるリクエストのJSON文字列

VerifyAction

検証アクション

型有効化条件必須デフォルト値の制限説明
action文字列列挙型
enum {
"Gs2Dictionary:VerifyEntryByUserId",
"Gs2Distributor:IfExpressionByUserId",
"Gs2Distributor:AndExpressionByUserId",
"Gs2Distributor:OrExpressionByUserId",
"Gs2Enchant:VerifyRarityParameterStatusByUserId",
"Gs2Experience:VerifyRankByUserId",
"Gs2Experience:VerifyRankCapByUserId",
"Gs2Grade:VerifyGradeByUserId",
"Gs2Grade:VerifyGradeUpMaterialByUserId",
"Gs2Guild:VerifyCurrentMaximumMemberCountByGuildName",
"Gs2Guild:VerifyIncludeMemberByUserId",
"Gs2Inventory:VerifyInventoryCurrentMaxCapacityByUserId",
"Gs2Inventory:VerifyItemSetByUserId",
"Gs2Inventory:VerifyReferenceOfByUserId",
"Gs2Inventory:VerifySimpleItemByUserId",
"Gs2Inventory:VerifyBigItemByUserId",
"Gs2Limit:VerifyCounterByUserId",
"Gs2Matchmaking:VerifyIncludeParticipantByUserId",
"Gs2Mission:VerifyCompleteByUserId",
"Gs2Mission:VerifyCounterValueByUserId",
"Gs2Ranking2:VerifyGlobalRankingScoreByUserId",
"Gs2Ranking2:VerifyClusterRankingScoreByUserId",
"Gs2Ranking2:VerifySubscribeRankingScoreByUserId",
"Gs2Schedule:VerifyTriggerByUserId",
"Gs2Schedule:VerifyEventByUserId",
"Gs2SerialKey:VerifyCodeByUserId",
"Gs2Stamina:VerifyStaminaValueByUserId",
"Gs2Stamina:VerifyStaminaMaxValueByUserId",
"Gs2Stamina:VerifyStaminaRecoverIntervalMinutesByUserId",
"Gs2Stamina:VerifyStaminaRecoverValueByUserId",
"Gs2Stamina:VerifyStaminaOverflowValueByUserId",
}
✓
検証アクションで実行するアクションの種類
requeststring
✓
~ 524288文字アクション実行時に使用されるリクエストのJSON文字列

AcquireAction

入手アクション

型有効化条件必須デフォルト値の制限説明
action文字列列挙型
enum {
"Gs2AdReward:AcquirePointByUserId",
"Gs2Dictionary:AddEntriesByUserId",
"Gs2Enchant:ReDrawBalanceParameterStatusByUserId",
"Gs2Enchant:SetBalanceParameterStatusByUserId",
"Gs2Enchant:ReDrawRarityParameterStatusByUserId",
"Gs2Enchant:AddRarityParameterStatusByUserId",
"Gs2Enchant:SetRarityParameterStatusByUserId",
"Gs2Enhance:DirectEnhanceByUserId",
"Gs2Enhance:UnleashByUserId",
"Gs2Enhance:CreateProgressByUserId",
"Gs2Exchange:ExchangeByUserId",
"Gs2Exchange:IncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:AcquireForceByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Friend:UpdateProfileByUserId",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Guild:IncreaseMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Guild:SetMaximumCurrentMaximumMemberCountByGuildName",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"Gs2Idle:ReceiveByUserId",
"Gs2Inbox:SendMessageByUserId",
"Gs2Inventory:AddCapacityByUserId",
"Gs2Inventory:SetCapacityByUserId",
"Gs2Inventory:AcquireItemSetByUserId",
"Gs2Inventory:AcquireItemSetWithGradeByUserId",
"Gs2Inventory:AddReferenceOfByUserId",
"Gs2Inventory:DeleteReferenceOfByUserId",
"Gs2Inventory:AcquireSimpleItemsByUserId",
"Gs2Inventory:SetSimpleItemsByUserId",
"Gs2Inventory:AcquireBigItemByUserId",
"Gs2Inventory:SetBigItemByUserId",
"Gs2JobQueue:PushByUserId",
"Gs2Limit:CountDownByUserId",
"Gs2Limit:DeleteCounterByUserId",
"Gs2LoginReward:DeleteReceiveStatusByUserId",
"Gs2LoginReward:UnmarkReceivedByUserId",
"Gs2Lottery:DrawByUserId",
"Gs2Lottery:ResetBoxByUserId",
"Gs2Mission:RevertReceiveByUserId",
"Gs2Mission:IncreaseCounterByUserId",
"Gs2Mission:SetCounterByUserId",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Money2:DepositByUserId",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2Schedule:ExtendTriggerByUserId",
"Gs2Script:InvokeScript",
"Gs2SerialKey:RevertUseByUserId",
"Gs2SerialKey:IssueOnce",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
}
✓
入手アクションで実行するアクションの種類
requeststring
✓
~ 524288文字アクション実行時に使用されるリクエストのJSON文字列