Documentation index for AI agents

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에서는 마이크로서비스의 이벤트에 연결하여 커스텀 스크립트를 실행할 수 있습니다.
이 모델은 스크립트 실행을 트리거하기 위한 설정을 보유합니다.

스크립트 실행 방식은 크게 두 가지로, 바로 “동기 실행"과 “비동기 실행"입니다.
동기 실행은 스크립트 실행이 완료될 때까지 처리가 블록됩니다.
대신 스크립트 실행 결과를 이용하여 API 실행을 중단시키거나 API 응답 내용을 제어할 수 있습니다.

한편, 비동기 실행에서는 스크립트 완료를 기다리기 위해 처리가 블록되는 일이 없습니다.
다만 스크립트 실행 결과를 이용하여 API 실행을 중단하거나 API 응답 내용을 변경할 수는 없습니다.
비동기 실행은 API의 응답 흐름에 영향을 주지 않으므로 원칙적으로 비동기 실행을 권장합니다.

비동기 실행에는 실행 방식이 두 가지 있으며, 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_scriptGS2-Script
awsAmazon 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 바이트 (5MB)마스터 데이터
※ 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,
                    pointy.String("#{itemSetName}"),
                ),
            },
            0.5,
            skillTree.NodeModelOptions{
                Metadata: pointy.String("NODE-0001"),
            },
        ),
        skillTree.NewNodeModel(
            "node-0002",
            []core.ConsumeAction{
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    pointy.String("#{itemSetName}"),
                ),
            },
            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,
                    pointy.String("#{itemSetName}"),
                ),
                inventory.ConsumeItemSetByUserId(
                    "namespace-0001",
                    "inventory-0001",
                    "item-0001",
                    1,
                    pointy.String("#{itemSetName}"),
                ),
            },
            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}",
                            null,
                            "#{userId}"
                        ),
                    ],
                    0.5,
                    {
                        metadata: "NODE-0001"
                    }
                ),
                new skillTree.model.NodeModel(
                    "node-0002",
                    [
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{itemSetName}",
                            null,
                            "#{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}",
                            null,
                            "#{userId}"
                        ),
                        new inventory.stampSheet.ConsumeItemSetByUserId(
                            "namespace-0001",
                            "inventory-0001",
                            "item-0001",
                            1,
                            "#{itemSetName}",
                            null,
                            "#{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 문자열