Trigger Reference of GS2-Lottery Script

Reference of event triggers that call extended scripts

Trigger

lottery

drawing

Synchronous Execution Script

Script and drawing are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
lotteryModel	LotteryModel	Lottery Model Name
drawnPrizes	DrawnPrize[]	List of Drawn Prizes
boxItems	BoxItems	List of items taken out of the box

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow lottery
overrideDrawnPrizes	DrawnPrize[]			0 ~ 1000 items	List of Drawn Prizes

Implementation Example

namespace = args.namespace
lotteryModel = args.lotteryModel
drawnPrizes = args.drawnPrizes
boxItems = args.boxItems

result = {
  permit=permit,
  overrideDrawnPrizes=overrideDrawnPrizes
}

choicePrizeTable

A script that dynamically changes the lottery table

Synchronous Execution Script

Script and A script that dynamically changes the lottery table are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
lotteryModel	LotteryModel	Lottery model for dynamically selecting lottery tables
userId	string	User ID
count	int	Number of draws

Result

	Type	Required	Default	Value Limits	Description
prizeTableNames	string[]	✓		1 ~ 1000 items	List of prize table names to be used for the lottery Up to 10 prize tables can be responded to when drawing 10 times. If you respond with less than 10 prize tables, the responded prize tables will be used in order, and the remaining draws will be made with the last responded prize table. For example, if you respond with 3 prize tables, the 1st and 2nd draws will use the 1st prize table, the 3rd and 4th draws will use the 2nd prize table, and the 5th to 10th draws will use the 3rd prize table.

Implementation Example

namespace = args.namespace
lotteryModel = args.lotteryModel
userId = args.userId
count = args.count

result = {
  prizeTableNames=prizeTableNames
}