Commands.execAsync - Revision history

Magiczocker at 07:07, 4 August 2020

2020-08-04T07:07:25Z

Bomb Bloke: Bug fixed as of 1.76

2015-12-26T00:42:02Z

Bug fixed as of 1.76

Bomb Bloke: Clarification on excessive command handling.

2015-12-01T23:34:54Z

Clarification on excessive command handling.

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:25:04Z

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:35Z

Bomb Bloke: More info.

2015-02-16T23:30:09Z

More info.

MKlegoman357: Corrected an example

2015-02-16T17:18:49Z

Corrected an example

MKlegoman357: Created page with "{{lowercase}} {{Function |name=commands.execAsync |args={{type|string}} command |returns={{type|number}} taskID |api=commands |addon=ComputerCraft |desc=Available only to Co..."

2015-02-16T17:18:05Z

Created page with "{{lowercase}} {{Function |name=commands.execAsync |args={{type|string}} command |returns={{type|number}} taskID |api=commands |addon=ComputerCraft |desc=Available only to Co..."

New page

{{lowercase}}
{{Function
|name=commands.execAsync
|args={{type|string}} command
|returns={{type|number}} taskID
|api=commands
|addon=ComputerCraft
|desc=Available only to [[Command Computer]]s, executes the specified command, but doesn't [[os.pullEvent|yield]]. Queues a [[task_complete_(event)|"task_complete"]] event after the command is executed. You can use the <var>taskID</var> returned by this function to identify the "task_complete" event.
|examples=
{{Example
|desc=Says 'Hello' to the player, closest to the [[Command Computer]].
|code='''commands.execAsync( "say @p Hello" )'''
}}
{{Example
|desc=Checks if there are any players around the [[Command Computer]] in 2 block radius.
|code=local radius = 2
local taskID = '''commands.execAync( "testfor @a[r=" .. radius .. "]")'''

local arePlayersAround
repeat
local event, id, success, executed, error = [[os.pullEvent]]( [[task_complete_(event)|"task_complete"]] )

arePlayersAround = success and executed
until id == taskID

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, orders the specified [http://minecraft.gamepedia.com/Commands MineCraft command] to be executed, but doesn't [[os.pullEvent|yield]]. A [[task_complete_(event)|"task_complete"]] event will be queued once the command has actually been executed. You can use the <var>taskID</var> returned by this function to identify the "task_complete" event, should you wish to pull it. Compare [[commands.exec]], which automatically yields until this event is thrown, then catches it and returns the results.<br><br>
+|desc=Available only to [[Command Computer]]s, orders the specified [https://minecraft.gamepedia.com/Commands MineCraft command] to be executed, but doesn't [[os.pullEvent|yield]]. A [[task_complete_(event)|"task_complete"]] event will be queued once the command has actually been executed. You can use the <var>taskID</var> returned by this function to identify the "task_complete" event, should you wish to pull it. Compare [[commands.exec]], which automatically yields until this event is thrown, then catches it and returns the results.<br><br>
 This function allows huge amounts of commands to be requested in a very short time - much faster than Minecraft can actually perform them. Generating an excessive queue will cause your script to error out; to avoid problems, either perform periodic sleeps or measure incoming task_complete events (up to 256 events may exist within the event queue at a time; see [[os.pullEvent]]() for more info on the event system).

@@ Line 6: / Line 6: @@
 |api=commands
 |addon=ComputerCraft
-|desc=Available only to [[Command Computer]]s, orders the specified [http://minecraft.gamepedia.com/Commands MineCraft command] to be executed, but doesn't [[os.pullEvent|yield]]. A [[task_complete_(event)|"task_complete"]] event will be queued once the command has actually been executed. You can use the <var>taskID</var> returned by this function to identify the "task_complete" event, should you wish to pull it. Compare [[commands.exec]], which automatically yields until this event is thrown, then catches it and returns the results.
+|desc=Available only to [[Command Computer]]s, orders the specified [http://minecraft.gamepedia.com/Commands MineCraft command] to be executed, but doesn't [[os.pullEvent|yield]]. A [[task_complete_(event)|"task_complete"]] event will be queued once the command has actually been executed. You can use the <var>taskID</var> returned by this function to identify the "task_complete" event, should you wish to pull it. Compare [[commands.exec]], which automatically yields until this event is thrown, then catches it and returns the results.<br><br>
-This function allows huge amounts of commands to be requested in a very short time - much faster than Minecraft can actually perform them. Generating an excessive queue will cause your script to error out.
+This function allows huge amounts of commands to be requested in a very short time - much faster than Minecraft can actually perform them. Generating an excessive queue will cause your script to error out; to avoid problems, either perform periodic sleeps or measure incoming task_complete events (up to 256 events may exist within the event queue at a time; see [[os.pullEvent]]() for more info on the event system).
-−
-Furthermore, while commands are resolving ComputerCraft's event system is negatively affected - events (of all types) may randomly fail to make it into the event queue. The more commands in the command queue the less reliable the event queue becomes. (See [[os.pullEvent]]() for information concerning events.)
 |examples=
 {{Example

@@ Line 8: / Line 8: @@
 |desc=Available only to [[Command Computer]]s, orders the specified [http://minecraft.gamepedia.com/Commands MineCraft command] to be executed, but doesn't [[os.pullEvent|yield]]. A [[task_complete_(event)|"task_complete"]] event will be queued once the command has actually been executed. You can use the <var>taskID</var> returned by this function to identify the "task_complete" event, should you wish to pull it. Compare [[commands.exec]], which automatically yields until this event is thrown, then catches it and returns the results.
-As this function allows huge amounts of commands to be requested in a very short time, no more than 1000 orders will be processed per server tick (the rest being queued until the next tick, and so on).
+This function allows huge amounts of commands to be requested in a very short time - much faster than Minecraft can actually perform them. Generating an excessive queue will cause your script to error out.
 |examples=
 {{Example

@@ Line 6: / Line 6: @@
 |api=commands
 |addon=ComputerCraft
-|desc=Available only to [[Command Computer]]s, executes the specified command, but doesn't [[os.pullEvent|yield]]. A [[task_complete_(event)|"task_complete"]] event will be queued after the command is executed. You can use the <var>taskID</var> returned by this function to identify the "task_complete" event, should you wish to pull it. Compare [[commands.exec]], which automatically yields until this event is thrown, then catches it and returns the results.
+|desc=Available only to [[Command Computer]]s, orders the specified [http://minecraft.gamepedia.com/Commands MineCraft command] to be executed, but doesn't [[os.pullEvent|yield]]. A [[task_complete_(event)|"task_complete"]] event will be queued once the command has actually been executed. You can use the <var>taskID</var> returned by this function to identify the "task_complete" event, should you wish to pull it. Compare [[commands.exec]], which automatically yields until this event is thrown, then catches it and returns the results.
 As this function allows huge amounts of commands to be requested in a very short time, no more than 1000 orders will be processed per server tick (the rest being queued until the next tick, and so on).

@@ Line 15: / Line 15: @@
 |desc=Checks if there are any players around the [[Command Computer]] in 2 block radius.
 |code=local radius = 2
-  local taskID = '''commands.execAync( "testfor @a[r=" .. radius .. "]")'''
+  local taskID = '''commands.execAsync( "testfor @a[r=" .. radius .. "]")'''
   local arePlayersAround