imported>OCDoc Import: Imported from legacy OpenComputers documentation at ocdoc.cil.li

2026-08-24T08:08:27Z

Imported from legacy OpenComputers documentation at ocdoc.cil.li

New page

= 组件：调试 =

此组件由[[Item/debug card/zh|调试卡]]提供。

仅在创造模式可用的[[Item/debug card/zh|调试卡]]提供了一套实际上很危险的功能，可用于调试与测试代码。没有进行备份的话切勿使用调试卡，绝对不要。比如有一次我就不小心将竖着的一整片世界都变成了无文字的告示牌。

调试卡的“容器”指装有调试卡的机器人、电脑或平板电脑。

在专用服务器游玩时，调试卡必须绑定到某个玩家身上才能用`runCommand`回调来运行命令，绑定的方式为手持调试卡潜行右键单击。被绑定的玩家需要有运行提供给`runCommand`的命令的权限。

组件名：`debug`。

回调函数：

* `changeBuffer(value:number):number`

<pre>以指定值作为增量，修改组件网络的能量缓存。
</pre>

* `connectToBlock(x:number, y:number, z:number):boolean`

<pre>将调试卡连接到指定坐标处的可与 OC 兼容的方块。
</pre>

* `getPlayer(name:string):userdata`

<pre>获取玩家对象。
</pre>

* `getPlayers():table`

<pre>获取当前登录玩家列表。
</pre>

* `getWorld([id:number]):userdata`

<pre>获取指定维度ID对应的世界对象，若不指定则为容器的世界。
</pre>

* `getWorlds():table`

<pre>获取所有世界ID的列表，无论是否加载。
</pre>

* `getX():number`

<pre>获取容器在世界中的X坐标。
</pre>

* `getY():number`

<pre>获取容器在世界中的Y坐标。
</pre>

* `getZ():number`

<pre>获取容器在世界中的Z坐标。
</pre>

* `isModLoaded(name:string):boolean`

<pre>获取指定mod或API是否加载。
</pre>

* `runCommand(command:string):number, string`

<pre>使用伪玩家（fake player）执行任意命令。若命令运行成功则第一个返回值为1，失败为0。第二个返回值为指令返回的内容或报错信息。若命令不返回任何内容，例如`/me`，第二个返回值将为`nil`。
</pre>

* `test():userdata`

<pre>用于转换`user-data`与通用数值的测试方法。
</pre>

* `getScoreboard():userdata`

<pre>获取世界的计分板对象。
</pre>

* `sendToDebugCard(address:string, data...)`

<pre>向指定地址的调试卡发送数据。
</pre>

* `sendToClipboard(player:string, text:string)`

<pre>若可行的话，向指定玩家的剪切板中发送文本。
</pre>

* `scanContentsAt(x: number, y: number, z: number[, worldId: number]):boolean, string, table`

<pre>返回指定ID对应世界（默认为主世界）指定位置处的内容。此方法与机器人和无人机的运动检测功能行为相同。第一个返回值为布尔型，代表了机器人或无人机能否进入此位置（为`true`代表会被阻挡，不能进入）。第二个返回值为字符串值，代表障碍类型。可能的取值包括：`EntityLivingBase`、`EntityMinecart`、`air`、`liquid`、`replaceable`、`passable`、`solid`。最后一个返回值为此位置扫描到的实体或方块，以序列化的或普通表的形式来表示。下面的代码片段可用于调试获取可能阻挡机器人前进的物体，假设机器人面向X轴负方向。
</pre>
<source lang="lua">local debug = require("component").debug
local serialize = require("serialization").serialize
local x, y, z = debug.getX, debug.getY, debug.getZ
local offset_x = -1
local offset_z = 0
local blocking, label, content = debug.scanContentsAt(x() - .5 + offset_x, y() - .5, z() - .5 + offset_z)
print(blocking, label, serialize(content))
</source>
=== 世界对象 ===

世界对象是容器当前所在的世界（维度）的映射。

* `getMetadata(x:number, y:number, z:number):number`

<pre>获取位于指定坐标的方块的元表。
</pre>

* `getBlockId(x:number, y:number, z:number):number`

<pre>获取位于指定坐标的方块的ID。
</pre>

* `getDimensionId():number`

<pre>获取当前维度的数字ID。
</pre>

* `isLoaded(x:number, y:number, z:number):number`

<pre>检查位于指定坐标的方块是否被加载。
</pre>

* `getSeed():number`

<pre>获取世界的种子。
</pre>

* `removeFluid(amount:number, x:number, y:number, z:number, side:number):boolean`

<pre>从位于指定坐标处的流体罐中移除一定量流体。
</pre>

* `insertFluid(id:string, amount:number, x:number, y:number, z:number, side:number):boolean`

<pre>向位于指定坐标处的流体罐中添加一定量流体。
</pre>

* `getDimensionName():string`

<pre>获取当前维度的名称。
</pre>

* `getTime():number`

<pre>获取当前世界时间。
</pre>

* `setTime(value:number)`

<pre>设定当前世界时间。
</pre>

* `getLightValue(x:number, y:number, z:number):number`

<pre>获取位于指定坐标处的方块的光照等级（自身发出的）。
</pre>

* `isRaining():boolean`

<pre>返回当前天气是否为降雨。
</pre>

* `setRaining(value:boolean)`

<pre>设定当前天气是否为降雨。
</pre>

* `isThundering():boolean`

<pre>返回当前天气是否为雷暴。
</pre>

* `setThundering(value:boolean)`

<pre>设定当前天气是否为雷暴。
</pre>

* `setBlock(x:number, y:number, z:number, id:number or string, meta:number):number`

<pre>在指定坐标处放置指定方块。
</pre>

* `setBlocks(x1:number, y1:number, z1:number, x2:number, y2:number, z2:number, id:number or string, meta:number):number`

<pre>在指定范围内填充指定方块，范围为立方体，由两个对角顶点(x1, y1, z1)与(x2, y2, z2)表示。
</pre>

* `removeItem(x:number, y:number, z:number, slot:number[, count:number]):number`

<pre>减少指定坐标处物品容器的指定槽位中物品堆的物品数。
</pre>

* `insertItem(id:string, count:number, damage:number, nbt:string, x:number, y:number, z:number, side:number):boolean`

<pre>将一个物品堆放入到指定坐标处物品容器的指定槽位中。给定的NBT标签需为JSON格式。
</pre>

* `getSpawnPoint():number, number, number`

<pre>获取当前的重生点坐标。
</pre>

* `setSpawnPoint(x:number, y:number, z:number)`

<pre>设定重生点坐标。
</pre>

* `canSeeSky(x:number, y:number, z:number):number`

<pre>获取位于指定坐标处的方块是否直接暴露在天空下。
</pre>

* `getLightOpacity(x:number, y:number, z:number):number`

<pre>获取位于指定坐标处的方块的不透明度。
</pre>

* `hasTileEntity(x:number, y:number, z:number):number`

<pre>检查位于指定坐标处的方块是否具有方块实体。
</pre>

* `playSoundAt(x:number, y:number, z:number, sound:string, range:number)`

<pre>在指定坐标处播放音效。
</pre>

* `getTileNBT(x:number, y:number, z:number):table`

<pre>获取位于指定坐标处的方块的NBT数据。
</pre>

* `setTileNBT(x:number, y:number, z:number, nbt:table):boolean`

<pre>设定位于指定坐标处的方块的NBT数据。
</pre>

* `getBlockState(x:number, y:number, z:number[, actualState:boolean=false])`

<pre>获取位于指定坐标处的方块的状态，可选是否获取额外的有关显示的数据。
</pre>
=== 玩家对象 ===

玩家对象代表了世界中一个指定玩家。

* `getWorld():userdata`

<pre>获取玩家所在世界的世界对象。
</pre>

* `getGameType():string`

<pre>获取玩家的游戏模式。
</pre>

* `setGameType(gametype:string)`

<pre>设定玩家的游戏模式（`survival`-生存，`creative`-创造，`adventure`-冒险）。
</pre>

* `getHealth():number`

<pre>获取玩家的生命值。
</pre>

* `setHealth(health:number)`

<pre>设定玩家的生命值。
</pre>

* `getMaxHealth():number`

<pre>获取玩家的最大生命值。
</pre>

* `getPosition():number, number, number`

<pre>获取玩家的位置。
</pre>

* `setPosition(x:number, y:number, z:number)`

<pre>设定玩家的位置。
</pre>

* `getExperienceTotal():number`

<pre>获取玩家的总经验值。
</pre>

* `getLevel():number`

<pre>获取玩家的等级。
</pre>

* `addExperienceLevel(level:number)`

<pre>为玩家的经验等级增加一级。
</pre>

* `removeExperienceLevel(level:number)`

<pre> 为玩家的经验等级减少一级。
</pre>

* `insertItem(id:string, amount:number, meta:number[, nbt:string]):number`

<pre>将一个物品堆添加到玩家的物品栏中。
</pre>

* `clearInventory()`

<pre>清空玩家的物品栏。
</pre>
=== 计分板对象 ===

* `addObjective(objectiveName:string, objectiveCriteria:string)`

<pre>在计分板中创建一个新的对象。
</pre>

* `removeObjective(objectiveName:string)`

<pre>从计分板中移除一个对象。
</pre>

* `increasePlayerScore(playerName:string, objectiveName:string, score:int)`

<pre>增加某计分板对象中某玩家的分数。
</pre>

* `decreasePlayerScore(playerName:string, objectiveName:string, score:int)`

<pre>减少某计分板对象中某玩家的分数。
</pre>

* `addPlayerToTeam(player:string, team:string):boolean`

<pre>将某玩家加入某团队中。
</pre>

* `removePlayerFromTeam(player:string, team:string):boolean`

<pre>将一名玩家从指定团队中移除。
</pre>

* `removePlayerFromTeams(player:string):boolean`

<pre>将一名玩家从所有团队中移除。
</pre>

* `addTeam(team:string)`

<pre>将一个团队添加到计分板中。
</pre>

* `removeTeam(teamName: string)`

<pre>从计分板中移除一个团队。
</pre>

* `getPlayerScore(playerName:string, objectiveName:string):int`

<pre>获取某计分板对象中某玩家的分数。
</pre>

* `setPlayerScore(playerName:string, objectiveName:string, score:int)`

<pre>设定某计分板对象中某玩家的分数。
</pre>
== 目录 ==

{{:Component/contents/zh}}

Component/debug/zh - Revision history

imported>OCDoc Import: Imported from legacy OpenComputers documentation at ocdoc.cil.li