Robot(机器人) API

此API封装了机器人组件的功能，允许与机器人实现更直观的互动。

使用如下方式在你的 Lua 代码中调用这个 API：

snippet.lua

local robot_api = require("robot")
robot_api.forward()

不推荐直接访问机器人组件API，虽然可以通过组件接口这么做：

snippet.lua

local component = require("component")
local robot_component_api = component.robot -- 如果你使用 OpenOS 可以这么写，否则要写 component.proxy(component.list("robot")())
robot_component_api.move(sides.front)

尽管机器人组件提供了更通用的功能，比如说 move([side: number]) 或者 drop([side: number])，但这个API能提供更直观、更安全的功能，比如说 turnRight, dropDown, forward。使用哪一种由你自己决定，甚至可以混用二者。

请注意机器人本身就是一台开放式电脑，和其它电脑一样，只是多了一个机器人组件，所以一般的API仍然可用。

查看方块：机器人以获取更多有关机器人本身的信息。

机器人能够灵活移动，但你应该了解一点细节。

机器人有飞行高度限制。机器人移动的基本规则是这样的：

• 1. 机器人只有在起点和目标点均可用时才会移动（例如用于建桥）。
• 2. 机器人下方一定可用（一定可以向下移动）。
• 3. 固体方块上至多flightHeight格是可用的（飞行能力有限，默认为8）
• 4. 任何紧贴着实心面的位置都是可用的（机器人可以“爬墙”）。
  此处为一张可视化展示上述规则的图片（忽略了第二条规则，这会使图片变得混乱）

违反这些规则会导致机器人返回impossible move错误。

你可以安装悬浮升级以提升（1级）乃至很大程度上规避（2级）这个限制。或者你也可以在模组配置文件中禁用这个限制，只要将limitFlightHeight设置为256或更高即可。

来源（英文）

• robot.name(): string
  返回机器人的名字。 机器人的名字在它被创造时会自动赋予，并且不能通过程序修改。但如果你想，可以用铁砧修改。
  
  
• robot.detect(): boolean, string
  探测机器人正前方的物体并且返回机器人是否能移动过去，同时返回面前物体的描述。
  返回值：若机器人面前的物体会阻碍其移动（方块或者实体）则返回 true，否则返回 false（注意：即使面前的方块为passable，代表可穿越，无人机也会返回true）。第二个返回值大体描述前面的物体是什么，可能取值为；entity、solid、replaceable、liquid、passable或者air。
  
  
• robot.detectUp(): boolean, string
  和robot.detect()一样，但此函数探测机器人正上方的物体。
  
  
• robot.detectDown(): boolean, string
  和robot.detect()一样，但此函数探测机器人正下方的物体。
  
  
• robot.select([slot: number]): number
  选择给定的物品栏格子（如果指定了）并且返回当前的物品栏格子。
  slot - 要选择的物品栏格子。如果这个参数省略，那么不会新选择任何格子。
  返回 当前的物品栏格子。返回给定的物品栏格子（如果选择成功）或者先前选择的物品栏格子。
• robot.inventorySize(): number
  返回 可以选择的物品栏格子的数量。如果想要知道安装的物品栏升级个数，使用这个公式：x = robot.inventorySize() / 16。
• robot.count([slot: number]): number
  返回当前选定的物品栏格子里物品的个数或者指定格子里面物品栏的个数。
  slot - 指定格子来获取里面物品的个数。如果省略这个参数就会对当前选定的格子里的物品计数。
  返回 指定格子里面物品的数量，或者当前格子里面物品的数量（如果没有指定格子）
• robot.space([slot: number]):number
  返回仍然能叠加到指定格子里面的物品的个数。
  slot - 指定格子来计算还能叠加多少物品。如果省略就计算当前格子。
  返回 仍然能叠加到指定格子或者当前格子的物品数量。
  这个函数帮助决定多少同种物品能叠加到一个格子上。例如对于圆石每个格子能放 64 个，但是空桶每个格子只能放 16 个，而有些方块，比如门^原文如此，每个格子只能放一个。
• robot.transferTo(slot: number[, count: number]): boolean
  从当前格子移动所有的或者是最多 count 数量的物品到指定的格子。
  slot - 指定要把物品移动到的格子。
  count - 如果指定这个参数，那么最多有这些数量的物品会被移动，不指定则会移动全部物品。
  返回 true，如果交换两个格子的物品成功了，否则返回 false。
  如果指定的格子里面有物品，这个函数就会尝试交换两个格子的物品。只有当你将当前格子的所有物品都移动过去或者当前格子是空的时才会成功。
  请注意如果两个格子里的物品相同或者两个格子都是空的，返回值总会是真，即使事实上没有移动任何东西。
• robot.compareTo(slot: number):boolean
  比较机器人面前的方块与当前选择的物品栏格子中的方块是否相同。
  如果方块的种类和元数据（meatdata）相同，那么它们就被认定为相同。栈（stack）大小或者其它附加信息（例如容器的物品栏）不会被比较。 请注意机器人前方如果是空的则会被游戏认为是“空气方块”，不能被放进物品栏，因此也不能进行一般意义上的比较。物品栏的空格子和空气方块是不相同的。你可以先使用 robot.detect() 来确认机器人面前是否真的有方块。
  同样请记住会掉落其它物品的方块应当和真正摆放在世界上的方块比较。举个例子，石头方块掉落圆石，钻石矿石掉落钻石，对于这个函数来说它们并不相同。使用精准采集的工具开采实际的方块用于作比较。
• robot.compareUp(): boolean
  和 robot.compare() 一样，只是这个比较机器人头顶的方块。
• robot.compareDown(): boolean
  和 robot.compare() 一样，只是这个比较机器人脚踩的方块。
• robot.drop([count: number]): boolean
  尝试将当前所选的物品栏中的物品丢在面前。注意，如果你尝试将物品丢进脚下的容器里面，这是错误的方法。使用 dropDown 来做这个。这个方法， drop ，会将东西丢在面前。
  count - 指定丢多少物品。如果省略这个参数或者它的值超过了物品的数量，所有物品都会被丢出去。
  返回 true，如果有至少一个物品被丢出去，反之返回 false。
  如果机器人面前的实体或方块有物品栏（例如箱子或者运输矿车），机器人会尝试将物品放进物品栏中而不是丢在世界上。如果面前的方块的确有物品栏但是要丢出去的物品因为某种原因没法放进去，那么这个函数返回假并且不会移动任何物品。物品被放置的位置取决于物品栏和机器人面对方块的方向。举例来说，熔炉会冶炼上方放进来的物品。同样请注意其它机器人也会被认为成“带有物品栏的方块”，所以物品也能被移入其它机器人的物品栏格子，就像移入别的物品栏一样。
  这个函数不能和不储存物品的物品栏互动（比如说液体储罐），也不会认为它们带有物品栏，所以物品会被扔到世界上。你需要使用 robot.use 函数来和这些方块互动。
  请注意如果当前选定的物品栏格子是空的，那么返回值总会是假。
• robot.dropUp(): boolean
  和 robot.drop() 一样，只是这个把物品丢在机器人头顶。
• robot.dropDown(): boolean
  和 robot.drop() 一样，只是这个把物品丢在机器人脚底。
• robot.suck([count: number]): boolean
  尝试从面前捡起掉落物并把它放入指定的物品栏格子或者（如果省略这个参数）第一个可能的物品栏格子。
  count - 限制最多捡起掉落物的数量。如果省略，将会捡起一个格子能装下的最多物品。
  返回 true，如果捡起了至少一个物品，否则返回 false。
  这基本就是 robot.drop 的反向，而且也会以相同的方式和物品栏互动。但是它只会拿走物品栏中第一个可用的物品。想要更精确的物品栏管理，你需要为机器人安装 物品栏控制器升级。
  如果机器人面前有多个掉落物，它会根据距离捡起掉落物。这会跳过因为某些原因无法捡起的掉落物并且在返回 false 之前尝试捡起其它掉落物。 如果当前选择的物品栏格子包含和机器人捡起的掉落物不同的物品，机器人会尝试将物品放在这个格子之后第一个可用的格子，要么是空的，要么是包含相同物品并且在放入机器人捡起的物品后小于等于最大堆叠上限的。如果必要，它会将物品分割到不同的格子中。如果在选定的格子之后没有可用的格子，这个函数就会失败，即使在选定的格子之前有能装下这些物品的格子。
• robot.suckUp([count: number]): boolean
  和 robot.suck() 一样，只是这个尝试捡起头顶的物品。
• robot.suckDown([count: number]): boolean
  和 robot.suck() 一样，只是这个尝试捡起脚踩的物品。
• robot.place([side: number[, sneaky: boolean]]): boolean[, string]
  尝试将当前选定的物品栏里面的方块放置在机器人面前。
  side - 这个参数会决定机器人尝试将方块放在哪个面上，举例来说，将火把放在特定的面上。如果省略，机器人会尝试所有可能的面。参见 方向控制（sides） API 来获得可能的面的列表。
  sneaky - 如果设置为 true，机器人会模拟潜行时放置方块（如同一个按住 Shift 放置方块的玩家），这一般不是必要的，只是为了保持和其它模组的兼容性。
  返回值：如果一个物品可以被放置返回 true，否则返回 false。如果放置失败，第二个返回值会描述为什么放置失败。
  一个机器人只能在紧邻着其它固体方块的地方放置方块，它们不能将方块“放在空中”，除非有 天使方块升级。这可以在配置文件中修改。
  请注意，如果物品栏格子是空的，放置方块总是会失败。
• robot.placeUp([side: number[, sneaky: boolean]]): boolean[, string]
  和 robot.place() 一样，只是这个尝试在头顶放置方块。
• robot.placeDown([side: number[, sneaky: boolean]]): boolean[, string]
  和 robot.place() 一样，只是这个尝试在脚底放置方块。
• robot.durability(): number, number, number or nil, string
  返回当前工具栏中物品耐久值的百分比（小数形式），以及它当前的耐久，以及它的最大耐久。
  如果工具栏中没有工具或者工具栏中的物品没有耐久值，它会返回 nil 以及一条描述为何不能返回耐久值的消息。错误信息要么是 no tool equipped，要么是 too connot be damaged。
• robot.swing([side: number[, sneaky: boolean]]): boolean[, string]
  让机器人立即以玩家点击左键的方式对着面前的方块或空间使用工具栏里装备的物品。
  side - 如果指定，机器人只会尝试左键点击给定的面，否则机器人会尝试点击所有可能的面。参见 方向控制（sides） API 来获得可能的面的列表。
  返回值：如果机器人可以和面前的方块或实体互动，返回真，否则返回假。如果成功，第二个返回值会描述机器人和什么东西互动了，它会是“实体”、“方块”或“火”之一。
  这可以被用于开采方块或者攻击实体，就像玩家点击左键一样。请注意工具和武器会像被玩家使用一样掉耐久，而且最终需要被替换掉。如果可能，开采的方块或实体的掉落物会被放进机器人的物品栏中，否则就会掉在地上。
  请注意，即使某个动作会被立刻完成（例如方块被摧毁），这个函数也会适当地等待一会来模拟一名玩家做这个操作所需的时间。如果你尝试开采黑曜石，这会很明显，因为它们立即就被破坏并且放入了机器人的物品栏中，但函数还要再等几秒。
  如果它被用于开采方块，那么装备的工具必须满足机器人面前方块的挖掘等级。举例来说，如果一把木镐被用于开采黑曜石，它会返回假。任何东西（包括空的工具栏）都能被用于战斗，但是伤害会基于使用的物品。
  同样所有东西都能被用来熄灭火，而有耐久的工具也不会掉耐久。
• robot.swingUp([side: number[, sneaky: boolean]]): boolean[, string]
  和 robot.swing() 一样，只是这个会将头顶的方块或实体当作目标。
• robot.swingDown([side: number[, sneaky: boolean]]): boolean[, string]
  和 robot.swing() 一样，只是这个会将脚底的方块或实体当作目标。
• robot.use([side: number[, sneaky: boolean[, duration: number]]]): boolean[, string]
  尝试以玩家点击右键的方式对着前方使用当前工具栏里的工具。
  side - 如果给定，机器人只会尝试“右键”指定的面，否则机器人会尝试右键所有可能的面。参见 方向控制（sides） API 来获得可能的面的列表。
  sneaky - 如果设置为 true，机器人会模拟潜行点击右键（如同玩家按住 Shift 时点击右键）。某些物品（例如桶）在这时会有不同的行为。 duration - 这个物品被使用多长时间。这在使用例如弓之类的蓄力物品时很有用。
  返回值： 如果机器人可以和它面前的方块或实体互动返回真，否则返回假。如果成功，第二个返回值会描述机器人和什么东西互动了，它会是“方块已激活”、“物品已放置”、“和物品互动”或者“物品已使用”之一。
  这个函数有很广泛的应用，因为机器人能由此模拟右键点击大部分物品。和玩家唯一的不同在于机器人不能使用要求使用者必须是实体的物品，因为机器人是方块。所以喝药水、吃食物或者扔末影珍珠会失败。
  这个函数的第二个返回值可以被用于右键点击造成的结果。有些物品返回的结果并不总是明显的，它们需要事先测试。同样请注意尽管机器人不会被有害的药水伤害，它们仍然可以被爆炸炸毁，所以在你使用这个函数放置、扔出或激活任何爆炸物时，请务必小心。可能的第二个返回值是以下这些：
  • block_activated - 一个方块被激活了（例如拉杆、按钮或门）。
  • item_interacted - 装备的工具与世界互动了，例如用剪刀剪羊毛。
  • item_placed - 某些东西被放置在世界上了。这不仅仅由可放置的方块造成，还会由可以创造方块或实体的物品造成（例如打火石或刷怪蛋)。
  • item_used - 装备的物品被激活了，例如喷溅型药水。
  • air - 装备的物品要求有一个目标但是却没有。请注意，如果你的机器人有一个天使方块升级，这个值永远不会被返回，但是一些动作仍然不会有效果。
• robot.useUp([side: number[, sneaky: boolean[, duration: number]]]): boolean[, string]
  和 robot.use() 一样，只是这个会瞄准机器人头顶的位置。
• robot.useDown([side: number[, sneaky: boolean[, duration: number]]]): boolean[, string]
  和 robot.use() 一样，只是这个会瞄准机器人脚底的位置。
• robot.forward(): boolean[, string]
  尝试将机器人向前移动。
  返回值：返回 true，如果机器人成功移动了，否则返回 nil。如果移动失败，第二个返回值会描述为什么失败，它会是“不可能的移动”、“没有足够能量”或者是 robot.detect 返回的障碍描述之一。
  返回值“没有足够能量”是极少见的，因为缺少能量通常会让机器人在那之前就关机了。
  返回值“不可能的移动”是一种回落（fall-back）结果，而且会在诸如机器人试图进入一片未加载区域等场合返回。
• robot.back(): boolean[, string]
  和 robot.forward() 一样，只是这个会让机器人尝试向后移动。
• robot.up(): boolean[, string]
  和 robot.forward() 一样，只是这个会让机器人尝试向上移动。
• robot.down(): boolean[, string]
  和 robot.forward() 一样，只是这个会让机器人尝试向下移动。
• robot.turnLeft()
  将机器人左转 90°。
  请注意，它只会在机器人没有足够能量左转但还没有关机时失败。
• robot.turnRight()
  和 robot.turnLeft() 一样，只是这个会让机器人右转 90°。
• robot.turnAround
  这和调用两次 robot.turnRight() 是一样的。
• robot.level(): number
  自 OC 1.3 起已弃用。
  译者注：由于该 API 被弃用且暂无恢复计划，故略过不译，有需要者请自行查看英文文档。
• robot.tankCount(): number
  机器人安装的液体储罐数量（number）。
• robot.selectTank(tank)
  选择指定的液体储罐。这决定了大多数操作在哪个液体储罐上进行。
• robot.tankLevel([tank:number]): number
  返回指定液体储罐的等级，如果没有指定，则返回当前液体储罐的等级。
• robot.compareFluidTo(tank: number): boolean
  测试当前选定的液体储罐中的液体与给定的液体储罐中的液体是否相同。
• robot.transferFluidTo(tank: number[, count: number]): boolean
  从当前选定的液体储罐转移指定数量的液体到给定的液体储罐。如果不指定数量，就会尝试转移 1000 mB。
• robot.compareFluid(): boolean
  测试当前选定的液体储罐中的液体与机器人面前的液体储罐中的液体是否相同。
• robot.compareFluidUp(): boolean
  和 robot.compareFluid() 一样，只是这个会比较机器人头顶的液体储罐。
• robot.compareFluidDown(): boolean
  和 robot.compareFluid() 一样，只是这个会比较机器人脚底的液体储罐。
• robot.drain([count: number]): boolean
  从机器人面前的液体储罐抽取指定数量的液体到选定的液体储罐中。当不指定数量时，会尝试转移 1000 mB。当抽取的液体是直接存在于世界上并且不能被完全储存于选定的液体储罐时，操作失败。没有液体会损失。
• robot.drainUp([count: number]): boolean
  和 robot.drain() 一样，只是这个会抽取机器人头顶的液体。
• robot.drainDown([count: number]): boolean
  和 robot.drain() 一样，只是这个会抽取机器人脚底的液体。
• robot.fill([count: number]): boolean
  从选定的液体储罐中注入指定数量的液体到机器人面前的液体储罐。当不指定数量时，会尝试转移 1000 mB。当没有足够的液体来填充一个方块。或者目标储罐没有足够的空间，操作失败。没有液体会损失。
• robot.fillUp([count: number]): boolean
  和 robot.fill() 一样，只是这个会向机器人头顶注入液体。
• robot.fillDown([count: number]): boolean
  和 robot.fill() 一样，只是这个会向机器人脚底注入液体。