迷你世界UGc3.0脚本Wiki[容器模块管理接口]

Skip to content迷你世界UGC3.0脚本WikiMenuOn this pageSidebar Navigation快速入门欢迎MOD、组件介绍什么是Lua编程组件介绍组件说明组件互相操作组件函数组件属性事件触发器事件管理组件事件管理函数库服务模块对象模块管理接口 GameObject角色模块管理接口 Actor玩家模块管理接口 Player生物模块管理接口 Monster方块模块管理接口 Block背包模块管理接口 Backpack界面模块管理接口 CustomUI图文信息模块管理接口 Graphics区域模块管理接口 Area容器模块管理接口 WorldContainer资源模块管理接口 Mod计时器模块管理接口 Timer状态模块管理接口 Buff消息模块管理接口 Chat普通变量数据管理接口 Data数组变量数据管理接口 Array二维表变量数据管理接口 TableKV表变量数据管理接口 Map世界模块管理接口 World道具模块管理接口 Item全局函数全局函数枚举枚举库脚本常见问题开发者常见问题进阶指南全局函数触发器脚本交互对象介绍KV排行榜介绍二维表介绍道具实例更新日志更新日志容器模块管理接口WorldContainer​具体函数名及描述如下:序号函数名函数描述1CheckStorage(...)检测储物箱2ClearStorageBox(...)清空储物箱3CheckStorageEmptyGrid(...)检测储物箱空位4SetStorageItem(...)设置储物箱格子道具5GetStorageItem(...)获取储物箱格子道具6AddStorageItem(...)储物箱添加道具7RemoveStorageItemByID(...)储物箱按类型移除道具8RemoveStorageItemByIndex(...)储物箱按格子移除道具9AddItemToContainer(...)储物箱添加道具(大箱)10RemoveContainerItemByID(...)移除储物箱中一定数量道具11ClearContainer(...)清空容器12AddWorldStorageItems(...)批量添加储物箱道具13GetStorageItemInstanceId(...)获取储物箱道具实例ID14GetAllStorageItemInstanceIds(...)获取储物箱全部道具实例ID15SwapContainerItem(...)交换容器与背包道具16GetGridAttr(...)获取格子属性CheckStorage​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zworldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型 ret:boolean,resIdOrBlockId:number|nil:是否为储物箱及方块标识否仅返回false该方法的其他说明 检测指定坐标是否为储物箱或 MOD 容器是则返回方块资源ID或配置ID具体使用案例如下lualocal isStorage WorldContainer:CheckStorage(x, y, z, WorldId)ClearStorageBox​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zworldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:boolean 是否清空成功该方法的其他说明 清空指定坐标储物箱内所有物品具体使用案例如下lualocal success WorldContainer:ClearStorageBox(x, y, z, WorldId)CheckStorageEmptyGrid​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zitemid:number / string 道具类型ID或资源IDworldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:boolean 是否有可用格子该方法的其他说明 检测储物箱是否还有空位或可叠加存放指定道具具体使用案例如下lualocal isEmpty WorldContainer:CheckStorageEmptyGrid(x, y, z, 100, WorldId)SetStorageItem​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zoffset:number 格子索引(从1开始)itemid:number / string 道具类型ID或资源IDnum:number 数量worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:boolean 是否设置成功该方法的其他说明 按格子索引直接设置储物箱内道具与数量具体使用案例如下lualocal success WorldContainer:SetStorageItem(x, y, z, 3, 12500, 10, WorldId)GetStorageItem​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zoffset:number 格子索引(从1开始)worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型 ret:itemid:number|string|nil,num:number|nil:道具ID与数量失败返回nil该方法的其他说明 读取储物箱指定格子的道具ID与数量具体使用案例如下lualocal itemId, num WorldContainer:GetStorageItem(x, y, z, 1, WorldId)AddStorageItem​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zitemid:number / string 道具类型ID或资源IDnum:number 数量worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:number / boolean / nil 实际添加数量锁定商品返回false失败返回nil该方法的其他说明 向储物箱按堆叠规则添加道具返回实际加入的数量具体使用案例如下lualocal addNum WorldContainer:AddStorageItem(x, y, z, 12507, 10, WorldId)RemoveStorageItemByID​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zitemid:number / string 道具类型ID或资源IDnum:number / nil 移除数量worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:boolean 是否执行成功该方法的其他说明 从储物箱中按道具类型移除指定数量num 缺省或极大时表示尽量清空该类型具体使用案例如下lualocal isSuccess WorldContainer:RemoveStorageItemByID(x, y, z, 12507, 3, WorldId)RemoveStorageItemByIndex​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zoffset:number 格子索引(从1开始)num:number / nil 移除数量worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:boolean 是否移除成功该方法的其他说明 从储物箱指定格子移除一定数量道具具体使用案例如下lualocal isSuccess WorldContainer:RemoveStorageItemByIndex(x, y, z, 1, 5, WorldId)AddItemToContainer​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zitemid:number / string 道具类型ID或资源IDnum:number 数量worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:number / boolean 实际添加数量失败返回false该方法的其他说明 向储物箱添加道具成功返回本次实际加入数量具体使用案例如下lualocal addNum WorldContainer:AddItemToContainer(x, y, z, 12500, 10, WorldId)RemoveContainerItemByID​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zitemid:number / string 道具类型ID或资源IDnum:number 数量worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:boolean 是否移除成功该方法的其他说明 移除储物箱中一定数量道具具体使用案例如下lualocal isSuccess WorldContainer:RemoveContainerItemByID(x, y, z, 12500, 5, WorldId)ClearContainer​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zworldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:boolean 是否清空成功该方法的其他说明 清空指定坐标上通用容器内所有物品具体使用案例如下lualocal success WorldContainer:ClearContainer(x, y, z, WorldId)AddWorldStorageItems​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zitemids:table 道具列表({itemId,itemNum}...)worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:number 累计成功添加数量该方法的其他说明 批量向储物箱添加多组道具每项含 itemId、itemNum返回累计成功添加的总数量具体使用案例如下lualocal addNum WorldContainer:AddWorldStorageItems(x, y, z, {{itemId 12541, itemNum 10}}, WorldId)GetStorageItemInstanceId​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zoffset:number 格子索引(从1开始)worldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:string / nil 实例ID无则返回nil该方法的其他说明 读取储物箱某格道具的实例ID字符串仅当格子含实例数据时有效具体使用案例如下lualocal ret WorldContainer:GetStorageItemInstanceId(x, y, z, offset, worldId)GetAllStorageItemInstanceIds​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zworldId:number / nil 星球ID(默认当前主机所在星球)返回值及类型ret:table / nil 实例ID字符串数组失败返回nil该方法的其他说明 枚举储物箱内所有带实例ID的格子收集实例ID列表仅含通过接口创建的实例道具具体使用案例如下lualocal ret WorldContainer:GetAllStorageItemInstanceIds(x, y, z, worldId)SwapContainerItem​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zgrid:number 容器格子索引(从1开始熔炉为约定槽位)uin:number 玩家objidgrid2:number 背包格子索引(从1开始)返回值及类型ret:boolean / nil 是否成功坐标无方块等可能返回nil该方法的其他说明 在玩家背包与指定坐标的储物箱或熔炉之间移动或交换道具具体使用案例如下lualocal ret WorldContainer:SwapContainerItem(x, y, z, 1,uin, BackpackBeginIndex.Shortcut)GetGridAttr​参数及类型x:number 坐标xy:number 坐标yz:number 坐标zgridid:number:格子ID,attr:number:属性枚举(GridAttr)worldId:number 星球id(默认当前主机所在星球)返回值及类型ret:number 属性值该方法的其他说明 获取格子属性具体使用案例如下lualocal num WorldContainer:GetGridAttr(x, y, z, 1, GridAttr.ItemNum)Last updated: 2026/4/22 17:50PagerPrevious page区域模块管理接口 AreaNext page资源模块管理接口 Mod