索引
| 接口 | 端 | 描述 |
|---|---|---|
| BindPlayerOnHandItemFunction | 服务端 | 绑定玩家手持某物品的事件函数，首次需要切换物品后才会触发 |
| CreateLootItem | 服务端 | 生成掉落物 |
| ExchangePlayerInv | 服务端 | 交换玩家背包物品位置 |
| GetPlayerSelectInv | 服务端 | 获取玩家当前所选择的槽位 |
| GetItemDictByInv | 双端 | 根据背包类型、槽位来获取物品数据信息 |
| GetAllLoadItems | 服务端 | 获取已经加载的物品id |
| SetPlayerSelectItem | 服务端 | 设置玩家选中的物品槽位 |
| ClearPlayerOnHandItem | 服务端 | 清除玩家主手物品 |
| GetAllItemDict | 双端 | 获取类型所有物品数据 |
| SetItemLayer | 服务端 | 设置物品层级贴图 |
| SetPlayerItemByInvPos | 服务端 | 根据背包槽位设置玩家物品 |
| RemovePlayerItemByInvPos | 服务端 | 根据背包槽位删除玩家物品 |
BindPlayerOnHandItemFunction
服务端
-
描述
绑定玩家手持某物品的事件函数，首次需要切换物品后才会触发 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| ItemName | str | 物品名称，例如'minecraft:stick' |
| FunctionInstance | function | 函数(一个dict参数)，例如self.CreateMsg，不要填写成self.CreateMsg()样式 |
| ButtonText | str | 按钮文字，默认为''，用按钮点击方式来触发绑定的函数 |
| IsAdd | bool | 是否是添加绑定，默认为True，则为添加类型反之为删除 |
-
返回值
无 -
备注
- 所绑定的函数接收的一个dict参数如下
Key 数据类型 说明 PlayerId str 玩家id ItemName str 物品名称，例如'minecraft:stick' -
示例 无
CreateLootItem
服务端
-
描述
生成掉落物 -
参数
-
返回值
掉落物实体Id (str) -
备注
无 -
示例 无
ExchangePlayerInv
服务端
-
描述
交换玩家背包物品位置 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| FirstInv | int | 一号物品槽位 |
| SecondInv | int | 二号物品槽位 |
-
返回值
无 -
备注
无 -
示例 空
GetPlayerSelectInv
服务端
-
描述
获取玩家当前所选择的槽位 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
-
返回值
槽位 (int) -
备注
无 -
示例 空
GetItemDictByInv
双端
-
描述
根据背包类型、槽位来获取物品数据信息 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| Type | int | 背包类型0:物品栏及背包, 1:副手, 2:主手, 3:盔甲栏 |
| TypeInv | int | 对应类型的槽位 |
- 客户端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| Type | int | 背包类型0:物品栏及背包, 1:副手, 2:主手, 3:盔甲栏 |
| TypeInv | int | 对应类型的槽位 |
-
返回值
物品数据信息 (dict) -
备注
- 物品信息字典
- 网易SetItemTierLevel和SetItemTierSpeed接口无法利用该物品数据信息返回值，因为网易对这两个接口所使用的物品数据信息做出了差异化，待灵免以太接口更新！
-
示例 空
GetAllLoadItems
服务端
-
描述
获取已经加载的物品id -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| Flag | bool | True获取所有物品，False仅获取注册到创造栏的物品，默认为True |
-
返回值
已经加载的物品id列表 (list) -
备注
无 -
示例 空
SetPlayerSelectItem
服务端
-
描述
设置玩家选中的物品槽位 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| NewInv | str | 新的槽位 |
-
返回值
是否成功 (bool) -
备注
无 -
示例 空
ClearPlayerOnHandItem
服务端
-
描述
清除玩家主手物品 -
参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
-
返回值
是否成功 (bool) -
备注
无 -
示例 空
GetAllItemDict
双端
-
描述
获取类型所有物品数据 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| Type | int | 背包类型0:物品栏及背包, 1:副手, 2:主手, 3:盔甲栏 |
- 客户端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| Type | int | 背包类型0:物品栏及背包, 1:副手, 2:主手, 3:盔甲栏 |
-
返回值
物品信息列表 dictlist (list) -
备注
物品信息字典 -
示例 空
SetItemLayer
服务端
-
描述
设置物品层级贴图，仍需要手动将物品数据生成给玩家，因此使用该接口前需要清除传入的ItemDict物品 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| ItemDict | dict | 物品数据信息 |
| Level | int | 层级：可选-2，-1，1，2，3 |
| TextureKey | str | 贴图Key，需要在item_texture.json中注册 |
| ExtraData | dict | 需要给物品携带的数据信息，根据Key进行部分覆盖，默认为None |
-
返回值
带有自定义物品数据的物品数据信息 (dict) -
备注
- 物品信息字典
- SetItemLayer返回的ItemDict中会自动给物品添加存储信息extraId，key为Level，Value为TextureKey
-
示例 空
SetPlayerItemByInvPos
服务端
-
描述
根据背包槽位设置玩家物品，会覆盖原有位置物品 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| InvType | int | 背包类型(0:背包物品栏, 1:副手, 2:主手, 3:盔甲栏) |
| InvPos | int | 槽位坐标 |
| ItemDict | dict | 物品数据信息 |
-
返回值
无 -
备注
-
示例 空
RemovePlayerItemByInvPos
服务端
-
描述
根据背包槽位删除玩家物品 -
服务端参数
| 参数名 | 数据类型 | 说明 |
|---|---|---|
| PlayerId | str | 玩家id |
| InvType | int | 背包类型(0:背包物品栏, 1:副手, 2:主手, 3:盔甲栏) |
| InvPos | int | 槽位坐标 |
-
返回值
无 -
备注
-
示例 空
