MOGS API 文档

# Class: Lottery

• Lottery()

抽奖项目

# Properties

# Readonly consumedItems

• consumedItems: keyof LotteryConsumedItem[]

需要消耗的属性(或物品)相关信息列表

description 该属性可以配置为消耗属性(例如金币、钻石)或背包中的物品，详情参见"属性系统"和"背包系统"。

Returns: keyof LotteryConsumedItem[]

# Optional latestDrawnTime

• latestDrawnTime? : Date

最近抽奖时间

Returns: Date

# Optional Readonly limitation

• limitation? : Limitation

抽奖项目 限制信息

description 该属性可以表达当前抽奖项目的限制条件，举例："每周最多抽奖 10 次，当前剩余 3 次"。

description 若当前抽奖项目没有设置限制，则该属性为空。

Returns: Limitation

# Readonly lotteryItems

• lotteryItems: keyof LotteryItem[]

可能抽到的奖品信息列表

Returns: keyof LotteryItem[]

# Optional Readonly specialLottery

• specialLottery? : SpecialLottery

特殊抽奖相关配置

description 可用于实现类似于"保底"的特性。

description 举例来说，游戏侧可以配置为"每 5 次抽奖，就从一个特殊的奖池中抽取一次"；这种配置下，玩家前四次抽奖，都会使用当前抽奖项目的默认奖池，但第五次抽奖时，会使用配置好的特殊奖池；第五次抽奖结束后，该计数器会自动归零。

Returns: SpecialLottery

# Accessors

# description

• get description(): string | undefined

抽奖项目描述

# 返回值:

string | undefined

# id

• get id(): number

抽奖项目 ID

# 返回值:

number

# 事件监听

# offLotteryDrawnTimeChange

▸ offLotteryDrawnTimeChange(handler?: LotteryDrawnTimeChangeEventHandler): void

取消注册 当前抽奖项目(最近)抽奖时间改变 事件处理函数

# 参数:

属性 类型
handler? LotteryDrawnTimeChangeEventHandler

# 返回值:

void

# offLotteryRemainingCountChange

▸ offLotteryRemainingCountChange(handler?: LotteryRemainingCountChangeEventHandler): void

取消注册 (当前抽奖项目)剩余次数改变 事件处理函数

# 参数:

属性 类型
handler? LotteryRemainingCountChangeEventHandler

# 返回值:

void

# offSpecialLotteryCountChange

▸ offSpecialLotteryCountChange(handler: SpecialLotteryCountChangeEventHandler): void

取消注册 (当前抽奖项目)特殊抽奖次数改变 事件处理函数

# 参数:

属性 类型
handler SpecialLotteryCountChangeEventHandler

# 返回值:

void

# onLotteryDrawnTimeChange

▸ onLotteryDrawnTimeChange(handler: LotteryDrawnTimeChangeEventHandler): void

注册 当前抽奖项目(最近)抽奖时间改变 事件处理函数

# 参数:

属性 类型
handler LotteryDrawnTimeChangeEventHandler

# 返回值:

void

# onLotteryRemainingCountChange

▸ onLotteryRemainingCountChange(handler: LotteryRemainingCountChangeEventHandler): void

注册 (当前抽奖项目)剩余次数改变 事件处理函数

# 参数:

属性 类型
handler LotteryRemainingCountChangeEventHandler

# 返回值:

void

# onSpecialLotteryCountChange

▸ onSpecialLotteryCountChange(handler: SpecialLotteryCountChangeEventHandler): void

注册 (当前抽奖项目)特殊抽奖次数改变 事件处理函数

# 参数:

属性 类型
handler SpecialLotteryCountChangeEventHandler

# 返回值:

void

# 操作触发

# draw

▸ draw(params?: Omit‹DrawLotteryParams, "lotteryId"›): Promise‹DrawLotteryRes›

抽奖(抽取当前抽奖项目)

# 参数:

属性 类型
params? Omit‹DrawLotteryParams, "lotteryId"›

# 返回值:

Promise‹DrawLotteryRes›

← LotteryConsumedItemType →