GS2-Lottery API Reference

This service realizes the lottery process.

Lottery processing is based on a Prize Table. The Prize Table is used to set the weight of each prize to be ejected. For example, if you set 3 for prize A and 1 for prize B, the ejection probability of prize A is 75% and that of prize B is 25%.

You can also set other Prize Tables. By preparing tables for each rarity (SSR, SR, R, etc.) in advance, and then creating a table for each of these rarities as prizes, it is easy to set the draw probability for each rarity.

There are two modes of lottery processing, which can be set in the Lottery Model. The first is a mode in which the lottery is processed uniformly with the same probability each time, and the second is a box-gacha mode. In the box gacha mode, a prize is removed from the box each time the lottery is processed, and all the prizes are obtained when the same number of times as the number of prizes initially placed in the box is drawn. When Box Gacha is set as the mode, the lottery begins with the number of prizes in the box equal to the number of weights set in the ejection table.