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

エンティティ

Namespace

ネームスペース

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

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

型必須デフォルト値の制限説明
namestring✓~ 32文字ネームスペース名
descriptionstring~ 1024文字説明文
transactionSettingTransactionSetting✓トランザクション設定
logSettingLogSettingログの出力設定

GetAttr

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

実装例

Type: GS2::Enchant::Namespace
Properties:
  Name: namespace1
  Description: null
  TransactionSetting: 
    EnableAutoRun: false
    QueueNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001
    KeyId: grn:gs2:ap-northeast-1:YourOwnerId:key:namespace1:key:key-0001
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, enchant

class SampleStack(Stack):

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

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Enchant\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Enchant\Model\Options\NamespaceOptions(
                transactionSetting: new \Gs2Cdk\Core\Model\TransactionSetting(
                    enableAutoRun: False,
                    distributorNamespaceId: ,
                    queueNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    options: new \Gs2Cdk\Core\Model\Options\TransactionSettingOptions(
                        keyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    )
                ),
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
                ),
            ),
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.enchant.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.enchant.model.options.NamespaceOptions() {
                {
                    transactionSetting = new io.gs2.cdk.core.model.TransactionSetting(
                        false,
                        ,
                        "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                        new io.gs2.cdk.core.model.options.TransactionSettingOptions(
                            "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                        )
                    );
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import enchant from "@/gs2cdk/enchant";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enchant.model.Namespace(
            this,
            "namespace-0001",
            {
                transactionSetting: new core.TransactionSetting(
                    false,
                    ,
                    "grn:gs2:ap-northeast-1:YourOwnerId:queue:queue-0001",
                    {
                        "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

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

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

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

CurrentParameterMaster

現在有効な強化レートマスター

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

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

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

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

GetAttr

型説明
ItemCurrentParameterMaster更新した現在有効なパラメーター設定

実装例

Type: GS2::Enchant::CurrentParameterMaster
Properties:
  NamespaceName: namespace1
  Settings: {"version": "2023-07-18", "balanceParameterModels": [{"name": "balance-0001", "metadata": "BALANCE_0001", "totalValue": 100, "initialValueStrategy": "average", "parameters": [{"name": "parameter-0001", "metadata": "PARAMETER_0001"}, {"name": "parameter-0002", "metadata": "PARAMETER_0002"}, {"name": "parameter-0003", "metadata": "PARAMETER_0003"}]}, {"name": "balance-0002", "metadata": "BALANCE_0002", "totalValue": 200, "initialValueStrategy": "lottery", "parameters": [{"name": "parameter-0001", "metadata": "PARAMETER_0001"}, {"name": "parameter-0002", "metadata": "PARAMETER_0002"}, {"name": "parameter-0003", "metadata": "PARAMETER_0003"}, {"name": "parameter-0004", "metadata": "PARAMETER_0004"}]}, {"name": "balance-0003", "metadata": "BALANCE_0003", "totalValue": 500, "initialValueStrategy": "average", "parameters": [{"name": "parameter-0001", "metadata": "PARAMETER_0001"}, {"name": "parameter-0002", "metadata": "PARAMETER_0002"}]}], "rarityParameterModels": [{"name": "rarity-0001", "metadata": "RARITY_0001", "maximumParameterCount": 5, "parameterCounts": [{"count": 0, "weight": 1}, {"count": 1, "weight": 2}, {"count": 2, "weight": 3}], "parameters": [{"name": "parameter-0001", "metadata": "PARAMETER_0001", "resourceName": "resource-0001", "resourceValue": 10, "weight": 1}, {"name": "parameter-0002", "metadata": "PARAMETER_0002", "resourceName": "resource-0002", "resourceValue": 20, "weight": 2}, {"name": "parameter-0003", "metadata": "PARAMETER_0003", "resourceName": "resource-0003", "resourceValue": 30, "weight": 3}]}, {"name": "rarity-0002", "metadata": "RARITY_0002", "maximumParameterCount": 10, "parameterCounts": [{"count": 1, "weight": 10}, {"count": 2, "weight": 20}, {"count": 3, "weight": 30}], "parameters": [{"name": "parameter-1001", "metadata": "PARAMETER_1001", "resourceName": "resource-1001", "resourceValue": 100, "weight": 10}, {"name": "parameter-1002", "metadata": "PARAMETER_1002", "resourceName": "resource-1002", "resourceValue": 200, "weight": 20}, {"name": "parameter-1003", "metadata": "PARAMETER_1003", "resourceName": "resource-1003", "resourceValue": 300, "weight": 30}]}, {"name": "rarity-0003", "metadata": "RARITY_0003", "maximumParameterCount": 3, "parameterCounts": [{"count": 2, "weight": 5}, {"count": 3, "weight": 10}, {"count": 4, "weight": 15}], "parameters": [{"name": "parameter-2001", "metadata": "PARAMETER_2001", "resourceName": "resource-2001", "resourceValue": 1000, "weight": 2}, {"name": "parameter-2002", "metadata": "PARAMETER_2002", "resourceName": "resource-2002", "resourceValue": 2000, "weight": 4}, {"name": "parameter-2003", "metadata": "PARAMETER_2003", "resourceName": "resource-2003", "resourceValue": 3000, "weight": 6}, {"name": "parameter-0004", "metadata": "PARAMETER_0004", "resourceName": "resource-2004", "resourceValue": 4000, "weight": 8}]}]}
from gs2_cdk import Stack, core, enchant

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        enchant.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                enchant.BalanceParameterModel(
                    name='balance-0001',
                    total_value=100,
                    initial_value_strategy='average',
                    parameters=[    {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                        {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                        {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'},
                        ],
                    options=enchant.BalanceParameterModelOptions(
                        metadata='BALANCE_0001',
                    ),
                ),
                enchant.BalanceParameterModel(
                    name='balance-0002',
                    total_value=200,
                    initial_value_strategy='lottery',
                    parameters=[    {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                        {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                        {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'},
                        {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004'},
                        ],
                    options=enchant.BalanceParameterModelOptions(
                        metadata='BALANCE_0002',
                    ),
                ),
                enchant.BalanceParameterModel(
                    name='balance-0003',
                    total_value=500,
                    initial_value_strategy='average',
                    parameters=[    {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                        {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                        ],
                    options=enchant.BalanceParameterModelOptions(
                        metadata='BALANCE_0003',
                    ),
                ),
            ],
            [
                enchant.RarityParameterModel(
                    name='rarity-0001',
                    maximum_parameter_count=5,
                    parameter_counts=[    {'count': 0, 'weight': 1},
                        {'count': 1, 'weight': 2},
                        {'count': 2, 'weight': 3},
                        ],
                    parameters=[    {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001', 'resourceName': 'resource-0001', 'resourceValue': 10, 'weight': 1},
                        {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002', 'resourceName': 'resource-0002', 'resourceValue': 20, 'weight': 2},
                        {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003', 'resourceName': 'resource-0003', 'resourceValue': 30, 'weight': 3},
                        ],
                    options=enchant.RarityParameterModelOptions(
                        metadata='RARITY_0001',
                    ),
                ),
                enchant.RarityParameterModel(
                    name='rarity-0002',
                    maximum_parameter_count=10,
                    parameter_counts=[    {'count': 1, 'weight': 10},
                        {'count': 2, 'weight': 20},
                        {'count': 3, 'weight': 30},
                        ],
                    parameters=[    {'name': 'parameter-1001', 'metadata': 'PARAMETER_1001', 'resourceName': 'resource-1001', 'resourceValue': 100, 'weight': 10},
                        {'name': 'parameter-1002', 'metadata': 'PARAMETER_1002', 'resourceName': 'resource-1002', 'resourceValue': 200, 'weight': 20},
                        {'name': 'parameter-1003', 'metadata': 'PARAMETER_1003', 'resourceName': 'resource-1003', 'resourceValue': 300, 'weight': 30},
                        ],
                    options=enchant.RarityParameterModelOptions(
                        metadata='RARITY_0002',
                    ),
                ),
                enchant.RarityParameterModel(
                    name='rarity-0003',
                    maximum_parameter_count=3,
                    parameter_counts=[    {'count': 2, 'weight': 5},
                        {'count': 3, 'weight': 10},
                        {'count': 4, 'weight': 15},
                        ],
                    parameters=[    {'name': 'parameter-2001', 'metadata': 'PARAMETER_2001', 'resourceName': 'resource-2001', 'resourceValue': 1000, 'weight': 2},
                        {'name': 'parameter-2002', 'metadata': 'PARAMETER_2002', 'resourceName': 'resource-2002', 'resourceValue': 2000, 'weight': 4},
                        {'name': 'parameter-2003', 'metadata': 'PARAMETER_2003', 'resourceName': 'resource-2003', 'resourceValue': 3000, 'weight': 6},
                        {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004', 'resourceName': 'resource-2004', 'resourceValue': 4000, 'weight': 8},
                        ],
                    options=enchant.RarityParameterModelOptions(
                        metadata='RARITY_0003',
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Enchant\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Enchant\Model\BalanceParameterModel(
                    name:"balance-0001",
                    totalValue:100,
                    initialValueStrategy: \Gs2Cdk\Enchant\Model\Enums\CurrentParameterMasterInitialValueStrategy::AVERAGE
                    parameters:[    {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'},
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterModelOptions(
                        metadata:"BALANCE_0001",
                    ),
                ),
                new \Gs2Cdk\Enchant\Model\BalanceParameterModel(
                    name:"balance-0002",
                    totalValue:200,
                    initialValueStrategy: \Gs2Cdk\Enchant\Model\Enums\CurrentParameterMasterInitialValueStrategy::LOTTERY
                    parameters:[    {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'},
                    {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004'},
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterModelOptions(
                        metadata:"BALANCE_0002",
                    ),
                ),
                new \Gs2Cdk\Enchant\Model\BalanceParameterModel(
                    name:"balance-0003",
                    totalValue:500,
                    initialValueStrategy: \Gs2Cdk\Enchant\Model\Enums\CurrentParameterMasterInitialValueStrategy::AVERAGE
                    parameters:[    {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\BalanceParameterModelOptions(
                        metadata:"BALANCE_0003",
                    ),
                ),
            ],
            [
                new \Gs2Cdk\Enchant\Model\RarityParameterModel(
                    name:"rarity-0001",
                    maximumParameterCount:5,
                    parameterCounts:[    {'count': 0, 'weight': 1},
                    {'count': 1, 'weight': 2},
                    {'count': 2, 'weight': 3},
                    ],
                    parameters:[    {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001', 'resourceName': 'resource-0001', 'resourceValue': 10, 'weight': 1},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002', 'resourceName': 'resource-0002', 'resourceValue': 20, 'weight': 2},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003', 'resourceName': 'resource-0003', 'resourceValue': 30, 'weight': 3},
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterModelOptions(
                        metadata:"RARITY_0001",
                    ),
                ),
                new \Gs2Cdk\Enchant\Model\RarityParameterModel(
                    name:"rarity-0002",
                    maximumParameterCount:10,
                    parameterCounts:[    {'count': 1, 'weight': 10},
                    {'count': 2, 'weight': 20},
                    {'count': 3, 'weight': 30},
                    ],
                    parameters:[    {'name': 'parameter-1001', 'metadata': 'PARAMETER_1001', 'resourceName': 'resource-1001', 'resourceValue': 100, 'weight': 10},
                    {'name': 'parameter-1002', 'metadata': 'PARAMETER_1002', 'resourceName': 'resource-1002', 'resourceValue': 200, 'weight': 20},
                    {'name': 'parameter-1003', 'metadata': 'PARAMETER_1003', 'resourceName': 'resource-1003', 'resourceValue': 300, 'weight': 30},
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterModelOptions(
                        metadata:"RARITY_0002",
                    ),
                ),
                new \Gs2Cdk\Enchant\Model\RarityParameterModel(
                    name:"rarity-0003",
                    maximumParameterCount:3,
                    parameterCounts:[    {'count': 2, 'weight': 5},
                    {'count': 3, 'weight': 10},
                    {'count': 4, 'weight': 15},
                    ],
                    parameters:[    {'name': 'parameter-2001', 'metadata': 'PARAMETER_2001', 'resourceName': 'resource-2001', 'resourceValue': 1000, 'weight': 2},
                    {'name': 'parameter-2002', 'metadata': 'PARAMETER_2002', 'resourceName': 'resource-2002', 'resourceValue': 2000, 'weight': 4},
                    {'name': 'parameter-2003', 'metadata': 'PARAMETER_2003', 'resourceName': 'resource-2003', 'resourceValue': 3000, 'weight': 6},
                    {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004', 'resourceName': 'resource-2004', 'resourceValue': 4000, 'weight': 8},
                    ],
                    options: new \Gs2Cdk\Enchant\Model\Options\RarityParameterModelOptions(
                        metadata:"RARITY_0003",
                    ),
                ),
            ],
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.enchant.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.enchant.model.BalanceParameterModel(
                    "balance-0001",
                    100L,
                    Average,
                    Arrays.asList(
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'}
                    ),
                    new io.gs2.cdk.enchant.model.options.BalanceParameterModelOptions() {
                        {
                            metadata: "BALANCE_0001";
                        }
                    }
                ),
                new io.gs2.cdk.enchant.model.BalanceParameterModel(
                    "balance-0002",
                    200L,
                    Lottery,
                    Arrays.asList(
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'},
                    {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004'}
                    ),
                    new io.gs2.cdk.enchant.model.options.BalanceParameterModelOptions() {
                        {
                            metadata: "BALANCE_0002";
                        }
                    }
                ),
                new io.gs2.cdk.enchant.model.BalanceParameterModel(
                    "balance-0003",
                    500L,
                    Average,
                    Arrays.asList(
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'}
                    ),
                    new io.gs2.cdk.enchant.model.options.BalanceParameterModelOptions() {
                        {
                            metadata: "BALANCE_0003";
                        }
                    }
                )
            ),
            Arrays.asList(
                new io.gs2.cdk.enchant.model.RarityParameterModel(
                    "rarity-0001",
                    5,
                    Arrays.asList(
                        {'count': 0, 'weight': 1},
                    {'count': 1, 'weight': 2},
                    {'count': 2, 'weight': 3}
                    ),
                    Arrays.asList(
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001', 'resourceName': 'resource-0001', 'resourceValue': 10, 'weight': 1},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002', 'resourceName': 'resource-0002', 'resourceValue': 20, 'weight': 2},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003', 'resourceName': 'resource-0003', 'resourceValue': 30, 'weight': 3}
                    ),
                    new io.gs2.cdk.enchant.model.options.RarityParameterModelOptions() {
                        {
                            metadata: "RARITY_0001";
                        }
                    }
                ),
                new io.gs2.cdk.enchant.model.RarityParameterModel(
                    "rarity-0002",
                    10,
                    Arrays.asList(
                        {'count': 1, 'weight': 10},
                    {'count': 2, 'weight': 20},
                    {'count': 3, 'weight': 30}
                    ),
                    Arrays.asList(
                        {'name': 'parameter-1001', 'metadata': 'PARAMETER_1001', 'resourceName': 'resource-1001', 'resourceValue': 100, 'weight': 10},
                    {'name': 'parameter-1002', 'metadata': 'PARAMETER_1002', 'resourceName': 'resource-1002', 'resourceValue': 200, 'weight': 20},
                    {'name': 'parameter-1003', 'metadata': 'PARAMETER_1003', 'resourceName': 'resource-1003', 'resourceValue': 300, 'weight': 30}
                    ),
                    new io.gs2.cdk.enchant.model.options.RarityParameterModelOptions() {
                        {
                            metadata: "RARITY_0002";
                        }
                    }
                ),
                new io.gs2.cdk.enchant.model.RarityParameterModel(
                    "rarity-0003",
                    3,
                    Arrays.asList(
                        {'count': 2, 'weight': 5},
                    {'count': 3, 'weight': 10},
                    {'count': 4, 'weight': 15}
                    ),
                    Arrays.asList(
                        {'name': 'parameter-2001', 'metadata': 'PARAMETER_2001', 'resourceName': 'resource-2001', 'resourceValue': 1000, 'weight': 2},
                    {'name': 'parameter-2002', 'metadata': 'PARAMETER_2002', 'resourceName': 'resource-2002', 'resourceValue': 2000, 'weight': 4},
                    {'name': 'parameter-2003', 'metadata': 'PARAMETER_2003', 'resourceName': 'resource-2003', 'resourceValue': 3000, 'weight': 6},
                    {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004', 'resourceName': 'resource-2004', 'resourceValue': 4000, 'weight': 8}
                    ),
                    new io.gs2.cdk.enchant.model.options.RarityParameterModelOptions() {
                        {
                            metadata: "RARITY_0003";
                        }
                    }
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template
import core from "@/gs2cdk/core";
import enchant from "@/gs2cdk/enchant";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new enchant.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new enchant.model.BalanceParameterModel(
                    "balance-0001",
                    100,
                    enchant.model.CurrentParameterMasterInitialValueStrategy.AVERAGE,
                    [
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'}
                    ],
                    {
                        metadata: "BALANCE_0001"
                    }
                ),
                new enchant.model.BalanceParameterModel(
                    "balance-0002",
                    200,
                    enchant.model.CurrentParameterMasterInitialValueStrategy.LOTTERY,
                    [
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'},
                    {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004'}
                    ],
                    {
                        metadata: "BALANCE_0002"
                    }
                ),
                new enchant.model.BalanceParameterModel(
                    "balance-0003",
                    500,
                    enchant.model.CurrentParameterMasterInitialValueStrategy.AVERAGE,
                    [
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'}
                    ],
                    {
                        metadata: "BALANCE_0003"
                    }
                )
            ],
            [
                new enchant.model.RarityParameterModel(
                    "rarity-0001",
                    5,
                    [
                        {'count': 0, 'weight': 1},
                    {'count': 1, 'weight': 2},
                    {'count': 2, 'weight': 3}
                    ],
                    [
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001', 'resourceName': 'resource-0001', 'resourceValue': 10, 'weight': 1},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002', 'resourceName': 'resource-0002', 'resourceValue': 20, 'weight': 2},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003', 'resourceName': 'resource-0003', 'resourceValue': 30, 'weight': 3}
                    ],
                    {
                        metadata: "RARITY_0001"
                    }
                ),
                new enchant.model.RarityParameterModel(
                    "rarity-0002",
                    10,
                    [
                        {'count': 1, 'weight': 10},
                    {'count': 2, 'weight': 20},
                    {'count': 3, 'weight': 30}
                    ],
                    [
                        {'name': 'parameter-1001', 'metadata': 'PARAMETER_1001', 'resourceName': 'resource-1001', 'resourceValue': 100, 'weight': 10},
                    {'name': 'parameter-1002', 'metadata': 'PARAMETER_1002', 'resourceName': 'resource-1002', 'resourceValue': 200, 'weight': 20},
                    {'name': 'parameter-1003', 'metadata': 'PARAMETER_1003', 'resourceName': 'resource-1003', 'resourceValue': 300, 'weight': 30}
                    ],
                    {
                        metadata: "RARITY_0002"
                    }
                ),
                new enchant.model.RarityParameterModel(
                    "rarity-0003",
                    3,
                    [
                        {'count': 2, 'weight': 5},
                    {'count': 3, 'weight': 10},
                    {'count': 4, 'weight': 15}
                    ],
                    [
                        {'name': 'parameter-2001', 'metadata': 'PARAMETER_2001', 'resourceName': 'resource-2001', 'resourceValue': 1000, 'weight': 2},
                    {'name': 'parameter-2002', 'metadata': 'PARAMETER_2002', 'resourceName': 'resource-2002', 'resourceValue': 2000, 'weight': 4},
                    {'name': 'parameter-2003', 'metadata': 'PARAMETER_2003', 'resourceName': 'resource-2003', 'resourceValue': 3000, 'weight': 6},
                    {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004', 'resourceName': 'resource-2004', 'resourceValue': 4000, 'weight': 8}
                    ],
                    {
                        metadata: "RARITY_0003"
                    }
                )
            ]
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Enchant.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Enchant.Model.BalanceParameterModel(
                    "balance-0001",
                    100L,
                    Gs2Cdk.Gs2Enchant.Model.Enums.CurrentParameterMasterInitialValueStrategy.Average,
                    new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel[] {
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterModelOptions {
                        metadata = "BALANCE_0001",
                    }
                ),
                new Gs2Cdk.Gs2Enchant.Model.BalanceParameterModel(
                    "balance-0002",
                    200L,
                    Gs2Cdk.Gs2Enchant.Model.Enums.CurrentParameterMasterInitialValueStrategy.Lottery,
                    new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel[] {
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003'},
                    {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004'}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterModelOptions {
                        metadata = "BALANCE_0002",
                    }
                ),
                new Gs2Cdk.Gs2Enchant.Model.BalanceParameterModel(
                    "balance-0003",
                    500L,
                    Gs2Cdk.Gs2Enchant.Model.Enums.CurrentParameterMasterInitialValueStrategy.Average,
                    new Gs2Cdk.Gs2Enchant.Model.BalanceParameterValueModel[] {
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001'},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002'}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.Options.BalanceParameterModelOptions {
                        metadata = "BALANCE_0003",
                    }
                )
            },
            new [] {
                new Gs2Cdk.Gs2Enchant.Model.RarityParameterModel(
                    "rarity-0001",
                    5,
                    new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel[] {
                        {'count': 0, 'weight': 1},
                    {'count': 1, 'weight': 2},
                    {'count': 2, 'weight': 3}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel[] {
                        {'name': 'parameter-0001', 'metadata': 'PARAMETER_0001', 'resourceName': 'resource-0001', 'resourceValue': 10, 'weight': 1},
                    {'name': 'parameter-0002', 'metadata': 'PARAMETER_0002', 'resourceName': 'resource-0002', 'resourceValue': 20, 'weight': 2},
                    {'name': 'parameter-0003', 'metadata': 'PARAMETER_0003', 'resourceName': 'resource-0003', 'resourceValue': 30, 'weight': 3}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterModelOptions {
                        metadata = "RARITY_0001",
                    }
                ),
                new Gs2Cdk.Gs2Enchant.Model.RarityParameterModel(
                    "rarity-0002",
                    10,
                    new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel[] {
                        {'count': 1, 'weight': 10},
                    {'count': 2, 'weight': 20},
                    {'count': 3, 'weight': 30}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel[] {
                        {'name': 'parameter-1001', 'metadata': 'PARAMETER_1001', 'resourceName': 'resource-1001', 'resourceValue': 100, 'weight': 10},
                    {'name': 'parameter-1002', 'metadata': 'PARAMETER_1002', 'resourceName': 'resource-1002', 'resourceValue': 200, 'weight': 20},
                    {'name': 'parameter-1003', 'metadata': 'PARAMETER_1003', 'resourceName': 'resource-1003', 'resourceValue': 300, 'weight': 30}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterModelOptions {
                        metadata = "RARITY_0002",
                    }
                ),
                new Gs2Cdk.Gs2Enchant.Model.RarityParameterModel(
                    "rarity-0003",
                    3,
                    new Gs2Cdk.Gs2Enchant.Model.RarityParameterCountModel[] {
                        {'count': 2, 'weight': 5},
                    {'count': 3, 'weight': 10},
                    {'count': 4, 'weight': 15}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.RarityParameterValueModel[] {
                        {'name': 'parameter-2001', 'metadata': 'PARAMETER_2001', 'resourceName': 'resource-2001', 'resourceValue': 1000, 'weight': 2},
                    {'name': 'parameter-2002', 'metadata': 'PARAMETER_2002', 'resourceName': 'resource-2002', 'resourceValue': 2000, 'weight': 4},
                    {'name': 'parameter-2003', 'metadata': 'PARAMETER_2003', 'resourceName': 'resource-2003', 'resourceValue': 3000, 'weight': 6},
                    {'name': 'parameter-0004', 'metadata': 'PARAMETER_0004', 'resourceName': 'resource-2004', 'resourceValue': 4000, 'weight': 8}
                    },
                    new Gs2Cdk.Gs2Enchant.Model.Options.RarityParameterModelOptions {
                        metadata = "RARITY_0003",
                    }
                )
            }
        );
    }
}

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

BalanceParameterValueModel

型必須デフォルト値の制限説明
namestring✓~ 64文字名前
metadatastring~ 512文字メタデータ

RarityParameterCountModel

レアリティパラメーターの付与数モデル

型必須デフォルト値の制限説明
countint✓~ 10値
weightint✓1 ~ 2147483646排出重み

RarityParameterValueModel

バランスパラメーター値モデル

型必須デフォルト値の制限説明
namestring✓~ 64文字名前
metadatastring~ 512文字メタデータ
resourceNamestring✓~ 64文字ゲーム内で使用するパラメーターリソースの種類を表す名前（GS2の動作のためには使用しません）
resourceValuelong✓~ 9223372036854775805ゲーム内で使用するパラメーターリソースの値（GS2の動作のためには使用しません）
weightint✓1 ~ 2147483646排出重み

BalanceParameterValue

バランスパラメーター値モデル

型必須デフォルト値の制限説明
namestring✓~ 64文字名前
valuelong✓~ 9223372036854775805値

RarityParameterValue

レアリティパラメーター値モデル

型必須デフォルト値の制限説明
namestring✓~ 64文字名前
resourceNamestring✓~ 64文字リソースの名前
resourceValuelong✓~ 9223372036854775805リソースの値

Config

コンフィグ設定

スタンプシートの変数に適用する設定値

型必須デフォルト値の制限説明
keystring✓~ 64文字名前
valuestring~ 51200文字値

GitHubCheckoutSetting

GitHubからマスターデータをチェックアウトする設定

型必須デフォルト値の制限説明
apiKeyIdstring✓~ 1024文字GitHub のAPIキーGRN
repositoryNamestring✓~ 1024文字リポジトリ名
sourcePathstring✓~ 1024文字ソースコードのファイルパス
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
✓~ 128文字コードの取得元
commitHashstring{referenceType} == “commit_hash”~ 1024文字コミットハッシュ
branchNamestring{referenceType} == “branch”~ 1024文字ブランチ名
tagNamestring{referenceType} == “tag”~ 1024文字タグ名

ScriptSetting

スクリプト設定

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

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

一方、非同期実行は、スクリプトの実行が完了するまで処理がブロックされません。 かわりに、スクリプトの実行結果を使ってAPIの実行を止めたり、APIの結果を改ざんすることはできません。 しかし、非同期実行は、スクリプトの実行が完了するまで処理がブロックされないため、APIの応答に影響を与えないため、原則非同期実行を使用することをおすすめします。

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

型必須デフォルト値の制限説明
triggerScriptIdstring~ 1024文字スクリプトGRN
doneTriggerTargetTypeenum [
“none”,
“gs2_script”,
“aws”
]
✓“none”~ 128文字完了通知の通知先
doneTriggerScriptIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字スクリプトGRN
doneTriggerQueueNamespaceIdstring{doneTriggerTargetType} == “gs2_script”~ 1024文字ネームスペースGRN

LogSetting

ログの書き出し設定

ログデータの書き出し設定を管理します。この型は、ログデータを書き出すために使用されるログ名前空間の識別子（Namespace ID）を保持します。 ログ名前空間IDは、ログデータを集約し、保存する対象の GS2-Log の名前空間を指定します。 この設定を通じて、この名前空間以下のAPIリクエスト・レスポンスログデータが対象の GS2-Log へ出力されるようになります。 GS2-Log にはリアルタイムでログが提供され、システムの監視や分析、デバッグなどに利用できます。

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

TransactionSetting

トランザクション設定

型必須デフォルト値の制限説明
enableAutoRunbool✓false発行したスタンプシートをサーバーサイドで自動的に実行するか
distributorNamespaceIdstring✓“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024文字スタンプシートの実行に使用する GS2-Distributor ネームスペース
keyIdstring!{enableAutoRun}“grn:gs2:{region}:{ownerId}:key:default:key:default”~ 1024文字スタンプシートの署名に使用する GS2-Key の暗号鍵
queueNamespaceIdstring✓“grn:gs2:{region}:{ownerId}:queue:default”~ 1024文字スタンプシートの実行に使用する GS2-JobQueue のネームスペース