Component/agent/zh: Difference between revisions
Jump to navigation
Jump to search
imported>OCDoc Import Imported from legacy OpenComputers documentation at ocdoc.cil.li |
Clean up Markdown artifacts from DokuWiki migration |
||
| Line 1: | Line 1: | ||
=== 物品栏控制器特性API === | === 物品栏控制器特性API === | ||
* | * <code>inventorySize():number</code> | ||
<pre>返回设备内部物品栏的大小。 | <pre>返回设备内部物品栏的大小。 | ||
</pre> | </pre> | ||
* | * <code>select([slot:number]):number</code> | ||
<pre>获取当前选定槽位号；若指定了槽位号则为设置当前选定槽位。 | <pre>获取当前选定槽位号；若指定了槽位号则为设置当前选定槽位。 | ||
</pre> | </pre> | ||
* | * <code>count([slot:number]):number</code> | ||
<pre>获取指定槽位中的物品数量，若不指定则获取当前选定槽位中的物品数量。 | <pre>获取指定槽位中的物品数量，若不指定则获取当前选定槽位中的物品数量。 | ||
</pre> | </pre> | ||
* | * <code>space([slot:number]):number</code> | ||
<pre>获取指定槽位的剩余空间，若不指定则获取当前选定槽位的剩余空间。 | <pre>获取指定槽位的剩余空间，若不指定则获取当前选定槽位的剩余空间。 | ||
</pre> | </pre> | ||
* | * <code>compareTo(otherSlot:number):boolean</code> | ||
<pre>将（机器人物品栏中）当前选定槽位的内容物，与（也是机器人物品栏中）指定槽位的内容物相比较。 | <pre>将（机器人物品栏中）当前选定槽位的内容物，与（也是机器人物品栏中）指定槽位的内容物相比较。 | ||
</pre> | </pre> | ||
* | * <code>transferTo(toSlot:number[, amount:number]):boolean</code> | ||
<pre>将指定数量的物品从当前选定槽位中移动到指定槽位。如果未指定数量，则移动整个物品堆。 | <pre>将指定数量的物品从当前选定槽位中移动到指定槽位。如果未指定数量，则移动整个物品堆。 | ||
| Line 32: | Line 32: | ||
=== 世界控制特性API === | === 世界控制特性API === | ||
* | * <code>detect(side:number):boolean</code> | ||
<pre> | <pre>检测相对机器人的给定方向处的方块，并返回机器人是否可以移动到该方块中，以及方块的大致描述。若方块会阻挡机器人向前移动，则返回true，否则返回false。无人机即使在方块为可穿越（passable）时也会返回true。 | ||
</pre> | </pre> | ||
'''side''' - 请参阅[[API/sides/zh|sides(方向) API]]以获取可能的方向列表。 | '''side''' - 请参阅[[API/sides/zh|sides(方向) API]]以获取可能的方向列表。 | ||
| Line 40: | Line 40: | ||
=== 世界储罐控制器特性API === | === 世界储罐控制器特性API === | ||
* | * <code>compareFluid(side:number):boolean</code> | ||
<pre>将当前选定储罐（需要[[Item/tank upgrade/zh|储罐升级]]）中的流体与机器人指定方向处世界中或外部储罐中的流体进行比较。 | <pre>将当前选定储罐（需要[[Item/tank upgrade/zh|储罐升级]]）中的流体与机器人指定方向处世界中或外部储罐中的流体进行比较。 | ||
</pre> | </pre> | ||
* | * <code>drain(side:number[, count:number]):boolean</code> | ||
<pre>令机器人从指定方向抽取在世界中或储罐中的一定数量流体。若未指定数量，机器人将尝试抽取1000mB。若储罐无法存储指定数量的流体，则操作将失败（该过程不会损失流体）。 | <pre>令机器人从指定方向抽取在世界中或储罐中的一定数量流体。若未指定数量，机器人将尝试抽取1000mB。若储罐无法存储指定数量的流体，则操作将失败（该过程不会损失流体）。 | ||
</pre> | </pre> | ||
* | * <code>fill(side:number[, count:number]):boolean</code> | ||
<pre>从当前选定储罐（需要[[Item/tank upgrade/zh|储罐升级]]）中抽取指定量流体，向指定方向填充到世界中或储罐中。若未指定数量，机器人将尝试用1000mB 的液体填充目标储罐。若没有足够的流体来填充方块或者目标储罐没有足够的空间，则操作将失败，且流体不会损失。 | <pre>从当前选定储罐（需要[[Item/tank upgrade/zh|储罐升级]]）中抽取指定量流体，向指定方向填充到世界中或储罐中。若未指定数量，机器人将尝试用1000mB 的液体填充目标储罐。若没有足够的流体来填充方块或者目标储罐没有足够的空间，则操作将失败，且流体不会损失。 | ||
| Line 55: | Line 55: | ||
=== 硬件实体特性API === | === 硬件实体特性API === | ||
* | * <code>name():string</code> | ||
<pre>获取机器人的名称。 | <pre>获取机器人的名称。 | ||
</pre> | </pre> | ||
* | * <code>swing(side:number):boolean[, string]</code> | ||
<pre>让机器人使用当前工具槽位装备的物品与正前方的方块或空间交互。如果成功则返回 | <pre>让机器人使用当前工具槽位装备的物品与正前方的方块或空间交互。如果成功则返回 true（可能需要时间，具取决于与其交互的方块，例如黑曜石需要一些时间来挖掘）。如果执行失败则返回false以及失败原因。 | ||
</pre> | </pre> | ||
* | * <code>use(side: number[, sneaky: boolean[, duration: number]]): boolean[, string]</code> | ||
<pre>尝试以与玩家右键单击相同的方式使用当前装备在工具槽位的物品。 | <pre>尝试以与玩家右键单击相同的方式使用当前装备在工具槽位的物品。 | ||
</pre> | </pre> | ||
'''side''' - 若给定，则机器人仅尝试在指定面上“右键单击”，否则机器人会尝试所有可能的面。请查阅[[API/sides/zh|sides(方向) API]]以获取可能的方向列表。 '''sneaky''' - 若设置为true，机器人将会模拟玩家的潜行右键单击（如同玩家在右键单击时按住shift键一样）。若设置为true，某些物品（例如桶）的行为会有所不同。 '''duration''' - 使用该物品的时间。这在使用弓等需要蓄力的物品时很有用。 '''返回值：'''若机器人可以与其前面的方块或实体交互，则返回 | '''side''' - 若给定，则机器人仅尝试在指定面上“右键单击”，否则机器人会尝试所有可能的面。请查阅[[API/sides/zh|sides(方向) API]]以获取可能的方向列表。 '''sneaky''' - 若设置为true，机器人将会模拟玩家的潜行右键单击（如同玩家在右键单击时按住shift键一样）。若设置为true，某些物品（例如桶）的行为会有所不同。 '''duration''' - 使用该物品的时间。这在使用弓等需要蓄力的物品时很有用。 '''返回值：'''若机器人可以与其前面的方块或实体交互，则返回 <code>true</code>，否则返回 <code>false</code>。若成功，会有第二个返回值，代表机器人交互的内容，可能取值为下列之一：<code>block_activated</code>（激活方块）、<code>item_placed</code>（放置物品）、<code>item_used</code>（使用物品）、<code>item_interacted</code>（与物品互动）、<code>air</code>（空气）。 此函数用途非常广泛，因为机器人可以模拟右键单击大多数物品。在这方面机器人与玩家的唯一区别是机器人不能使用明确要求用户是实体的物品，因为机器人是方块。所以喝药水、吃食物或扔末影珍珠都会失败。 此函数的第二个返回值可用来判断右键单击的结果。有时候不一定能明显看出一个物品会返回哪个值，因此需要事先测试。还需注意，虽然机器人不受有害药水的影响，但它们可能会被爆炸摧毁，因此在使用此函数放置、投掷或激活任何形式的炸药时要小心。 第二个返回值的可能值有： | ||
= <code>block_activated</code> - 某个方块被激活（例如拉杆、开关以及门） = | |||
= <code>item_interacted</code> - 装备的工具与世界进行了互动，例如在羊身上使用剪刀。 = | |||
= <code>item_placed</code> - 某个物品被放置到了世界中。此返回值不一定由可放置的方块触发，其他会导致方块或实体出现在世界上的物品也会触发（例如燧石或刷怪蛋）。 = | |||
= <code>item_used</code> - 装备的物品被激活，例如喷溅式药水。 = | |||
= <code>air</code> - 当前装备的物品需要目标才能使用，但并不存在。请注意如果你的机器人有天使升级，此返回值将永远不会出现，但一些操作可能仍然无效果。 = | |||
* | * <code>place(side: number[, sneaky: boolean]): boolean[, string]</code> | ||
<pre> | <pre>尝试将物品栏中前选定槽位中的方块放置在机器人的指定方向（若支持此方向）。若sneaky设置为true，那么机器人将会模拟潜行放置（按住shift点击）。若成功放置则返回 true，若操作失败则返回 false。若使用不支持的值作为参数，则操作将会失败，并返回失败原因。 | ||
</pre> | </pre> | ||
* | * <code>getLightColor():number</code> | ||
<pre>获取当前活动指示灯（机器人）或机翼灯（无人机）设定的颜色，形式为整数编码RGB值（0xRRGGBB）。 | <pre>获取当前活动指示灯（机器人）或机翼灯（无人机）设定的颜色，形式为整数编码RGB值（0xRRGGBB）。 | ||
</pre> | </pre> | ||
* | * <code>setLightColor(value:number):number</code> | ||
<pre>将活动指示灯（机器人）或机翼灯（无人机）的颜色设定为给定的整数编码RGB值（0xRRGGBB）。 | <pre>将活动指示灯（机器人）或机翼灯（无人机）的颜色设定为给定的整数编码RGB值（0xRRGGBB）。 | ||
| Line 93: | Line 93: | ||
=== 储罐控制器特性API === | === 储罐控制器特性API === | ||
* | * <code>tankCount():number</code> | ||
<pre>返回机器人中安装的储罐数量。 | <pre>返回机器人中安装的储罐数量。 | ||
</pre> | </pre> | ||
* | * <code>selectTank(tank:number)</code> | ||
<pre>选定指定储罐（如果机器人包含多个[[Item/tank upgrade/zh|储罐升级]]）。任何储罐操作都会使用这个储罐。 | <pre>选定指定储罐（如果机器人包含多个[[Item/tank upgrade/zh|储罐升级]]）。任何储罐操作都会使用这个储罐。 | ||
</pre> | </pre> | ||
* | * <code>tankLevel([tank:number]):number</code> | ||
<pre>返回指定储罐中的流体存量。若未指定储罐，则返回当前选定储罐（使用 | <pre>返回指定储罐中的流体存量。若未指定储罐，则返回当前选定储罐（使用 selectTank()）中的流体存量。 | ||
</pre> | </pre> | ||
* | * <code>tankSpace([tank:number]):number</code> | ||
<pre>返回指定储罐中的剩余流体容量（剩余空间）。若未指定储罐，则返回当前选定储罐的剩余容量。 | <pre>返回指定储罐中的剩余流体容量（剩余空间）。若未指定储罐，则返回当前选定储罐的剩余容量。 | ||
</pre> | </pre> | ||
* | * <code>compareFluidTo(tank:number):boolean</code> | ||
<pre>检查（机器人物品栏）当前选定槽位中储罐所存流体是否与指定储罐中的相同（需要[[Item/tank upgrade/zh|储罐升级]]）。 | <pre>检查（机器人物品栏）当前选定槽位中储罐所存流体是否与指定储罐中的相同（需要[[Item/tank upgrade/zh|储罐升级]]）。 | ||
</pre> | </pre> | ||
* | * <code>transferFluidTo(tank:number[, count:number]):boolean</code> | ||
<pre>从当前选定储罐中转移指定量流体到指定储罐。若未指定转移量，机器人将尝试传输 1000mB。 | <pre>从当前选定储罐中转移指定量流体到指定储罐。若未指定转移量，机器人将尝试传输 1000mB。 | ||
| Line 124: | Line 124: | ||
=== 世界物品栏控制器特性API === | === 世界物品栏控制器特性API === | ||
* | * <code>compare(side:number[, fuzzy:boolean=false]):boolean</code> | ||
<pre> | <pre>将机器人指定方向处的方块与当前选定槽位中的物品进行比较，返回它们是否相同。方块相同的条件是类型和元数据相同，不检查额外物品堆信息。空方块被视为空气方块，不能与物品栏的空槽位进行比较。detect() 函数可用于确定机器人前面是否有方块。 | ||
</pre> | </pre> | ||
对于掉落不同物品而非本身的方块， | 对于掉落不同物品而非本身的方块，<code>compare()</code>方法不起作用（例如：钻石矿石掉落钻石物品）；对这种情况，请使用精准采集获取原方块进行比较。 | ||
* | * <code>drop(side:number[, count:number]):boolean</code> | ||
<pre>从物品栏的当前选定槽位中提取并丢弃指定数量的物品。若丢弃了至少一个物品，则返回 | <pre>从物品栏的当前选定槽位中提取并丢弃指定数量的物品。若丢弃了至少一个物品，则返回 true，否则返回 false。若机器人前面的方块为物品容器，机器人会尝试把物品放入容器中。 | ||
</pre> | </pre> | ||
若该容器不能接收该物品，物品'''不会'''被丢弃在世界中（操作将会执行失败并返回 | 若该容器不能接收该物品，物品'''不会'''被丢弃在世界中（操作将会执行失败并返回 <code>false</code>）。机器人本身被视为带物品栏的方块，并且可以使用<code>drop()</code>函数将物品移入其中。<code>drop()</code> 函数不适用非物品容器，例如流体储罐（<code>use()</code> 函数适用于这些情况）。 | ||
* | * <code>suck(side:number[, count:number]):boolean</code> | ||
<pre> | <pre>尝试拾取指定数量的物品并将其置于当前选定槽位中。若当前选定槽位被占用，则物品将被置于第一个可用槽位中。返回值为拾取的物品数量，其他情况返回false。 | ||
</pre> | </pre> | ||
=== 机器人组件API === | === 机器人组件API === | ||
* | * <code>durability():number</code> | ||
<pre>获取当前装备工具的耐久度。 | <pre>获取当前装备工具的耐久度。 | ||
</pre> | </pre> | ||
* | * <code>move(direction:number):boolean</code> | ||
<pre> | <pre>向指定方向移动。可用的移动方向有：front、back、top、bottom（参见[[API/sides/zh|sides(方向) API]]）。 | ||
</pre> | </pre> | ||
* | * <code>turn(clockwise:boolean):boolean</code> | ||
<pre>向指定方向旋转。 | <pre>向指定方向旋转。 | ||
</pre> | </pre> | ||
=== 无人机组件API === | === 无人机组件API === | ||
* | * <code>getStatusText():string</code> | ||
<pre>获取当前在GUI中显示的状态文本。 | <pre>获取当前在GUI中显示的状态文本。 | ||
</pre> | </pre> | ||
* | * <code>setStatusText(value:string):string</code> | ||
<pre>设置在GUI中显示的状态文本，返回新设定的值。 | <pre>设置在GUI中显示的状态文本，返回新设定的值。 | ||
</pre> | </pre> | ||
* | * <code>move(dx:number, dy:number, dz:number)</code> | ||
<pre>以给定偏移量修改目标位置。 | <pre>以给定偏移量修改目标位置。 | ||
</pre> | </pre> | ||
* | * <code>getOffset():number</code> | ||
<pre>获取当前到目标位置的距离。 | <pre>获取当前到目标位置的距离。 | ||
</pre> | </pre> | ||
* | * <code>getVelocity():number</code> | ||
<pre>获取当前速度，单位m/s。 | <pre>获取当前速度，单位m/s。 | ||
</pre> | </pre> | ||
* | * <code>getMaxVelocity():number</code> | ||
<pre>获取最大速度，单位m/s。 | <pre>获取最大速度，单位m/s。 | ||
</pre> | </pre> | ||
* | * <code>getAcceleration():number</code> | ||
<pre>获取当前设置的加速度。 | <pre>获取当前设置的加速度。 | ||
</pre> | </pre> | ||
* | * <code>setAcceleration(value:number):number</code> | ||
<pre>尝试将加速度设置为给定值，返回新的加速度值。 | <pre>尝试将加速度设置为给定值，返回新的加速度值。 | ||
</pre> | </pre> | ||
Latest revision as of 20:27, 24 August 2026
物品栏控制器特性API
inventorySize():number
返回设备内部物品栏的大小。
select([slot:number]):number
获取当前选定槽位号；若指定了槽位号则为设置当前选定槽位。
count([slot:number]):number
获取指定槽位中的物品数量，若不指定则获取当前选定槽位中的物品数量。
space([slot:number]):number
获取指定槽位的剩余空间，若不指定则获取当前选定槽位的剩余空间。
compareTo(otherSlot:number):boolean
将（机器人物品栏中）当前选定槽位的内容物，与（也是机器人物品栏中）指定槽位的内容物相比较。
transferTo(toSlot:number[, amount:number]):boolean
将指定数量的物品从当前选定槽位中移动到指定槽位。如果未指定数量，则移动整个物品堆。
世界控制特性API
detect(side:number):boolean
检测相对机器人的给定方向处的方块，并返回机器人是否可以移动到该方块中，以及方块的大致描述。若方块会阻挡机器人向前移动，则返回true，否则返回false。无人机即使在方块为可穿越（passable）时也会返回true。
side - 请参阅sides(方向) API以获取可能的方向列表。
世界储罐控制器特性API
compareFluid(side:number):boolean
将当前选定储罐（需要[[Item/tank upgrade/zh|储罐升级]]）中的流体与机器人指定方向处世界中或外部储罐中的流体进行比较。
drain(side:number[, count:number]):boolean
令机器人从指定方向抽取在世界中或储罐中的一定数量流体。若未指定数量，机器人将尝试抽取1000mB。若储罐无法存储指定数量的流体，则操作将失败（该过程不会损失流体）。
fill(side:number[, count:number]):boolean
从当前选定储罐（需要[[Item/tank upgrade/zh|储罐升级]]）中抽取指定量流体，向指定方向填充到世界中或储罐中。若未指定数量，机器人将尝试用1000mB 的液体填充目标储罐。若没有足够的流体来填充方块或者目标储罐没有足够的空间，则操作将失败，且流体不会损失。
硬件实体特性API
name():string
获取机器人的名称。
swing(side:number):boolean[, string]
让机器人使用当前工具槽位装备的物品与正前方的方块或空间交互。如果成功则返回 true（可能需要时间，具取决于与其交互的方块，例如黑曜石需要一些时间来挖掘）。如果执行失败则返回false以及失败原因。
use(side: number[, sneaky: boolean[, duration: number]]): boolean[, string]
尝试以与玩家右键单击相同的方式使用当前装备在工具槽位的物品。
side - 若给定，则机器人仅尝试在指定面上“右键单击”，否则机器人会尝试所有可能的面。请查阅sides(方向) API以获取可能的方向列表。 sneaky - 若设置为true，机器人将会模拟玩家的潜行右键单击（如同玩家在右键单击时按住shift键一样）。若设置为true，某些物品（例如桶）的行为会有所不同。 duration - 使用该物品的时间。这在使用弓等需要蓄力的物品时很有用。 返回值：若机器人可以与其前面的方块或实体交互，则返回 true，否则返回 false。若成功，会有第二个返回值，代表机器人交互的内容，可能取值为下列之一：block_activated（激活方块）、item_placed（放置物品）、item_used（使用物品）、item_interacted（与物品互动）、air（空气）。 此函数用途非常广泛，因为机器人可以模拟右键单击大多数物品。在这方面机器人与玩家的唯一区别是机器人不能使用明确要求用户是实体的物品，因为机器人是方块。所以喝药水、吃食物或扔末影珍珠都会失败。 此函数的第二个返回值可用来判断右键单击的结果。有时候不一定能明显看出一个物品会返回哪个值，因此需要事先测试。还需注意，虽然机器人不受有害药水的影响，但它们可能会被爆炸摧毁，因此在使用此函数放置、投掷或激活任何形式的炸药时要小心。 第二个返回值的可能值有：
block_activated - 某个方块被激活（例如拉杆、开关以及门）
item_interacted - 装备的工具与世界进行了互动，例如在羊身上使用剪刀。
item_placed - 某个物品被放置到了世界中。此返回值不一定由可放置的方块触发，其他会导致方块或实体出现在世界上的物品也会触发（例如燧石或刷怪蛋）。
item_used - 装备的物品被激活，例如喷溅式药水。
air - 当前装备的物品需要目标才能使用，但并不存在。请注意如果你的机器人有天使升级，此返回值将永远不会出现，但一些操作可能仍然无效果。
place(side: number[, sneaky: boolean]): boolean[, string]
尝试将物品栏中前选定槽位中的方块放置在机器人的指定方向（若支持此方向）。若sneaky设置为true，那么机器人将会模拟潜行放置（按住shift点击）。若成功放置则返回 true，若操作失败则返回 false。若使用不支持的值作为参数，则操作将会失败，并返回失败原因。
getLightColor():number
获取当前活动指示灯（机器人）或机翼灯（无人机）设定的颜色，形式为整数编码RGB值（0xRRGGBB）。
setLightColor(value:number):number
将活动指示灯（机器人）或机翼灯（无人机）的颜色设定为给定的整数编码RGB值（0xRRGGBB）。
储罐控制器特性API
tankCount():number
返回机器人中安装的储罐数量。
selectTank(tank:number)
选定指定储罐（如果机器人包含多个[[Item/tank upgrade/zh|储罐升级]]）。任何储罐操作都会使用这个储罐。
tankLevel([tank:number]):number
返回指定储罐中的流体存量。若未指定储罐，则返回当前选定储罐（使用 selectTank()）中的流体存量。
tankSpace([tank:number]):number
返回指定储罐中的剩余流体容量（剩余空间）。若未指定储罐，则返回当前选定储罐的剩余容量。
compareFluidTo(tank:number):boolean
检查（机器人物品栏）当前选定槽位中储罐所存流体是否与指定储罐中的相同（需要[[Item/tank upgrade/zh|储罐升级]]）。
transferFluidTo(tank:number[, count:number]):boolean
从当前选定储罐中转移指定量流体到指定储罐。若未指定转移量，机器人将尝试传输 1000mB。
世界物品栏控制器特性API
compare(side:number[, fuzzy:boolean=false]):boolean
将机器人指定方向处的方块与当前选定槽位中的物品进行比较，返回它们是否相同。方块相同的条件是类型和元数据相同，不检查额外物品堆信息。空方块被视为空气方块，不能与物品栏的空槽位进行比较。detect() 函数可用于确定机器人前面是否有方块。
对于掉落不同物品而非本身的方块，compare()方法不起作用（例如：钻石矿石掉落钻石物品）；对这种情况，请使用精准采集获取原方块进行比较。
drop(side:number[, count:number]):boolean
从物品栏的当前选定槽位中提取并丢弃指定数量的物品。若丢弃了至少一个物品，则返回 true，否则返回 false。若机器人前面的方块为物品容器，机器人会尝试把物品放入容器中。
若该容器不能接收该物品，物品不会被丢弃在世界中（操作将会执行失败并返回 false）。机器人本身被视为带物品栏的方块，并且可以使用drop()函数将物品移入其中。drop() 函数不适用非物品容器，例如流体储罐（use() 函数适用于这些情况）。
suck(side:number[, count:number]):boolean
尝试拾取指定数量的物品并将其置于当前选定槽位中。若当前选定槽位被占用，则物品将被置于第一个可用槽位中。返回值为拾取的物品数量，其他情况返回false。
机器人组件API
durability():number
获取当前装备工具的耐久度。
move(direction:number):boolean
向指定方向移动。可用的移动方向有：front、back、top、bottom（参见[[API/sides/zh|sides(方向) API]]）。
turn(clockwise:boolean):boolean
向指定方向旋转。
无人机组件API
getStatusText():string
获取当前在GUI中显示的状态文本。
setStatusText(value:string):string
设置在GUI中显示的状态文本，返回新设定的值。
move(dx:number, dy:number, dz:number)
以给定偏移量修改目标位置。
getOffset():number
获取当前到目标位置的距离。
getVelocity():number
获取当前速度，单位m/s。
getMaxVelocity():number
获取最大速度，单位m/s。
getAcceleration():number
获取当前设置的加速度。
setAcceleration(value:number):number
尝试将加速度设置为给定值，返回新的加速度值。