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

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

エンティティ

Deloy処理で操作する対象リソース

Namespace

ネームスペース

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

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

	型	必須	値の制限	説明
name	string	✓	~ 128文字	ネームスペース名
description	string		~ 1024文字	説明文
transactionSetting	TransactionSetting			トランザクション設定
changeGradeScript	ScriptSetting			グレード変化したときに実行するスクリプト
logSetting	LogSetting			ログの出力設定

GetAttr

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

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

実装例

Type: GS2::Grade::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  ChangeGradeScript: 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/grade"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
grade.NewNamespace(
    &SampleStack,
    "namespace-0001",
    grade.NamespaceOptions{
        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\Grade\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Grade\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.grade.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.grade.model.options.NamespaceOptions()
                        .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.Gs2Grade.Model.Namespace(
            stack: this,
            name: "namespace-0001",
            options: new Gs2Cdk.Gs2Grade.Model.Options.NamespaceOptions
            {
                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 grade from "@/gs2cdk/grade";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new grade.model.Namespace(
            this,
            "namespace-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, grade

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        grade.Namespace(
            stack=self,
            name='namespace-0001',
            options=grade.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

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

ScriptSetting

スクリプト設定

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

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

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

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

型

有効化条件

必須

デフォルト

値の制限

説明

triggerScriptId

string

~ 1024文字

同期実行スクリプトの GS2-Script のスクリプトGRN

「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

doneTriggerTargetType

文字列列挙型
enum {
  “none”,
  “gs2_script”,
  “aws”
}

✓

“none”

~ 128文字

非同期スクリプトの実行方法

非同期実行で使用するスクリプトの種類を指定します。
「非同期実行のスクリプトを使用しない(none)」「GS2-Scriptを使用する(gs2_script)」「Amazon EventBridgeを使用する(aws)」が選択できます。

定義	説明
“none”	なし
“gs2_script”	GS2-Script
“aws”	Amazon EventBridge

doneTriggerScriptId

string

{doneTriggerTargetType} == “gs2_script”

~ 1024文字

非同期実行スクリプトの GS2-Script のスクリプトGRN

「grn:gs2:」ではじまる GRN 形式のIDで指定する必要があります。

※ doneTriggerTargetType が “gs2_script” であれば有効

doneTriggerQueueNamespaceId

string

{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 ではリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

	型	有効化条件	必須	デフォルト	値の制限	説明
loggingNamespaceId	string		✓		~ 1024文字	ログを出力する GS2-Log のネームスペースGRN

TransactionSetting

トランザクション設定

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

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

CurrentGradeMaster

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

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

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

Note

JSONファイルの形式については GS2-Grade マスターデータリファレンスをご参照ください。

型

有効化条件

必須

デフォルト

値の制限

説明

namespaceName

string

✓

~ 128文字

ネームスペース名

mode

文字列列挙型
enum {
“direct”,
“preUpload”
}

✓

“direct”

~ 128文字

更新モード

定義	説明
“direct”	設定を直接更新
“preUpload”	設定をアップロードしてから更新

settings

string

{mode} == “direct”

✓*

~ 5242880 バイト (5MB)

マスターデータ

※ mode が “direct” であれば必須

uploadToken

string

{mode} == “preUpload”

✓*

~ 1024文字

プレアップロードで取得したトークン

※ mode が “preUpload” であれば必須

GetAttr

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

	型	説明
Item	CurrentGradeMaster	更新した現在有効なマスターデータ

実装例

Type: GS2::Grade::CurrentGradeMaster
Properties:
  NamespaceName: namespace-0001
  Mode: direct
  Settings: {
    "version": "2023-12-25",
    "gradeModels": [
      {
        "name": "grade-0001",
        "experienceModelId": "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001",
        "gradeEntries": [
          {
            "rankCapValue": 50,
            "propertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
            "gradeUpPropertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"
          },
          {
            "rankCapValue": 60,
            "propertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
            "gradeUpPropertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"
          },
          {
            "rankCapValue": 70,
            "propertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
            "gradeUpPropertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"
          },
          {
            "rankCapValue": 80,
            "propertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
            "gradeUpPropertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"
          }
        ],
        "metadata": "GRADE_0001",
        "defaultGrades": [
          {
            "propertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:r-.*",
            "defaultGradeValue": 2
          },
          {
            "propertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:sr-.*",
            "defaultGradeValue": 3
          },
          {
            "propertyIdRegex": "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:ssr-.*",
            "defaultGradeValue": 4
          }
        ]
      }
    ]
  }
  UploadToken: null

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/grade"
    "github.com/openlyinc/pointy"
)

SampleStack := core.NewStack()
grade.NewNamespace(
    &SampleStack,
    "namespace-0001",
    grade.NamespaceOptions{},
).MasterData(
    []grade.GradeModel{
        grade.NewGradeModel(
            "grade-0001",
            "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001",
            []grade.GradeEntryModel{
                grade.NewGradeEntryModel(
                    50,
                    "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                    "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*",
                    grade.GradeEntryModelOptions{},
                ),
                grade.NewGradeEntryModel(
                    60,
                    "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                    "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*",
                    grade.GradeEntryModelOptions{},
                ),
                grade.NewGradeEntryModel(
                    70,
                    "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                    "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*",
                    grade.GradeEntryModelOptions{},
                ),
                grade.NewGradeEntryModel(
                    80,
                    "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                    "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*",
                    grade.GradeEntryModelOptions{},
                ),
            },
            grade.GradeModelOptions{
                Metadata: pointy.String("GRADE_0001"),
                DefaultGrades: []grade.DefaultGradeModel{
                    grade.NewDefaultGradeModel(
                        "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:r-.*",
                        2,
                        grade.DefaultGradeModelOptions{},
                    ),
                    grade.NewDefaultGradeModel(
                        "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:sr-.*",
                        3,
                        grade.DefaultGradeModelOptions{},
                    ),
                    grade.NewDefaultGradeModel(
                        "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:ssr-.*",
                        4,
                        grade.DefaultGradeModelOptions{},
                    ),
                },
            },
        ),
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Grade\Model\Namespace_(
            stack: $this,
            name: "namespace-0001"
        ))->masterData(
            [
                new \Gs2Cdk\Grade\Model\GradeModel(
                    name:"grade-0001",
                    experienceModelId:"grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001",
                    gradeEntries:[
                        new \Gs2Cdk\Grade\Model\GradeEntryModel(
                            rankCapValue: 50,
                            propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            gradeUpPropertyIdRegex: 'grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*',    
                        ),
                        new \Gs2Cdk\Grade\Model\GradeEntryModel(
                            rankCapValue: 60,
                            propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            gradeUpPropertyIdRegex: 'grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*',    
                        ),
                        new \Gs2Cdk\Grade\Model\GradeEntryModel(
                            rankCapValue: 70,
                            propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            gradeUpPropertyIdRegex: 'grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*',    
                        ),
                        new \Gs2Cdk\Grade\Model\GradeEntryModel(
                            rankCapValue: 80,
                            propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            gradeUpPropertyIdRegex: 'grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*',    
                        ),
                    ],
                    options: new \Gs2Cdk\Grade\Model\Options\GradeModelOptions(
                        metadata:"GRADE_0001",
                        defaultGrades:[
                            new \Gs2Cdk\Grade\Model\DefaultGradeModel(
                                propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:r-.*",
                                defaultGradeValue: 2,    
                            ),
                            new \Gs2Cdk\Grade\Model\DefaultGradeModel(
                                propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:sr-.*",
                                defaultGradeValue: 3,    
                            ),
                            new \Gs2Cdk\Grade\Model\DefaultGradeModel(
                                propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:ssr-.*",
                                defaultGradeValue: 4,    
                            ),
                        ]
                    )
                )
            ]
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.grade.model.Namespace(
            this,
            "namespace-0001"
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.grade.model.GradeModel(
                    "grade-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001",
                    Arrays.asList(
                        new io.gs2.cdk.grade.model.GradeEntryModel(
                            50L,
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"        
                        ),
                        new io.gs2.cdk.grade.model.GradeEntryModel(
                            60L,
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"        
                        ),
                        new io.gs2.cdk.grade.model.GradeEntryModel(
                            70L,
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"        
                        ),
                        new io.gs2.cdk.grade.model.GradeEntryModel(
                            80L,
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"        
                        )
                    ),
                    new io.gs2.cdk.grade.model.options.GradeModelOptions()
                        .withMetadata("GRADE_0001")
                        .withDefaultGrades(Arrays.asList(
                            new io.gs2.cdk.grade.model.DefaultGradeModel(
                                "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:r-.*",
                                2L        
                            ),
                            new io.gs2.cdk.grade.model.DefaultGradeModel(
                                "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:sr-.*",
                                3L        
                            ),
                            new io.gs2.cdk.grade.model.DefaultGradeModel(
                                "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:ssr-.*",
                                4L        
                            )
                        ))
                )
            )
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Grade.Model.Namespace(
            stack: this,
            name: "namespace-0001"
        ).MasterData(
            new Gs2Cdk.Gs2Grade.Model.GradeModel[] {
                new Gs2Cdk.Gs2Grade.Model.GradeModel(
                    name: "grade-0001",
                    experienceModelId: "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001",
                    gradeEntries: new Gs2Cdk.Gs2Grade.Model.GradeEntryModel[]
                    {
                        new Gs2Cdk.Gs2Grade.Model.GradeEntryModel(
                            rankCapValue: 50L,
                            propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            gradeUpPropertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"    
                        ),
                        new Gs2Cdk.Gs2Grade.Model.GradeEntryModel(
                            rankCapValue: 60L,
                            propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            gradeUpPropertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"    
                        ),
                        new Gs2Cdk.Gs2Grade.Model.GradeEntryModel(
                            rankCapValue: 70L,
                            propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            gradeUpPropertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"    
                        ),
                        new Gs2Cdk.Gs2Grade.Model.GradeEntryModel(
                            rankCapValue: 80L,
                            propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            gradeUpPropertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"    
                        )
                    },
                    options: new Gs2Cdk.Gs2Grade.Model.Options.GradeModelOptions
                    {
                        metadata = "GRADE_0001",
                        defaultGrades = new Gs2Cdk.Gs2Grade.Model.DefaultGradeModel[]
                        {
                            new Gs2Cdk.Gs2Grade.Model.DefaultGradeModel(
                                propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:r-.*",
                                defaultGradeValue: 2L    
                            ),
                            new Gs2Cdk.Gs2Grade.Model.DefaultGradeModel(
                                propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:sr-.*",
                                defaultGradeValue: 3L    
                            ),
                            new Gs2Cdk.Gs2Grade.Model.DefaultGradeModel(
                                propertyIdRegex: "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:ssr-.*",
                                defaultGradeValue: 4L    
                            )
                        }
                    }
                )
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new grade.model.Namespace(
            this,
            "namespace-0001",
        ).masterData(
            [
                new grade.model.GradeModel(
                    "grade-0001",
                    "grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001",
                    [
                        new grade.model.GradeEntryModel(
                            50,
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"        
                        ),
                        new grade.model.GradeEntryModel(
                            60,
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"        
                        ),
                        new grade.model.GradeEntryModel(
                            70,
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"        
                        ),
                        new grade.model.GradeEntryModel(
                            80,
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*",
                            "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*"        
                        ),
                    ],
                    {
                        metadata: "GRADE_0001",
                        defaultGrades: [
                            new grade.model.DefaultGradeModel(
                                "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:r-.*",
                                2        
                            ),
                            new grade.model.DefaultGradeModel(
                                "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:sr-.*",
                                3        
                            ),
                            new grade.model.DefaultGradeModel(
                                "grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:ssr-.*",
                                4        
                            ),
                        ]
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

from gs2_cdk import Stack, core, grade

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        grade.Namespace(
            stack=self,
            name="namespace-0001",
        ).master_data(
            grade_models=[
                grade.GradeModel(
                    name='grade-0001',
                    experience_model_id='grn:gs2:ap-northeast-1:YourOwnerId:experience:namespace-0001:model:experience-0001',
                    grade_entries=[
                        grade.GradeEntryModel(
                            rank_cap_value=50,
                            property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*',
                            grade_up_property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*',        
                        ),
                        grade.GradeEntryModel(
                            rank_cap_value=60,
                            property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*',
                            grade_up_property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*',        
                        ),
                        grade.GradeEntryModel(
                            rank_cap_value=70,
                            property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*',
                            grade_up_property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*',        
                        ),
                        grade.GradeEntryModel(
                            rank_cap_value=80,
                            property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:(.*):.*',
                            grade_up_property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:$1:.*',        
                        ),
                    ],
                    options=grade.GradeModelOptions(
                        metadata = 'GRADE_0001',
                        default_grades = [
                            grade.DefaultGradeModel(
                                property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:r-.*',
                                default_grade_value=2,        
                            ),
                            grade.DefaultGradeModel(
                                property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:sr-.*',
                                default_grade_value=3,        
                            ),
                            grade.DefaultGradeModel(
                                property_id_regex='grn:gs2:ap-northeast-1:YourOwnerId:inventory:namespace-0001:inventory:inventory-0001:item:ssr-.*',
                                default_grade_value=4,        
                            ),
                        ]
                    ),
                ),
            ],
        )

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

GradeModel

グレードモデル

グレードモデルとは、キャラクターや装備のランクを示すエンティティで、グレードによって GS2-Experience のランクキャップを設定することができます。

	型	必須	値の制限	説明
gradeModelId	string	✓	~ 1024文字	グレードモデルGRN
name	string	✓	~ 128文字	グレードモデル名
metadata	string		~ 2048文字	メタデータ
defaultGrades	List<DefaultGradeModel>		0 ~ 100 items	デフォルトグレードモデルリスト
experienceModelId	string	✓	~ 1024文字	グレードとランクキャップを連動させる経験値モデルGRN
gradeEntries	List<GradeEntryModel>	✓	1 ~ 100 items	グレードエントリリスト
acquireActionRates	List<AcquireActionRate>		0 ~ 100 items	報酬加算テーブルリスト

AcquireActionRate

報酬加算テーブルマスター

グレードに応じて報酬の量を調整することができます。

型

有効化条件

必須

デフォルト

値の制限

説明

name

string

✓

~ 128文字

報酬加算テーブル名

mode

文字列列挙型
enum {
“double”,
“big”
}

✓

“double”

~ 128文字

報酬加算テーブルの種類

定義	説明
“double”	2^48 未満の浮動小数点数
“big”	文字列表記で1024桁未満の浮動小数点数

rates

List<double>

{mode} == “double”

✓*

1 ~ 1000 items

グレードごとの加算量(倍率)

※ mode が “double” であれば必須

bigRates

List<string>

{mode} == “big”

✓*

1 ~ 1000 items

グレードごとの加算量(倍率)

※ mode が “big” であれば必須

DefaultGradeModel

デフォルトグレードモデル

グレードを新規作成する際にプロパティIDの正規表現へのマッチに応じてデフォルトのグレード値を設定することができます。

	型	有効化条件	必須	デフォルト	値の制限	説明
propertyIdRegex	string		✓		~ 1024文字	デフォルト値を適用するプロパティIDの正規表現
defaultGradeValue	long		✓		0 ~ 9223372036854775805	デフォルトのグレード値

GradeEntryModel

グレードエントリ

	型	必須	値の制限	説明
metadata	string		~ 2048文字	メタデータ
rankCapValue	long	✓	0 ~ 9223372036854775805	GS2-Experience に設定するランクキャップ値
propertyIdRegex	string	✓	~ 1024文字	プロパティIDからグレードアップに使用可能なリソースを特定するための変数を取り出すための正規表現パターン内で括弧で囲まれた部分を gradeUpPropertyIdRegex の正規表現で $1/$2… として利用することができます。
gradeUpPropertyIdRegex	string	✓	~ 1024文字	グレードアップに利用可能なリソースのプロパティIDの正規表現