commands.exec

From ComputerCraft Wiki
Revision as of 00:03, 17 February 2015 by Bomb Bloke (Talk | contribs)

Jump to: navigation, search


Grid Redstone.png  Function commands.exec
Available only to Command Computers, executes the specified MineCraft command, yields until the result is determined, then returns it. If command executes successfully then it returns true, otherwise returns false + an error message. Compare commands.execAsync, which ignores the result and returns immediately, without yielding.

Accepts multiple parameters, in much the same manner as print, so long as they can all be serialised into one string. For example, commands.exec("setblock 0 70 0 minecraft:stone 0") is treated the same as commands.exec("setblock", 0, 70, 0, "minecraft:stone", 0). If one of the parameters is a table, it will be automatically textutils.serializeJSON()'d (handy for dynamically generating NBT representations).

Most commands returned by commands.list() are also available as functions, such that commands.exec(command) could also be written as commands.command(par1, par2, ...) - eg, commands.exec("msg @p Hello world!") becomes commands.msg("@p Hello world!").
Syntax commands.exec(string command)
Returns boolean success [, string error]
Part of ComputerCraft
API commands

Examples

Grid paper.png  Example
Says 'Hello' to the player, closest to the Command Computer.
Code
commands.exec( "say @p Hello" )



Grid paper.png  Example
Checks if there are any players around the Command Computer in 2 block radius.
Code
local radius = 2
local arePlayersAround = commands.exec( "testfor @a[r=" .. radius .. "]")

if arePlayersAround then
  print( "There is one or more players around me." )
else
  print( "There are no players around me." )
end


Grid disk.png Commands API Functions
commands.exec - commands.execAsync - commands.list - commands.getBlockPosition - commands.getBlockInfo - commands.getBlockInfos