Commands.exec - Revision history

Magiczocker at 07:06, 4 August 2020

2020-08-04T07:06:28Z

Smiley43210: Changed "MineCraft" to "Minecraft"

2015-08-14T12:14:54Z

Changed "MineCraft" to "Minecraft"

MKlegoman357: Almost forgot to mention that it exists as _G.exec in CC 1.71+

2015-02-23T16:24:23Z

Almost forgot to mention that it exists as _G.exec in CC 1.71+

MKlegoman357: Fixed return parameters, improved description

2015-02-23T16:19:50Z

Fixed return parameters, improved description

MKlegoman357: Updated to ComputerCraft 1.71

2015-02-23T15:58:31Z

Updated to ComputerCraft 1.71

MKlegoman357: Removed misinformation. commands.exec/execAsync only allows to pass one string: the command. Only commands.() where is an actual MC command allows multiple parameters, including numbers and tables

2015-02-17T08:26:57Z

Removed misinformation. commands.exec/execAsync only allows to pass one string: the command. Only commands.<command>() where <command> is an actual MC command allows multiple parameters, including numbers and tables

Bomb Bloke at 00:03, 17 February 2015

2015-02-17T00:03:40Z

Bomb Bloke at 23:31, 16 February 2015

2015-02-16T23:31:36Z

Bomb Bloke: More info.

2015-02-16T23:23:05Z

More info.

MKlegoman357: Created page with "{{lowercase}} {{Function |name=commands.exec |args={{type|string}} command |returns={{type|boolean}} success [, {{type|string}} error] |api=commands |addon=ComputerCr..."

2015-02-16T17:05:54Z

Created page with "{{lowercase}} {{Function |name=commands.exec |args={{type|string}} command |returns={{type|boolean}} success [<nowiki/>, {{type|string}} error] |api=commands |addon=ComputerCr..."

New page

{{lowercase}}
{{Function
|name=commands.exec
|args={{type|string}} command
|returns={{type|boolean}} success [<nowiki/>, {{type|string}} error]
|api=commands
|addon=ComputerCraft
|desc=Available only to [[Command Computer]]s, executes the command <var>command</var>, [[os.pullEvent|yields]] until the result is determined, then returns it. If command executes successfully then it returns <var>true</var>, otherwise returns <var>false</var> + an error message.
|examples=
{{Example
|desc=Says 'Hello' to the player, closest to the [[Command Computer]].
|code='''commands.exec( "say @p Hello" )'''
}}
{{Example
|desc=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
}}
}}

{{CommandsAPIFunctions}}

[[Category:API_Functions]]

@@ Line 6: / Line 6: @@
 |api=commands
 |addon=ComputerCraft
-|desc=Available only to [[Command Computer]]s, executes the specified [http://minecraft.gamepedia.com/Commands Minecraft command], [[os.pullEvent|yields]] until the result is determined, then returns it. If command executes successfully then it returns <var>true</var> + the output of the command as a numerically-indexed table, otherwise returns <var>false</var> + an error message as as a numerically-indexed table. Compare [[commands.execAsync]], which ignores the result and returns immediately, without yielding.
+|desc=Available only to [[Command Computer]]s, executes the specified [https://minecraft.gamepedia.com/Commands Minecraft command], [[os.pullEvent|yields]] until the result is determined, then returns it. If command executes successfully then it returns <var>true</var> + the output of the command as a numerically-indexed table, otherwise returns <var>false</var> + an error message as as a numerically-indexed table. Compare [[commands.execAsync]], which ignores the result and returns immediately, without yielding.
 <br/>
 In ComputerCraft 1.71+ instead of just returning a {{type|boolean}} and an optional error message ({{type|string}}) this function also returns the output of the command in a numerically-indexed table, where each line of the output is put in a separate index. This output is the same as if you would run the command in chat. See example below for an example of this table.<br/>

@@ Line 6: / Line 6: @@
 |api=commands
 |addon=ComputerCraft
-|desc=Available only to [[Command Computer]]s, executes the specified [http://minecraft.gamepedia.com/Commands MineCraft command], [[os.pullEvent|yields]] until the result is determined, then returns it. If command executes successfully then it returns <var>true</var> + the output of the command as a numerically-indexed table, otherwise returns <var>false</var> + an error message as as a numerically-indexed table. Compare [[commands.execAsync]], which ignores the result and returns immediately, without yielding.
+|desc=Available only to [[Command Computer]]s, executes the specified [http://minecraft.gamepedia.com/Commands Minecraft command], [[os.pullEvent|yields]] until the result is determined, then returns it. If command executes successfully then it returns <var>true</var> + the output of the command as a numerically-indexed table, otherwise returns <var>false</var> + an error message as as a numerically-indexed table. Compare [[commands.execAsync]], which ignores the result and returns immediately, without yielding.
 <br/>
 In ComputerCraft 1.71+ instead of just returning a {{type|boolean}} and an optional error message ({{type|string}}) this function also returns the output of the command in a numerically-indexed table, where each line of the output is put in a separate index. This output is the same as if you would run the command in chat. See example below for an example of this table.<br/>

@@ Line 9: / Line 9: @@
 <br/>
 In ComputerCraft 1.71+ instead of just returning a {{type|boolean}} and an optional error message ({{type|string}}) this function also returns the output of the command in a numerically-indexed table, where each line of the output is put in a separate index. This output is the same as if you would run the command in chat. See example below for an example of this table.<br/>
 <br/>
 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!")''.
@@ Line 28: / Line 30: @@
 }}
 {{Example
-|desc=Prints the output after running the command "help".
+|desc=Prints the output after running the command "help". ''Requires ComputerCraft 1.71+.''
 |code=local success, output = '''commands.exec( "help" )'''

@@ Line 3: / Line 3: @@
 |name=commands.exec
 |args={{type|string}} command
-|returns={{type|boolean}} success, {{type|table}} output/{{type|string}} error
+|returns={{type|boolean}} success, {{type|table}} output
 |api=commands
 |addon=ComputerCraft
 |desc=Available only to [[Command Computer]]s, executes the specified [http://minecraft.gamepedia.com/Commands MineCraft command], [[os.pullEvent|yields]] until the result is determined, then returns it. If command executes successfully then it returns <var>true</var> + the output of the command as a numerically-indexed table, otherwise returns <var>false</var> + an error message as as a numerically-indexed table. Compare [[commands.execAsync]], which ignores the result and returns immediately, without yielding.
 <br/>
-In ComputerCraft 1.71+ instead of just returning <var>true</var> this function also returns the output of the command in a numerically-indexed table. This output is the same as if you would run the command in chat. Each line of the output is put in a separate index. See example below for an example of this table.<br/>
+In ComputerCraft 1.71+ instead of just returning a {{type|boolean}} and an optional error message ({{type|string}}) this function also returns the output of the command in a numerically-indexed table, where each line of the output is put in a separate index. This output is the same as if you would run the command in chat. See example below for an example of this table.<br/>
 <br/>
 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!")''.
@@ Line 29: / Line 29: @@
 {{Example
 |desc=Prints the output after running the command "help".
-|code=local success, output = '''commands.exec("help")'''
+|code=local success, output = '''commands.exec( "help" )'''
   if success then
-    [[print]]( textutils.serialize( output ) )
+    [[print]]( [[textutils.serialize]]( output ) )
   end
 |output=Example output:

@@ Line 7: / Line 7: @@
 |addon=ComputerCraft
 |desc=Available only to [[Command Computer]]s, executes the specified [http://minecraft.gamepedia.com/Commands MineCraft command], [[os.pullEvent|yields]] until the result is determined, then returns it. If command executes successfully then it returns <var>true</var>, otherwise returns <var>false</var> + an error message. Compare [[commands.execAsync]], which ignores the result and returns immediately, without yielding.
+<br/>
-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|textutils.serializeJSON()'d]] (handy for dynamically generating [http://minecraft.gamepedia.com/Tutorials/Command_NBT_Tags 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!")''.
 |examples=