开发者脚本帮助文档

# 容器管理接口 WorldContainer

在使用容器接口前需先创建容器管理对象，方法如下：(此处已废弃)

local WorldContainer = class.WorldContainer.new()

具体函数名及描述如下:

序号 函数名 函数描述
1 addFurnace(...) 新增熔炉
2 removeFurnace(...) 移除熔炉
3 checkFurnace(...) 检测是否是熔炉
4 getFurnaceHeatPercent(...) 获取熔炉热度百分比
5 getFurnaceMeltPercent(...) 获取熔炉融化百分比
6 addStorageBox(...) 新增储物箱
7 removeStorageBox(...) 移除储物箱
8 checkStorage(...) 检测是否是储物箱
9 clearStorageBox(...) 清空储物箱
10 checkStorageEmptyGrid(...) 检测储物箱空余格子，传入道具ID则同时检测已存该道具的格子
11 setStorageItem(...) 设置储物箱道具
12 getStorageItem(...) 获取储物箱道具ID
13 addStorageItem(...) 给储物箱添加道具
14 removeStorageItemByID(...) 移除储物箱内指定类型的道具
15 removeStorageItemByIndex(...) 移除储物箱内指定格子的道具
16 addItemToContainer(...) 将一定数量道具添加到储物箱中
17 removeContainerItemByID(...) 移除储物箱内一定数量道具
18 clearContainer(...) 清空指定位置的储物箱

# addFurnace

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 新增熔炉
  • 具体使用案例如下：
--在(0,0)高度7生成熔炉
--参数为要生成熔炉的位置的坐标
WorldContainer:addFurnace(0,7,0)
--在聊天框显示
Chat:sendSystemMsg("在(0,0)高度7的位置生成了一个熔炉！")

# removeFurnace

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 移除熔炉
  • 具体使用案例如下：
--移除(0,0)高度7的熔炉(或其他方块)
--参数为要移除的熔炉(或其他方块)的坐标
WorldContainer:removeFurnace(0,7,0)
--在聊天框显示
Chat:sendSystemMsg("(0,0)高度7的位置的熔炉(或其他方块)被移除！")

# checkFurnace

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 检测是否是熔炉
  • 具体使用案例如下：
--判断(0,0)高度7的位置是不是熔炉，参数为要判断的位置的坐标
local result=WorldContainer:checkFurnace(0,7,0)
if result==0 then--如果是熔炉
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置是熔炉")
else--如果不是熔炉
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置不是熔炉")
end

# getFurnaceHeatPercent

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取熔炉热度百分比
  • 具体使用案例如下：
--获取(0,0)高度7的位置的熔炉燃料热量剩余百分比，参数为熔炉坐标
local result,val=WorldContainer:getFurnaceHeatPercent(0,7,0)
if result==0 then--如果获取成功
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置的熔炉燃料热量剩余百分比为："..val)
else--如果获取失败
	--在聊天框显示
	Chat:sendSystemMsg("获取失败，可能(0,0)高度7的位置不是熔炉")
end

# getFurnaceMeltPercent

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取熔炉融化百分比
  • 具体使用案例如下：
--获取(0,0)高度7的位置的熔炉当前已烧制的百分比，参数为熔炉坐标
local result,val=WorldContainer:getFurnaceMeltPercent(0,7,0)
if result==0 then--如果获取成功
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置的熔炉当前已烧制的百分比为："..val)
else--如果获取失败
	--在聊天框显示
	Chat:sendSystemMsg("获取失败，可能(0,0)高度7的位置不是熔炉")
end

# addStorageBox

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 新增储物箱
  • 具体使用案例如下：
--在(0,0)高度7的位置生成一个储物箱，参数为要生成储物箱的坐标
WorldContainer:addStorageBox(0,7,0)
--在聊天框显示
Chat:sendSystemMsg("在(0,0)高度7的位置生成了一个储物箱！")

# removeStorageBox

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 移除储物箱
  • 具体使用案例如下：
--移除(0,0)高度7的箱子(或其他方块)
--参数为要移除的箱子(或其他方块)的坐标
WorldContainer:removeStorageBox(0,7,0)
--在聊天框显示
Chat:sendSystemMsg("(0,0)高度7的位置的箱子(或其他方块)被移除！")

# checkStorage

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 检测是否是储物箱
  • 具体使用案例如下：
--判断(0,0)高度7的位置是不是箱子，参数为要判断的位置的坐标
local result=WorldContainer:checkStorage(0,7,0)
if result==0 then--如果是箱子
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置是箱子")
else--如果不是箱子
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置不是箱子")
end

# clearStorageBox

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 清空储物箱
  • 具体使用案例如下：
--清空指定坐标下箱子的物品，参数为要清空的箱子的坐标
WorldContainer:clearStorageBox(0,7,0)
--在聊天框显示
Chat:sendSystemMsg("清空了(0,0)高度7的箱子的物品")

# checkStorageEmptyGrid

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 检测储物箱空余格子，传入道具ID则同时检测已存该道具的格子
  • 具体使用案例如下：
--判断(0,0)高度7的位置的储物箱有没有空余格子或指定物品
--前三个参数为要判断的箱子的坐标
--最后一个参数为要判断的物品id，0代表空余格子
local result=checkStorageEmptyGrid(0,7,0,0)
if result==0 then--如果有
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置的储物箱还有空余格子")
else--如果没有
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置的储物箱没有空余格子")
end
--判断有没有基岩，id为1
result=checkStorageEmptyGrid(0,7,0,1)
if result==0 then--如果有
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置的储物箱里有地心基石")
else--如果没有
	--在聊天框显示
	Chat:sendSystemMsg("(0,0)高度7的位置的储物箱没有地心基石")
end

# setStorageItem

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 设置储物箱道具
  • 具体使用案例如下：
--设置指定位置的箱子的指定格子的物品
--前三个参数为要设置的箱子的坐标
--第四个参数0为指定格子的序号，0为第一个格子
--第五个参数为要放置的物品id，101为土块
--最后一个参数为要放置的物品数量
WorldContainer:setStorageItem(0,7,0,0,101,30)
--在聊天框显示
Chat:sendSystemMsg("(0,0)高度7的位置的箱子第一格，被放置了30个土块")

# getStorageItem

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 获取储物箱道具ID
  • 具体使用案例如下：
--获取指定坐标下的箱子指定格子的物品id和数量
--前三个参数为箱子坐标
--最后一个参数为格子序号，0为第一格
local result,itemid,itemNum=WorldContainer:getStorageItem(0,7,0,0)
--在聊天框显示
Chat:sendSystemMsg("(0,0)高度7的位置的箱子的第一个格子，有"..itemNum.."个id为"..itemid.."的物品")

# addStorageItem

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 给储物箱添加道具
  • 具体使用案例如下：
--在指定坐标的箱子里添加指定物品
--前三个参数为箱子坐标
--第四个参数为要添加的物品的id，101为土块
--最后一个参数为要添加的数量
local result,relNum=WorldContainer:addStorageItem(0,7,0,101,99)
--在聊天框显示
Chat:sendSystemMsg("尝试在(0,0)高度7位置的箱子里添加99个土块，实际添加了"..relNum.."个")

# removeStorageItemByID

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 移除储物箱内指定类型的道具
  • 具体使用案例如下：
--移除指定坐标下箱子的指定物品
--前三个参数为箱子坐标
--第四个参数为要移除的物品id，101是土块
--最后一个参数为要移除的数量
WorldContainer:removeStorageItemByID(0,7,0,101,10)
--在聊天框显示
Chat:sendSystemMsg("移除了(0,0)高度7位置的箱子里的10个土块")

# removeStorageItemByIndex

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 移除储物箱内指定格子的道具
  • 具体使用案例如下：
--移除指定坐标下箱子的指定格子的物品
--前三个参数为箱子坐标
--第四个参数为要移除的格子序号，0是第一格
--最后一个参数为要移除的数量
WorldContainer:removeStorageItemByIndex(0,7,0,0,5)
--在聊天框显示
Chat:sendSystemMsg("把(0,0)高度7的位置的箱子里第一格的物品移除了5个")

# addItemToContainer

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 将一定数量道具添加到储物箱中
  • 具体使用案例如下：
--在指定坐标的箱子里添加指定物品
--前三个参数为箱子坐标
--第四个参数为要添加的物品的id，101为土块
--最后一个参数为要添加的数量
local result,relNum=WorldContainer:addItemToContainer(0,7,0,101,99)
--在聊天框显示
Chat:sendSystemMsg("尝试在(0,0)高度7位置的箱子里添加99个土块，实际添加了"..relNum.."个")

# removeContainerItemByID

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 移除储物箱内一定数量道具
  • 具体使用案例如下：
--移除指定坐标下箱子的指定物品
--前三个参数为箱子坐标
--第四个参数为要移除的物品id，101是土块
--最后一个参数为要移除的数量
WorldContainer:removeContainerItemByID(0,7,0,101,10)
--在聊天框显示
Chat:sendSystemMsg("移除了(0,0)高度7位置的箱子里的10个土块")

# clearContainer

  • 参数及类型：
  • 返回值及类型：
  • 该方法的主要作用： 清空指定位置的储物箱
  • 具体使用案例如下：
--清空指定坐标下箱子的物品，参数为要清空的箱子的坐标
WorldContainer:clearContainer(0,7,0)
--在聊天框显示
Chat:sendSystemMsg("清空了(0,0)高度7的箱子的物品")
上次更新: 2023/5/9 20:12:50

← 小地图管理接口 MapMark →