Master Data Reference of GS2-Lottery

{
  "version": "2019-02-21",
  "lotteryModels": [
    {
      "name": "[string]Lottery Model Name",
      "metadata": "[string?]Metadata",
      "mode": "[string]Drawing mode",
      "method": "[string]Lottery Method",
      "prizeTableName": "[string]Name of prize table",
      "choicePrizeTableScriptId": "[string]GS2-Script script to determine the emission probability table"
    }
  ],
  "prizeTables": [
    {
      "name": "[string]Name of prize table",
      "metadata": "[string?]Metadata",
      "prizes": [
        {
          "prizeId": "[string]Prize ID",
          "type": "[string]Type of prize",
          "acquireActions": [
            {
              "action": "[string]Types of actions to be performed in the acquire action",
              "request": "[string]JSON of request"
            }
          ],
          "drawnLimit": "[int?]Maximum number of draws",
          "limitFailOverPrizeId": "[string]Prize ID to be discharged instead when the maximum number of drawn has been reached.",
          "prizeTableName": "[string]Name of prize table",
          "weight": "[int]Emission Weight"
        }
      ]
    }
  ]
}

PrizeTable

Prize Table

A prize can either specify an acquire action directly or reference another probability table. By nesting probability tables, you can configure a two-step drawing process—for example, the first step determines the rarity such as SSR, SR, or R, and the second step selects a specific item corresponding to that rarity. This structure makes it easier to manage and adjust the overall distribution rates for each rarity in the game.

Probability

Probability

Prize

Prize

DrawnPrize

Types of prizes

BoxItem

Item taken out of the lottery box

AcquireAction

Acquire Action

VerifyActionResult

Verify action execution result

ConsumeActionResult

Consume action execution result

AcquireActionResult

Acquire action execution result

TransactionResult

Transaction execution results

Transaction execution results executed using server-side transaction auto-execution functionality

LotteryModel

Lottery Model

The Lottery Model is the entity that defines the emission method and emission rate in Lottery. Two draw methods are available: Standard Draw, which performs draws with a fixed probability each time, and Box Draw, where a predetermined number of prizes are placed in a box, and prizes are drawn from the box one by one with each draw.

The lottery process uses a prize table. GS2-Script can be used to replace a part of the prize table with a different table when multiple drawings are performed. By using this mechanism, it is possible to apply a different prize table only once in a 10-round gacha.