GS2-Deploy/CDK Reference of GS2-Lottery

Entities

Namespace

Namespace

Namespace is a mechanism that allows multiple uses of the same service for different purposes within a single project. Basically, GS2 services have a layer called namespace, and different namespaces are treated as completely different data spaces, even for the same service.

Therefore, it is necessary to create a namespace before starting to use each service.

TypeRequireDefaultLimitationDescription
namestring~ 32 charsNamespace name
descriptionstring~ 1024 charsDescription
transactionSettingTransactionSettingTransaction settings
lotteryTriggerScriptIdstring~ 1024 charsGS2-Script scripts to be called when the lottery is executed
choicePrizeTableScriptIdstring~ 1024 charsGS2-Script script for dynamically determining lottery probability tables
logSettingLogSettingLog output settings

GetAttr

TypeDescription
ItemNamespaceNamespace created

Implementation Example

Type: GS2::Lottery::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
  LotteryTriggerScriptId: null
  ChoicePrizeTableScriptId: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
from gs2_cdk import Stack, core, lottery

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        lottery.Namespace(
            stack=self,
            name="namespace-0001",
            options=lottery.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\Lottery\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Lottery\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.lottery.model.Namespace(
            this,
            "namespace-0001",
            new io.gs2.cdk.lottery.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 lottery from "@/gs2cdk/lottery";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new lottery.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.Gs2Lottery.Model.Namespace(
            this,
            "namespace-0001",
            new Gs2Cdk.Gs2Lottery.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

CurrentLotteryMaster

Currently available master data

GS2 uses JSON format files for master data management. By uploading the file, you can actually reflect the settings on the server.

We provide a master data editor on the management console as a way to create JSON files, but you can also create JSON files using the The service can also be used by creating a tool more appropriate for game management and exporting a JSON file in the appropriate format.

Please refer to the documentation for the format of the JSON file.

TypeRequireDefaultLimitationDescription
namespaceNamestring~ 32 charsNamespace name
settingsstring~ 5242880 charsMaster data

GetAttr

TypeDescription
ItemCurrentLotteryMasterUpdated, currently available lottery settings

Implementation Example

Type: GS2::Lottery::CurrentLotteryMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-02-21",
    "lotteryModels": [
      {
        "name": "gacha",
        "metadata": "GACHA",
        "mode": "normal",
        "method": "prize_table",
        "prizeTableName": "gacha"
      },
      {
        "name": "gacha_ssr",
        "metadata": "SSR",
        "mode": "normal",
        "method": "prize_table",
        "prizeTableName": "gacha-ssr"
      },
      {
        "name": "gacha_sr",
        "metadata": "SR",
        "mode": "normal",
        "method": "prize_table",
        "prizeTableName": "gacha-sr"
      },
      {
        "name": "gacha_r",
        "metadata": "R",
        "mode": "normal",
        "method": "prize_table",
        "prizeTableName": "gacha-r"
      },
      {
        "name": "box",
        "metadata": "BOX",
        "mode": "box",
        "method": "prize_table",
        "prizeTableName": "box"
      }
    ],
    "prizeTables": [
      {
        "name": "gacha",
        "metadata": "SSR",
        "prizes": [
          {
            "prizeId": "prize-1",
            "type": "prize_table",
            "prizeTableName": "gacha-ssr",
            "weight": 5
          },
          {
            "prizeId": "prize-2",
            "type": "prize_table",
            "prizeTableName": "gacha-sr",
            "weight": 15
          },
          {
            "prizeId": "prize-3",
            "type": "prize_table",
            "prizeTableName": "gacha-r",
            "weight": 80
          }
        ]
      },
      {
        "name": "gacha-ssr",
        "metadata": "SSR",
        "prizes": [
          {
            "prizeId": "prize-4",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 1
          },
          {
            "prizeId": "prize-5",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 2
          },
          {
            "prizeId": "prize-6",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 3
          }
        ]
      },
      {
        "name": "gacha-sr",
        "metadata": "SR",
        "prizes": [
          {
            "prizeId": "prize-7",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 10
          },
          {
            "prizeId": "prize-8",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 20
          },
          {
            "prizeId": "prize-9",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 30
          }
        ]
      },
      {
        "name": "gacha-r",
        "metadata": "R",
        "prizes": [
          {
            "prizeId": "prize-10",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 100
          },
          {
            "prizeId": "prize-11",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 200
          },
          {
            "prizeId": "prize-12",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 300
          }
        ]
      },
      {
        "name": "box",
        "metadata": "BOX",
        "prizes": [
          {
            "prizeId": "prize-13",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 30
          },
          {
            "prizeId": "prize-14",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 20
          },
          {
            "prizeId": "prize-15",
            "type": "action",
            "acquireActions": [
              {
                "action": "Gs2Money:DepositByUserId",
                "request": "{\\"count\\": 1}"
              }
            ],
            "weight": 10
          }
        ]
      }
    ]
  }
from gs2_cdk import Stack, core, lottery

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        lottery.Namespace(
            stack=self,
            # omission
        ).master_data(
            [
                lottery.LotteryModel(
                    name='gacha',
                    mode='normal',
                    method='prize_table',
                    options=lottery.LotteryModelOptions(
                        metadata='GACHA',
                        prize_table_name='gacha',
                    ),
                ),
                lottery.LotteryModel(
                    name='gacha_ssr',
                    mode='normal',
                    method='prize_table',
                    options=lottery.LotteryModelOptions(
                        metadata='SSR',
                        prize_table_name='gacha-ssr',
                    ),
                ),
                lottery.LotteryModel(
                    name='gacha_sr',
                    mode='normal',
                    method='prize_table',
                    options=lottery.LotteryModelOptions(
                        metadata='SR',
                        prize_table_name='gacha-sr',
                    ),
                ),
                lottery.LotteryModel(
                    name='gacha_r',
                    mode='normal',
                    method='prize_table',
                    options=lottery.LotteryModelOptions(
                        metadata='R',
                        prize_table_name='gacha-r',
                    ),
                ),
                lottery.LotteryModel(
                    name='box',
                    mode='box',
                    method='prize_table',
                    options=lottery.LotteryModelOptions(
                        metadata='BOX',
                        prize_table_name='box',
                    ),
                ),
            ],
            [
                lottery.PrizeTable(
                    name='gacha',
                    prizes=[    {'prizeId': 'prize-1', 'type': 'prize_table', 'prizeTableName': 'gacha-ssr', 'weight': 5},
                        {'prizeId': 'prize-2', 'type': 'prize_table', 'prizeTableName': 'gacha-sr', 'weight': 15},
                        {'prizeId': 'prize-3', 'type': 'prize_table', 'prizeTableName': 'gacha-r', 'weight': 80},
                        ],
                    options=lottery.PrizeTableOptions(
                        metadata='SSR',
                    ),
                ),
                lottery.PrizeTable(
                    name='gacha-ssr',
                    prizes=[    {'prizeId': 'prize-4', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 1},
                        {'prizeId': 'prize-5', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 2},
                        {'prizeId': 'prize-6', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 3},
                        ],
                    options=lottery.PrizeTableOptions(
                        metadata='SSR',
                    ),
                ),
                lottery.PrizeTable(
                    name='gacha-sr',
                    prizes=[    {'prizeId': 'prize-7', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10},
                        {'prizeId': 'prize-8', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                        {'prizeId': 'prize-9', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30},
                        ],
                    options=lottery.PrizeTableOptions(
                        metadata='SR',
                    ),
                ),
                lottery.PrizeTable(
                    name='gacha-r',
                    prizes=[    {'prizeId': 'prize-10', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 100},
                        {'prizeId': 'prize-11', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 200},
                        {'prizeId': 'prize-12', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 300},
                        ],
                    options=lottery.PrizeTableOptions(
                        metadata='R',
                    ),
                ),
                lottery.PrizeTable(
                    name='box',
                    prizes=[    {'prizeId': 'prize-13', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30},
                        {'prizeId': 'prize-14', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                        {'prizeId': 'prize-15', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10},
                        ],
                    options=lottery.PrizeTableOptions(
                        metadata='BOX',
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template
class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Lottery\Model\Namespace_(
            stack: $this,
            // omission
        ))->masterData(
            [
                new \Gs2Cdk\Lottery\Model\LotteryModel(
                    name:"gacha",
                    mode: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMode::NORMAL
                    method: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMethod::PRIZE_TABLE
                    options: new \Gs2Cdk\Lottery\Model\Options\LotteryModelOptions(
                        metadata:"GACHA",
                        prizeTableName:"gacha",
                    ),
                ),
                new \Gs2Cdk\Lottery\Model\LotteryModel(
                    name:"gacha_ssr",
                    mode: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMode::NORMAL
                    method: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMethod::PRIZE_TABLE
                    options: new \Gs2Cdk\Lottery\Model\Options\LotteryModelOptions(
                        metadata:"SSR",
                        prizeTableName:"gacha-ssr",
                    ),
                ),
                new \Gs2Cdk\Lottery\Model\LotteryModel(
                    name:"gacha_sr",
                    mode: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMode::NORMAL
                    method: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMethod::PRIZE_TABLE
                    options: new \Gs2Cdk\Lottery\Model\Options\LotteryModelOptions(
                        metadata:"SR",
                        prizeTableName:"gacha-sr",
                    ),
                ),
                new \Gs2Cdk\Lottery\Model\LotteryModel(
                    name:"gacha_r",
                    mode: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMode::NORMAL
                    method: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMethod::PRIZE_TABLE
                    options: new \Gs2Cdk\Lottery\Model\Options\LotteryModelOptions(
                        metadata:"R",
                        prizeTableName:"gacha-r",
                    ),
                ),
                new \Gs2Cdk\Lottery\Model\LotteryModel(
                    name:"box",
                    mode: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMode::BOX
                    method: \Gs2Cdk\Lottery\Model\Enums\CurrentLotteryMasterMethod::PRIZE_TABLE
                    options: new \Gs2Cdk\Lottery\Model\Options\LotteryModelOptions(
                        metadata:"BOX",
                        prizeTableName:"box",
                    ),
                ),
            ],
            [
                new \Gs2Cdk\Lottery\Model\PrizeTable(
                    name:"gacha",
                    prizes:[    {'prizeId': 'prize-1', 'type': 'prize_table', 'prizeTableName': 'gacha-ssr', 'weight': 5},
                    {'prizeId': 'prize-2', 'type': 'prize_table', 'prizeTableName': 'gacha-sr', 'weight': 15},
                    {'prizeId': 'prize-3', 'type': 'prize_table', 'prizeTableName': 'gacha-r', 'weight': 80},
                    ],
                    options: new \Gs2Cdk\Lottery\Model\Options\PrizeTableOptions(
                        metadata:"SSR",
                    ),
                ),
                new \Gs2Cdk\Lottery\Model\PrizeTable(
                    name:"gacha-ssr",
                    prizes:[    {'prizeId': 'prize-4', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 1},
                    {'prizeId': 'prize-5', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 2},
                    {'prizeId': 'prize-6', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 3},
                    ],
                    options: new \Gs2Cdk\Lottery\Model\Options\PrizeTableOptions(
                        metadata:"SSR",
                    ),
                ),
                new \Gs2Cdk\Lottery\Model\PrizeTable(
                    name:"gacha-sr",
                    prizes:[    {'prizeId': 'prize-7', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10},
                    {'prizeId': 'prize-8', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                    {'prizeId': 'prize-9', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30},
                    ],
                    options: new \Gs2Cdk\Lottery\Model\Options\PrizeTableOptions(
                        metadata:"SR",
                    ),
                ),
                new \Gs2Cdk\Lottery\Model\PrizeTable(
                    name:"gacha-r",
                    prizes:[    {'prizeId': 'prize-10', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 100},
                    {'prizeId': 'prize-11', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 200},
                    {'prizeId': 'prize-12', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 300},
                    ],
                    options: new \Gs2Cdk\Lottery\Model\Options\PrizeTableOptions(
                        metadata:"R",
                    ),
                ),
                new \Gs2Cdk\Lottery\Model\PrizeTable(
                    name:"box",
                    prizes:[    {'prizeId': 'prize-13', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30},
                    {'prizeId': 'prize-14', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                    {'prizeId': 'prize-15', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10},
                    ],
                    options: new \Gs2Cdk\Lottery\Model\Options\PrizeTableOptions(
                        metadata:"BOX",
                    ),
                ),
            ],
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template
class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.lottery.model.Namespace(
            this,
            // omission
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.lottery.model.LotteryModel(
                    "gacha",
                    Normal,
                    PrizeTable,
                    new io.gs2.cdk.lottery.model.options.LotteryModelOptions() {
                        {
                            metadata: "GACHA";
                            prizeTableName: "gacha";
                        }
                    }
                ),
                new io.gs2.cdk.lottery.model.LotteryModel(
                    "gacha_ssr",
                    Normal,
                    PrizeTable,
                    new io.gs2.cdk.lottery.model.options.LotteryModelOptions() {
                        {
                            metadata: "SSR";
                            prizeTableName: "gacha-ssr";
                        }
                    }
                ),
                new io.gs2.cdk.lottery.model.LotteryModel(
                    "gacha_sr",
                    Normal,
                    PrizeTable,
                    new io.gs2.cdk.lottery.model.options.LotteryModelOptions() {
                        {
                            metadata: "SR";
                            prizeTableName: "gacha-sr";
                        }
                    }
                ),
                new io.gs2.cdk.lottery.model.LotteryModel(
                    "gacha_r",
                    Normal,
                    PrizeTable,
                    new io.gs2.cdk.lottery.model.options.LotteryModelOptions() {
                        {
                            metadata: "R";
                            prizeTableName: "gacha-r";
                        }
                    }
                ),
                new io.gs2.cdk.lottery.model.LotteryModel(
                    "box",
                    Box,
                    PrizeTable,
                    new io.gs2.cdk.lottery.model.options.LotteryModelOptions() {
                        {
                            metadata: "BOX";
                            prizeTableName: "box";
                        }
                    }
                )
            ),
            Arrays.asList(
                new io.gs2.cdk.lottery.model.PrizeTable(
                    "gacha",
                    Arrays.asList(
                        {'prizeId': 'prize-1', 'type': 'prize_table', 'prizeTableName': 'gacha-ssr', 'weight': 5},
                    {'prizeId': 'prize-2', 'type': 'prize_table', 'prizeTableName': 'gacha-sr', 'weight': 15},
                    {'prizeId': 'prize-3', 'type': 'prize_table', 'prizeTableName': 'gacha-r', 'weight': 80}
                    ),
                    new io.gs2.cdk.lottery.model.options.PrizeTableOptions() {
                        {
                            metadata: "SSR";
                        }
                    }
                ),
                new io.gs2.cdk.lottery.model.PrizeTable(
                    "gacha-ssr",
                    Arrays.asList(
                        {'prizeId': 'prize-4', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 1},
                    {'prizeId': 'prize-5', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 2},
                    {'prizeId': 'prize-6', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 3}
                    ),
                    new io.gs2.cdk.lottery.model.options.PrizeTableOptions() {
                        {
                            metadata: "SSR";
                        }
                    }
                ),
                new io.gs2.cdk.lottery.model.PrizeTable(
                    "gacha-sr",
                    Arrays.asList(
                        {'prizeId': 'prize-7', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10},
                    {'prizeId': 'prize-8', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                    {'prizeId': 'prize-9', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30}
                    ),
                    new io.gs2.cdk.lottery.model.options.PrizeTableOptions() {
                        {
                            metadata: "SR";
                        }
                    }
                ),
                new io.gs2.cdk.lottery.model.PrizeTable(
                    "gacha-r",
                    Arrays.asList(
                        {'prizeId': 'prize-10', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 100},
                    {'prizeId': 'prize-11', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 200},
                    {'prizeId': 'prize-12', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 300}
                    ),
                    new io.gs2.cdk.lottery.model.options.PrizeTableOptions() {
                        {
                            metadata: "R";
                        }
                    }
                ),
                new io.gs2.cdk.lottery.model.PrizeTable(
                    "box",
                    Arrays.asList(
                        {'prizeId': 'prize-13', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30},
                    {'prizeId': 'prize-14', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                    {'prizeId': 'prize-15', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10}
                    ),
                    new io.gs2.cdk.lottery.model.options.PrizeTableOptions() {
                        {
                            metadata: "BOX";
                        }
                    }
                )
            )
        );
    }
}

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new lottery.model.Namespace(
            this,
            // omission
        ).masterData(
            [
                new lottery.model.LotteryModel(
                    "gacha",
                    lottery.model.CurrentLotteryMasterMode.NORMAL,
                    lottery.model.CurrentLotteryMasterMethod.PRIZE_TABLE,
                    {
                        metadata: "GACHA",
                        prizeTableName: "gacha"
                    }
                ),
                new lottery.model.LotteryModel(
                    "gacha_ssr",
                    lottery.model.CurrentLotteryMasterMode.NORMAL,
                    lottery.model.CurrentLotteryMasterMethod.PRIZE_TABLE,
                    {
                        metadata: "SSR",
                        prizeTableName: "gacha-ssr"
                    }
                ),
                new lottery.model.LotteryModel(
                    "gacha_sr",
                    lottery.model.CurrentLotteryMasterMode.NORMAL,
                    lottery.model.CurrentLotteryMasterMethod.PRIZE_TABLE,
                    {
                        metadata: "SR",
                        prizeTableName: "gacha-sr"
                    }
                ),
                new lottery.model.LotteryModel(
                    "gacha_r",
                    lottery.model.CurrentLotteryMasterMode.NORMAL,
                    lottery.model.CurrentLotteryMasterMethod.PRIZE_TABLE,
                    {
                        metadata: "R",
                        prizeTableName: "gacha-r"
                    }
                ),
                new lottery.model.LotteryModel(
                    "box",
                    lottery.model.CurrentLotteryMasterMode.BOX,
                    lottery.model.CurrentLotteryMasterMethod.PRIZE_TABLE,
                    {
                        metadata: "BOX",
                        prizeTableName: "box"
                    }
                )
            ],
            [
                new lottery.model.PrizeTable(
                    "gacha",
                    [
                        {'prizeId': 'prize-1', 'type': 'prize_table', 'prizeTableName': 'gacha-ssr', 'weight': 5},
                    {'prizeId': 'prize-2', 'type': 'prize_table', 'prizeTableName': 'gacha-sr', 'weight': 15},
                    {'prizeId': 'prize-3', 'type': 'prize_table', 'prizeTableName': 'gacha-r', 'weight': 80}
                    ],
                    {
                        metadata: "SSR"
                    }
                ),
                new lottery.model.PrizeTable(
                    "gacha-ssr",
                    [
                        {'prizeId': 'prize-4', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 1},
                    {'prizeId': 'prize-5', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 2},
                    {'prizeId': 'prize-6', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 3}
                    ],
                    {
                        metadata: "SSR"
                    }
                ),
                new lottery.model.PrizeTable(
                    "gacha-sr",
                    [
                        {'prizeId': 'prize-7', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10},
                    {'prizeId': 'prize-8', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                    {'prizeId': 'prize-9', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30}
                    ],
                    {
                        metadata: "SR"
                    }
                ),
                new lottery.model.PrizeTable(
                    "gacha-r",
                    [
                        {'prizeId': 'prize-10', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 100},
                    {'prizeId': 'prize-11', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 200},
                    {'prizeId': 'prize-12', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 300}
                    ],
                    {
                        metadata: "R"
                    }
                ),
                new lottery.model.PrizeTable(
                    "box",
                    [
                        {'prizeId': 'prize-13', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30},
                    {'prizeId': 'prize-14', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                    {'prizeId': 'prize-15', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10}
                    ],
                    {
                        metadata: "BOX"
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template
public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Lottery.Model.Namespace(
            this,
            // omission
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Lottery.Model.LotteryModel(
                    "gacha",
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMode.Normal,
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMethod.PrizeTable,
                    new Gs2Cdk.Gs2Lottery.Model.Options.LotteryModelOptions {
                        metadata = "GACHA",
                        prizeTableName = "gacha",
                    }
                ),
                new Gs2Cdk.Gs2Lottery.Model.LotteryModel(
                    "gacha_ssr",
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMode.Normal,
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMethod.PrizeTable,
                    new Gs2Cdk.Gs2Lottery.Model.Options.LotteryModelOptions {
                        metadata = "SSR",
                        prizeTableName = "gacha-ssr",
                    }
                ),
                new Gs2Cdk.Gs2Lottery.Model.LotteryModel(
                    "gacha_sr",
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMode.Normal,
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMethod.PrizeTable,
                    new Gs2Cdk.Gs2Lottery.Model.Options.LotteryModelOptions {
                        metadata = "SR",
                        prizeTableName = "gacha-sr",
                    }
                ),
                new Gs2Cdk.Gs2Lottery.Model.LotteryModel(
                    "gacha_r",
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMode.Normal,
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMethod.PrizeTable,
                    new Gs2Cdk.Gs2Lottery.Model.Options.LotteryModelOptions {
                        metadata = "R",
                        prizeTableName = "gacha-r",
                    }
                ),
                new Gs2Cdk.Gs2Lottery.Model.LotteryModel(
                    "box",
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMode.Box,
                    Gs2Cdk.Gs2Lottery.Model.Enums.CurrentLotteryMasterMethod.PrizeTable,
                    new Gs2Cdk.Gs2Lottery.Model.Options.LotteryModelOptions {
                        metadata = "BOX",
                        prizeTableName = "box",
                    }
                )
            },
            new [] {
                new Gs2Cdk.Gs2Lottery.Model.PrizeTable(
                    "gacha",
                    new Gs2Cdk.Gs2Lottery.Model.Prize[] {
                        {'prizeId': 'prize-1', 'type': 'prize_table', 'prizeTableName': 'gacha-ssr', 'weight': 5},
                    {'prizeId': 'prize-2', 'type': 'prize_table', 'prizeTableName': 'gacha-sr', 'weight': 15},
                    {'prizeId': 'prize-3', 'type': 'prize_table', 'prizeTableName': 'gacha-r', 'weight': 80}
                    },
                    new Gs2Cdk.Gs2Lottery.Model.Options.PrizeTableOptions {
                        metadata = "SSR",
                    }
                ),
                new Gs2Cdk.Gs2Lottery.Model.PrizeTable(
                    "gacha-ssr",
                    new Gs2Cdk.Gs2Lottery.Model.Prize[] {
                        {'prizeId': 'prize-4', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 1},
                    {'prizeId': 'prize-5', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 2},
                    {'prizeId': 'prize-6', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 3}
                    },
                    new Gs2Cdk.Gs2Lottery.Model.Options.PrizeTableOptions {
                        metadata = "SSR",
                    }
                ),
                new Gs2Cdk.Gs2Lottery.Model.PrizeTable(
                    "gacha-sr",
                    new Gs2Cdk.Gs2Lottery.Model.Prize[] {
                        {'prizeId': 'prize-7', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10},
                    {'prizeId': 'prize-8', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                    {'prizeId': 'prize-9', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30}
                    },
                    new Gs2Cdk.Gs2Lottery.Model.Options.PrizeTableOptions {
                        metadata = "SR",
                    }
                ),
                new Gs2Cdk.Gs2Lottery.Model.PrizeTable(
                    "gacha-r",
                    new Gs2Cdk.Gs2Lottery.Model.Prize[] {
                        {'prizeId': 'prize-10', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 100},
                    {'prizeId': 'prize-11', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 200},
                    {'prizeId': 'prize-12', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 300}
                    },
                    new Gs2Cdk.Gs2Lottery.Model.Options.PrizeTableOptions {
                        metadata = "R",
                    }
                ),
                new Gs2Cdk.Gs2Lottery.Model.PrizeTable(
                    "box",
                    new Gs2Cdk.Gs2Lottery.Model.Prize[] {
                        {'prizeId': 'prize-13', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 30},
                    {'prizeId': 'prize-14', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 20},
                    {'prizeId': 'prize-15', 'type': 'action', 'acquireActions': [{'action': 'Gs2Money:DepositByUserId', 'request': '{"count": 1}'}], 'weight': 10}
                    },
                    new Gs2Cdk.Gs2Lottery.Model.Options.PrizeTableOptions {
                        metadata = "BOX",
                    }
                )
            }
        );
    }
}

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

Probability

TypeRequireDefaultLimitationDescription
prizeDrawnPrizeType of prize
ratefloat~ 1.0Emission probability (0.0-1.0)

Prize

Prize

TypeRequireDefaultLimitationDescription
prizeIdstringUUID~ 36 charsPrize ID
typeenum [
“action”,
“prize_table”
]
~ 128 charsType of prize
acquireActionsList<AcquireAction>{type} == “action”[]1 ~ 100 itemsList of Acquire Action
drawnLimitint{type} == “action”1 ~ 100000Maximum number of draws
limitFailOverPrizeIdstring{type} == “action” and {drawnLimit} > 0~ 32 charsPrize ID to be discharged instead when the maximum number of drawn has been reached.
prizeTableNamestring{type} == “prize_table”~ 128 charsName of prize table
weightint1 ~ 2147483646Emission Weight

DrawnPrize

Types of prizes

TypeRequireDefaultLimitationDescription
prizeIdstring~ 36 charsPrize ID
acquireActionsList<AcquireAction>~ 100 itemsList of Acquire Actions

BoxItem

Item taken out of the lottery box

TypeRequireDefaultLimitationDescription
prizeIdstring~ 128 charsPrize Id
acquireActionsList<AcquireAction>~ 100 itemsList of Acquire Action
remainingint~ 2147483646Remaining quantity
initialint~ 2147483646Initial quantity

AcquireAction

Acquire Action

TypeRequireDefaultLimitationDescription
actionenum [
"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:UnlockIncrementalExchangeByUserId",
"Gs2Exchange:CreateAwaitByUserId",
"Gs2Exchange:SkipByUserId",
"Gs2Experience:AddExperienceByUserId",
"Gs2Experience:SetExperienceByUserId",
"Gs2Experience:AddRankCapByUserId",
"Gs2Experience:SetRankCapByUserId",
"Gs2Experience:MultiplyAcquireActionsByUserId",
"Gs2Formation:AddMoldCapacityByUserId",
"Gs2Formation:SetMoldCapacityByUserId",
"Gs2Formation:AcquireActionsToFormProperties",
"Gs2Formation:SetFormByUserId",
"Gs2Formation:AcquireActionsToPropertyFormProperties",
"Gs2Grade:AddGradeByUserId",
"Gs2Grade:ApplyRankCapByUserId",
"Gs2Grade:MultiplyAcquireActionsByUserId",
"Gs2Idle:IncreaseMaximumIdleMinutesByUserId",
"Gs2Idle:SetMaximumIdleMinutesByUserId",
"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",
"Gs2Money:DepositByUserId",
"Gs2Money:RevertRecordReceipt",
"Gs2Quest:CreateProgressByUserId",
"Gs2Schedule:TriggerByUserId",
"Gs2SerialKey:RevertUseByUserId",
"Gs2Showcase:DecrementPurchaseCountByUserId",
"Gs2Showcase:ForceReDrawByUserId",
"Gs2SkillTree:MarkReleaseByUserId",
"Gs2Stamina:RecoverStaminaByUserId",
"Gs2Stamina:RaiseMaxValueByUserId",
"Gs2Stamina:SetMaxValueByUserId",
"Gs2Stamina:SetRecoverIntervalByUserId",
"Gs2Stamina:SetRecoverValueByUserId",
"Gs2StateMachine:StartStateMachineByUserId",
]
~ 128 charsTypes of actions to be performed in the stamp sheet
requeststring~ 1048576 charsJSON of request

Config

Configration

Set values to be applied to stamp sheet variables

TypeRequireDefaultLimitationDescription
keystring~ 64 charsName
valuestring~ 51200 charsValue

GitHubCheckoutSetting

Setup to check out master data from GitHub

TypeRequireDefaultLimitationDescription
apiKeyIdstring~ 1024 charsGitHub API key GRN
repositoryNamestring~ 1024 charsRepository Name
sourcePathstring~ 1024 charsSource code file path
referenceTypeenum [
“commit_hash”,
“branch”,
“tag”
]
~ 128 charsSource of code
commitHashstring{referenceType} == “commit_hash”~ 1024 charsCommit hash
branchNamestring{referenceType} == “branch”~ 1024 charsBranch Name
tagNamestring{referenceType} == “tag”~ 1024 charsTag Name

LogSetting

Log setting

This type manages log output settings. This type holds the identifier of the log namespace used to output log data. The log namespace ID specifies the GS2-Log namespace to aggregate and store the log data. Through this setting, API request and response log data under this namespace will be output to the target GS2-Log. GS2-Log provides logs in real time, which can be used for system monitoring, analysis, debugging, etc.

TypeRequireDefaultLimitationDescription
loggingNamespaceIdstring~ 1024 charsNamespace GRN

TransactionSetting

Transaction settings

TypeRequireDefaultLimitationDescription
enableAutoRunboolfalseAutomatically run issued stamp sheets on the server side, or
distributorNamespaceIdstring“grn:gs2:{region}:{ownerId}:distributor:default”~ 1024 charsGS2-Distributor namespace used for stamp sheet execution
keyIdstring!{enableAutoRun}“grn:gs2:{region}:{ownerId}:key:default:key:default”~ 1024 charsGS2-Key encryption key used to sign the stamp sheet
queueNamespaceIdstring“grn:gs2:{region}:{ownerId}:queue:default”~ 1024 charsNamespace in GS2-JobQueue used to run the stamp sheet