Difference between revisions of "Command Block (API)"
From ComputerCraft Wiki
MKlegoman357 (Talk | contribs) (Fixed grammar (hopefully) and improved example) |
Bomb Bloke (Talk | contribs) m (Wiki table.) |
||
| Line 1: | Line 1: | ||
{{PeripheralAPI}} | {{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 | + | (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== |
| + | Functions exposed by the Command Block, where "commandBlock" is a [[peripheral.wrap|wrapped]] Command Block: | ||
| − | + | {| class="wikitable" | |
| − | + | ! width="100px" | Returns | |
| − | + | ! width="200px" | Method name | |
| − | + | ! Description | |
| − | + | |- | |
| − | + | |{{type|string}} command | |
| − | + | |[[commandBlock.getCommand]]() | |
| − | + | |Returns a string containing the command currently inside the Command Block. | |
| − | + | |- | |
| − | + | | | |
| − | + | |[[commandBlock.setCommand]]({{type|string}} command) | |
| − | + | |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]](). | |
| − | + | |} | |
==Usage== | ==Usage== | ||
Revision as of 01:38, 1 April 2014
| This API requires the use of a wrapped peripheral! This API does not behave like a regular API, to use it you must first wrap the peripheral and call the methods on the wrapped object. For more information see this page.
|
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 disables it by default.)
API
Functions exposed by the Command Block, where "commandBlock" is a wrapped Command Block:
| Returns | Method name | Description |
|---|---|---|
| string command | commandBlock.getCommand() | Returns a string containing the command currently inside the Command Block. |
| commandBlock.setCommand(string command) | 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(). |
Usage
All Command Block functions are to be used after wrapping the block as a peripheral. Example:
local commandBlock = peripheral.wrap("left") commandBlock.setCommand("time set 1000") commandBlock.runCommand() local currentCommand = commandBlock.getCommand()
