Command Block (API) - Revision history

MKlegoman357: Fixed return parameters

2015-02-16T19:25:21Z

Fixed return parameters

Bomb Bloke at 12:10, 16 February 2015

2015-02-16T12:10:36Z

MKlegoman357 at 13:45, 9 April 2014

2014-04-09T13:45:58Z

MKlegoman357: Peripheral names in functions are now italic

2014-04-09T13:42:21Z

Peripheral names in functions are now italic

MKlegoman357: Recreated the table using {{API table}} tag

2014-04-06T22:11:25Z

Recreated the table using {{API table}} tag

Bomb Bloke: Wiki table.

2014-04-01T01:38:19Z

Wiki table.

MKlegoman357: Fixed grammar (hopefully) and improved example

2014-03-31T21:55:38Z

Fixed grammar (hopefully) and improved example

Oeed: Added peripheral API message

2014-03-26T07:15:52Z

Added peripheral API message

Smiley43210: Updated table to v2

2013-05-15T13:51:39Z

Updated table to v2

Lyqyd: Fix typo (Where does peripheral "warping" come from, anyhow?)

2013-03-30T21:16:19Z

Fix typo (Where does peripheral "warping" come from, anyhow?)

@@ Line 21: / Line 21: @@
 {{API table/row
 |[[commandBlock.runCommand|''commandBlock''.runCommand]]()
-|{{type|nil}}
+|{{type|boolean}} success [<nowiki/>, {{type|string}} error]
 |Runs the command inside the Command Block previously set by manually editing it or by using [[commandBlock.setCommand|''commandBlock''.setCommand]]().
 |odd}}

@@ Line 2: / Line 2: @@
 The Command Block API allows you to run commands in a Command Block, using it as a [[peripheral]].
-(The peripheral can only be used if allowed in the [[ComputerCraft.cfg|config]], which disables it by default.)
+(The peripheral can only be used if allowed in the [[ComputerCraft.cfg|config]], which disables it by default.) Under CC 1.7 or later, it may be easier to use a [[Command Computer]].
 ==API==

@@ Line 22: / Line 22: @@
 |[[commandBlock.runCommand|''commandBlock''.runCommand]]()
 |{{type|nil}}
-|Runs the command inside the Command Block previously set by manually editing it or by using [[commandBlock.setCommand]]().
+|Runs the command inside the Command Block previously set by manually editing it or by using [[commandBlock.setCommand|''commandBlock''.setCommand]]().
 |odd}}
 }}

@@ Line 9: / Line 9: @@
 {{API table/row
-|[[commandBlock.getCommand]]()
+|[[commandBlock.getCommand|''commandBlock''.getCommand]]()
 |{{type|string}} command
 |Returns a string containing the command currently inside the Command Block.
@@ Line 15: / Line 15: @@
 {{API table/row
-|[[commandBlock.setCommand]]({{type|string}} command)
+|[[commandBlock.setCommand|''commandBlock''.setCommand]]({{type|string}} command)
 |{{type|nil}}
 |Sets the command in the Command Block to ''command''. '''This does not run it.'''}}
 {{API table/row
-|[[commandBlock.runCommand]]()
+|[[commandBlock.runCommand|''commandBlock''.runCommand]]()
 |{{type|nil}}
 |Runs the command inside the Command Block previously set by manually editing it or by using [[commandBlock.setCommand]]().

@@ Line 6: / Line 6: @@
 ==API==
 Functions exposed by the Command Block, where "commandBlock" is a [[peripheral.wrap|wrapped]] Command Block:
-{| class="wikitable"
+{{API table/row
-! width="100px" | Returns
-! width="200px" | Method name
-! Description
-|-
-|{{type|string}} command
 |[[commandBlock.getCommand]]()
 |Returns a string containing the command currently inside the Command Block.
-|-
+|odd}}
-−
 |[[commandBlock.setCommand]]({{type|string}} command)
-|Sets the command in the Command Block to ''command''. '''This does not run it.'''
+|{{type|nil}}
-|-
+|Sets the command in the Command Block to ''command''. '''This does not run it.'''}}
-−
 |[[commandBlock.runCommand]]()
 |Runs the command inside the Command Block previously set by manually editing it or by using [[commandBlock.setCommand]]().
-|}
+|odd}}
 ==Usage==
-All Command Block functions are to be used ''after'' wrapping the block as a peripheral.
+All Command Block functions are to be used ''after'' [[peripheral.wrap|wrapping]] the block as a peripheral.
 '''Example''':
 <span>

@@ Line 1: / Line 1: @@
 {{PeripheralAPI}}
-The Command Block API allows you to run commands in a Command Block, using it as a peripheral.
+The Command Block API allows you to run commands in a Command Block, using it as a [[peripheral]].
-(The peripheral can only be used if allowed in the config, which is to false by default)
+(The peripheral can only be used if allowed in the [[ComputerCraft.cfg|config]], which disables it by default.)
-Functions exposed by the Command Block, where commandBlock is a wrapped Command Block:
+==API==
-<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
+{| class="wikitable"
-<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
+! width="100px" | Returns
-[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
+! width="200px" | Method name
-Command Block (API)
+! Description
-</td></tr>
+|-
+|{{type|string}} command
-<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
+|[[commandBlock.getCommand]]()
+|Returns a string containing the command currently inside the Command Block.
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[commandBlock.getCommand]]()</td>
+|-
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a string containing the command currently inside the Command Block.</td></tr>
+|[[commandBlock.setCommand]]({{type|string}} command)
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[commandBlock.setCommand]]({{type|string}} command)</td>
+|Sets the command in the Command Block to ''command''. '''This does not run it.'''
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the command in the Command Block to ''command''. '''This does not run it.'''</td></tr>
+|-
-−
+|
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[commandBlock.runCommand]]()</td>
+|[[commandBlock.runCommand]]()
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs the command inside the Command Block previously set by manually editing it or by using [[commandBlock.setCommand]]()</td></tr>
+|Runs the command inside the Command Block previously set by manually editing it or by using [[commandBlock.setCommand]]().
-</table>
+|}
 ==Usage==

@@ Line 2: / Line 2: @@
 The Command Block API allows you to run commands in a Command Block, using it as a peripheral.
-(The peripheral can only be used if allowed in the config, which is default to false)
+(The peripheral can only be used if allowed in the config, which is to false by default)
-Functions exposed by the Command Block, where commandBlock is wrapped to a command block:
+Functions exposed by the Command Block, where commandBlock is a wrapped Command Block:
 <table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
@@ Line 24: / Line 24: @@
 </table>
-==Note==
+==Usage==
-All Command Block functions are to be used ''after'' wrapping the block in a peripheral.
+All Command Block functions are to be used ''after'' wrapping the block as a peripheral.
-'''example''':
+'''Example''':
 <span>
-  commandBlock = [[peripheral.wrap]]("left")
+  local commandBlock = [[peripheral.wrap]]("left")
   commandBlock.setCommand("time set 1000")
-  commandBlock.runCommand()
+ [[commandBlock.setCommand]]("time set 1000")
-  local currentCommand = commandBlock.getCommand()
+  [[commandBlock.runCommand]]()
 </span>
 [[Category:Peripheral APIs]]

← Older revision		Revision as of 07:15, 26 March 2014
Line 1:		Line 1:
		+	{{PeripheralAPI}}
		+
	The Command Block API allows you to run commands in a Command Block, using it as a peripheral.		The Command Block API allows you to run commands in a Command Block, using it as a peripheral.
	(The peripheral can only be used if allowed in the config, which is default to false)		(The peripheral can only be used if allowed in the config, which is default to false)