# Interface: BackpackItem
• BackpackItem()
背包物品
# Properties
# count
• count: Long
物品数量
Returns: Long
# Optional customData
• customData? : string
自定义数据
Returns: string
# Optional Readonly customInt
• customInt? : Long
自定义整形
Returns: Long
# Optional Readonly customStr
• customStr? : string
自定义字符串
Returns: string
# Optional Readonly description
• description? : string
物品描述
Returns: string
# Readonly expireTime
• expireTime: Date
过期时间
Returns: Date
# Readonly id
• id: Long
物品唯一 ID
description 唯一对应一个具体的物品，在一个背包内是唯一的。
Returns: Long
# Optional Readonly incomeId
• incomeId? : number
物品对应收益 ID
description 可在收益系统中查找相关信息。
Returns: number
# Optional Readonly incomeUid
• incomeUid? : Long
物品对应收益唯一 ID
description 可用于在收益系统中查询相关信息。
Returns: Long
# Readonly itemId
• itemId: number
物品 ID
description 对应一个物品(的种类)。由于同一个(种)物品可能在一个背包内占据多个位置，因此这个 ID 不唯一。
deprecated use typeId instead. shall be removed in 0.4.
Returns: number
# Readonly itemUid
• itemUid: Long
物品唯一 ID
description 唯一对应一个具体的物品，在一个背包内是唯一的。
deprecated use id instead. shall be removed in 0.4.
Returns: Long
# Readonly name
• name: string
物品名称
Returns: string
# Optional Readonly ownLimit
• ownLimit? : Long
物品持有上限
description 该物品(在所属背包内)最多持有的数目。
Returns: Long
# Readonly positions
• positions: keyof BackpackItemPosition[]
该物品在所属的背包及其位置
description 若当前物品已经被移出了所有背包，则该属性返回空列表。
Returns: keyof BackpackItemPosition[]
# Readonly recyclable
• recyclable: boolean
是否可回收(回购)
Returns: boolean
# Optional Readonly recycleItemId
• recycleItemId? : number
回收(回购)对应的物品 ID
Returns: number
# Optional Readonly recyclePrice
• recyclePrice? : Long
回收(回购)价格
Returns: Long
# Readonly resPath
• resPath: string
物品资源文件路径
description 例如图标
deprecated Use resourcePath instead. Shall be removed in 0.4.
Returns: string
# Readonly resourcePath
• resourcePath: string
物品资源文件路径
description 例如图标
Returns: string
# Optional Readonly stackLimit
• stackLimit? : Long
物品堆叠上限
description 该物品在一个格子内最多放置的数目。
Returns: Long
# Readonly typeId
• typeId: number
物品 ID
description 对应一个物品(的种类)。由于同一个(种)物品可能在一个背包内占据多个位置，因此这个 ID 不唯一。
Returns: number
# Readonly usage
• usage: BackpackItemUsage
物品用法
description 除常规物品外，部分物品可以当作礼包打开。
Returns: BackpackItemUsage
# Optional Readonly usageLimitationId
• usageLimitationId? : number
物品使用限制 ID
description 可用于在限制系统中查找相关信息。
Returns: number
# Optional Readonly usageParam
• usageParam? : number
物品使用参数
Returns: number
# Methods
# getPositionInBackpack
▸ getPositionInBackpack(backpack: Backpack): number | undefined
获得当前物品在指定背包中的位置
description 若当前物品不在指定背包中，则返回 undefined。
# 参数:
| 属性 | 类型 |
|---|---|
backpack | Backpack |
Backpack
| 属性 | 类型 | 描述 |
|---|---|---|
items | Map‹number, BackpackItem› | 背包物品集合 |
description | Accessor | 背包描述信息 |
id | Accessor | 背包 ID |
initialCount | Accessor | 背包初始容量 |
maxCount | Accessor | 背包最大容量 |
name | Accessor | 背包名称 |
offItemCountChange | Method | 取消注册 (当前背包)物品数量更新 事件处理函数 |
offItemSwap | Method | 取消注册 (当前背包)物品交换 事件处理函数 |
offRefresh | Method | 取消注册 当前背包(全量)刷新 事件处理函数 |
onItemCountChange | Method | 注册 (当前背包)物品数量更新 事件处理函数 |
onItemSwap | Method | 注册 (当前背包)物品交换 事件处理函数 |
onRefresh | Method | 注册 当前背包(全量)刷新 事件处理函数 |
swap | Method | (背包内)两个格子的物品交换位置 |
# 返回值:
number | undefined
# 操作触发
# consume
▸ consume(params: ConsumeParams): Promise‹ConsumeRes›
物品消耗
# 参数:
| 属性 | 类型 |
|---|---|
params | ConsumeParams |
ConsumeParams
| 属性 | 类型 | 描述 |
|---|---|---|
count | Long | 要消耗的物品数量 |
complete? | Method | 操作完成时(成功或失败)，均会调用该回调函数 |
fail? | Method | 操作失败时，调用该回调函数 |
success? | Method | 操作成功时，调用该回调函数 |
# 返回值:
Promise‹ConsumeRes›
# recycle
▸ recycle(params: Omit‹RecycleBackpackItemParams, "itemId" | "itemUid"›): Promise‹RecycleBackpackItemRes›
物品回收(回购)
# 参数:
| 属性 | 类型 |
|---|---|
params | Omit‹RecycleBackpackItemParams, "itemId" | "itemUid"› |
# 返回值:
Promise‹RecycleBackpackItemRes›