1111
This commit is contained in:
97
Object/Inven/Inven.md
Normal file
97
Object/Inven/Inven.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# Inven 类函数文档
|
||||
|
||||
**类说明**:
|
||||
`Inven`类用于表示游戏中的背包对象,提供了各种与背包操作相关的方法。
|
||||
|
||||
## 一、静态变量
|
||||
### INVENTORY_TYPE_BODY
|
||||
- 值为 0,表示身上穿的装备(0 - 26)。
|
||||
### INVENTORY_TYPE_ITEM
|
||||
- 值为 1,表示物品栏(0 - 311)。
|
||||
### INVENTORY_TYPE_AVARTAR
|
||||
- 值为 2,表示时装栏(0 - 104)。
|
||||
### INVENTORY_TYPE_CREATURE
|
||||
- 值为 3,表示宠物装备(0 - 241)。
|
||||
|
||||
---
|
||||
|
||||
## 三、GetSlot 函数
|
||||
### 函数签名
|
||||
- `function GetSlot(Type, Slot)`
|
||||
### 参数
|
||||
- `Type`:整数,表示背包类型。
|
||||
- `Slot`:整数,表示背包槽位。
|
||||
### 返回值
|
||||
- `Item`对象或`null`,表示对应槽位的道具对象,如果槽位为空则返回`null`。
|
||||
### 说明
|
||||
根据指定的背包类型和槽位获取背包中的道具对象。
|
||||
|
||||
---
|
||||
|
||||
## 四、GetSlotById 函数
|
||||
### 函数签名
|
||||
- `function GetSlotById(Idx)`
|
||||
### 参数
|
||||
- `Idx`:整数,表示道具的 ID。
|
||||
### 返回值
|
||||
- 整数,表示对应道具在背包中的槽位,如果未找到则返回 -1。
|
||||
### 说明
|
||||
通过道具的 ID 获取其在背包中的槽位。
|
||||
|
||||
---
|
||||
|
||||
## 五、GetMoney 函数
|
||||
### 函数签名
|
||||
- `function GetMoney()`
|
||||
### 返回值
|
||||
- 整数,表示背包中的金币数量。
|
||||
### 说明
|
||||
获取背包中的金币数量。
|
||||
|
||||
---
|
||||
|
||||
## 六、CheckItemCount 函数
|
||||
### 函数签名
|
||||
- `function CheckItemCount(ItemId, ItemCount)`
|
||||
### 参数
|
||||
- `ItemId`:整数,表示道具的 ID。
|
||||
- `ItemCount`:整数,表示要检查的道具数量。
|
||||
### 返回值
|
||||
- 布尔值,如果背包中拥有指定数量的指定道具则返回`true`,否则返回`false`。
|
||||
### 说明
|
||||
检查背包中是否拥有指定数量的指定道具,包括点券、代币券和金币的特殊处理。
|
||||
|
||||
---
|
||||
|
||||
## 七、CheckArrItemCount 函数
|
||||
### 函数签名
|
||||
- `function CheckArrItemCount(T)`
|
||||
### 参数
|
||||
- `T`:包含道具 ID 和数量的对象数组。
|
||||
### 返回值
|
||||
- 布尔值,如果背包中拥有指定表中的所有道具及数量则返回`true`,否则返回`false`。
|
||||
### 说明
|
||||
检查背包中是否拥有指定表中的所有道具及对应的数量。
|
||||
|
||||
---
|
||||
|
||||
## 八、DeleteArrItemCount 函数
|
||||
### 函数签名
|
||||
- `function DeleteArrItemCount(T)`
|
||||
### 参数
|
||||
- `T`:包含道具 ID 和数量的对象数组。
|
||||
### 说明
|
||||
销毁背包中指定表中的所有道具及对应的数量,并更新背包信息。
|
||||
|
||||
---
|
||||
|
||||
## 九、DeleteItemCount 函数
|
||||
### 函数签名
|
||||
- `function DeleteItemCount(Id, Count)`
|
||||
### 参数
|
||||
- `Id`:整数,表示道具的 ID。
|
||||
- `Count`:整数,表示要销毁的道具数量。
|
||||
### 返回值
|
||||
- 布尔值,如果成功销毁指定数量的道具则返回`true`,否则返回`false`。
|
||||
### 说明
|
||||
销毁背包中指定数量的指定道具,并更新背包信息,包括对点券、代币券和金币的特殊处理。
|
||||
Reference in New Issue
Block a user