Trigger Reference of GS2-Lottery Script
Reference of event triggers that call extended scripts
lottery
Event trigger to call GS2-Script when drawing.
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 | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
permit | bool | ✓ | Allow lottery | ||
overrideDrawnPrizes | DrawnPrize[] | ~ 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
Event trigger to call GS2-Script when A script that dynamically changes the lottery table.
Request
Type | Description | |
---|---|---|
namespace | Namespace | Namespace |
lotteryModel | LotteryModel | Cost increase type exchange rate model |
userId | string | User Id |
count | int | Number of draws |
Result
Type | Require | Default | Limitation | Description | |
---|---|---|---|---|---|
prizeTableNames | string[] | ✓ | 1 ~ 1000 items | List of prize table names to be used for the lottery |
Implementation Example
namespace = args.namespace
lotteryModel = args.lotteryModel
userId = args.userId
count = args.count
result = {
prizeTableNames=prizeTableNames
}