迷你世界UGC3.0脚本Wiki

Appearance

容器模块管理接口 WorldContainer ​

具体函数名及描述如下:

序号函数名函数描述
1CheckStorage(...)检测是否是储物箱
2ClearStorageBox(...)清空储物箱
3CheckStorageEmptyGrid(...)检测储物箱空余格子，传入道具ID同时检测已存该道具的格子
4SetStorageItem(...)设置储物箱道具
5GetStorageItem(...)获取储物箱道具ID
6AddStorageItem(...)给储物箱添加道具
7RemoveStorageItemByID(...)移除储物箱内指定类型的道具
8RemoveStorageItemByIndex(...)移除储物箱内指定格子的道具
9AddItemToContainer(...)将一定数量道具添加到储物箱中
10RemoveContainerItemByID(...)移除储物箱中一定数量道具
11ClearContainer(...)清空指定位置的储物箱
12AddWorldStorageItems(...)给当前世界的储物箱添加道具

CheckStorage ​

  • 参数及类型：
  • 返回值及类型：
    • ret:bool成功(true)
  • 该方法的主要作用： 检测是否是储物箱
  • 具体使用案例如下：
lua
    local isStorage = WorldContainer:CheckStorage(x, y, z)

ClearStorageBox ​

  • 参数及类型：
  • 返回值及类型：
    • ret:bool成功(true)
  • 该方法的主要作用： 清空储物箱
  • 具体使用案例如下：
lua
    local success = WorldContainer:ClearStorageBox(x, y, z)

CheckStorageEmptyGrid ​

  • 参数及类型：
    • x,y,z:number位置
    • itemid:number,string道具类型ID
  • 返回值及类型：
    • ret:bool成功(true)
  • 该方法的主要作用： 检测储物箱空余格子，传入道具ID同时检测已存该道具的格子
  • 具体使用案例如下：
lua
    local isEmpty = WorldContainer:CheckStorageEmptyGrid(x, y, z, 100)

SetStorageItem ​

  • 参数及类型：
    • x,y,z:number位置
    • offset:number仓库格子索引(从1开始)
    • itemid:number,string道具类型ID
    • num:number道具数量
  • 返回值及类型：
    • ret:bool成功(true)
  • 该方法的主要作用： 设置储物箱道具
  • 具体使用案例如下：
lua
    local success = WorldContainer:SetStorageItem(x, y, z, 3, 12500, 10)

GetStorageItem ​

  • 参数及类型：
    • x,y,z:number位置
    • offset:number仓库格子索引
    • (从1开始)
  • 返回值及类型：
    • itemid:number,string道具类型ID
    • num:number道具数量
  • 该方法的主要作用： 获取储物箱道具ID
  • 具体使用案例如下：
lua
    local itemId, num = WorldContainer:GetStorageItem(x, y, z, 1)

AddStorageItem ​

  • 参数及类型：
    • x,y,z:number位置
    • itemid:number,string道具类型ID
    • num:number道具数量
  • 返回值及类型：
    • relNum:number成功添加数量
  • 该方法的主要作用： 给储物箱添加道具
  • 具体使用案例如下：
lua
    local addNum = WorldContainer:AddStorageItem(x, y, z, 12507, 10)

RemoveStorageItemByID ​

  • 参数及类型：
    • x,y,z:number位置
    • itemid:number,string道具类型ID
    • num:number道具数量
  • 返回值及类型：
    • ret:bool成功(true)
  • 该方法的主要作用： 移除储物箱内指定类型的道具
  • 具体使用案例如下：
lua
    local isSuccess = WorldContainer:RemoveStorageItemByID(x, y, z, 12507, 3)

RemoveStorageItemByIndex ​

  • 参数及类型：
  • 返回值及类型：
    • ret:bool成功(true)
  • 该方法的主要作用： 移除储物箱内指定格子的道具
  • 具体使用案例如下：
lua
    local isSuccess = WorldContainer:RemoveStorageItemByIndex(x, y, z, 1, 5)

AddItemToContainer ​

  • 参数及类型：
    • x,y,z:number位置
    • itemid:number,string道具类型ID
    • num:number道具数量
  • 返回值及类型：
    • relNum:number成功添加数量
  • 该方法的主要作用： 将一定数量道具添加到储物箱中
  • 具体使用案例如下：
lua
    local addNum = WorldContainer:AddItemToContainer(x, y, z, 12500, 10)

RemoveContainerItemByID ​

  • 参数及类型：
    • x,y,z:number位置
    • itemid:number,string道具类型ID
    • num:number道具数量
  • 返回值及类型：
    • ret:bool成功(true)
  • 该方法的主要作用： 移除储物箱中一定数量道具
  • 具体使用案例如下：
lua
    local isSuccess = WorldContainer:RemoveContainerItemByID(x, y, z, 12500, 5)

ClearContainer ​

  • 参数及类型：
  • 返回值及类型：
    • ret:bool成功(true)
  • 该方法的主要作用： 清空指定位置的储物箱
  • 具体使用案例如下：
lua
    local success = WorldContainer:ClearContainer(x, y, z)

AddWorldStorageItems ​

  • 参数及类型：
    • x,y,z:number位置
    • itemids:table道具数组(成员需含有itemId
    • itemNum)
  • 返回值及类型：
    • relNum:number成功添加数量
  • 该方法的主要作用： 给当前世界的储物箱添加道具
  • 具体使用案例如下：
lua
    local addNum = WorldContainer:AddWorldStorageItems(x, y, z, {{itemId = 12541, itemNum = 10}})