ComputerCraft Wiki - User contributions [en]

Settings (API)

2016-06-11T03:40:26Z

Bomb Bloke: Set script link

{{lowercase}}
The '''settings API''' allows to store values and save them to a file for persistent configurations for your and CraftOS programs. The default file for saving settings is <var>.settings</var> sitting in the root of the computer. Settings can also be changed and added to all computers through [[ComputerCraft.cfg]]'s <var>S:default_computer_settings</var> value. It became available as of ComputerCraft 1.77, the first build for Minecraft 1.8.9.

See also: [[Set|the set script]].

{{API table|settings|image=Grid_disk.png|2=

{{API table/row
|[[settings.set]]({{type|string}} name, {{type|any}} value)
|{{type|nil}}
|Sets the setting <var>name</var> to <var>value</var>.
|odd}}

{{API table/row
|[[settings.get]]({{type|string}} name [, {{type|any}} default])
|{{type|any}} value
|Returns the setting's <var>name</var> value, or <var>default</var> if the setting does not exist.}}

{{API table/row
|[[settings.unset]]({{type|string}} name)
|{{type|nil}}
|Removes the setting <var>name</var>.
|odd}}

{{API table/row
|[[settings.clear]]()
|{{type|nil}}
|Removes all settings.}}

{{API table/row
|[[settings.getNames]]()
|{{type|table}} settingNames
|Returns a numerically-indexed table of all the setting's names.
|odd}}

{{API table/row
|[[settings.load]]({{type|string}} path)
|{{type|boolean}} loaded
|Loads settings from a file.}}

{{API table/row
|[[settings.save]]({{type|string}} path)
|{{type|boolean}} saved
|Saves current settings to a file.
|odd}}

}}

[[Category:APIs]]

==Notes==
* Settings changed via this API are '''not''' automatically saved to a file, you have to do this [[settings.save|manually]].
* Setting's names can only be of type {{type|string}}.
* Setting's values can only be [[textutils.serialize|serializable]] types: {{type|string}}, {{type|number}}, {{type|boolean}} or {{type|table}}.

==Default Settings==
These are the default settings of a computer (as seen in CC 1.77 and later):

<pre>
{
[ "bios.use_multishell" ] = true,
[ "shell.autocomplete" ] = true,
[ "shell.allow_disk_startup" ] = true --# (for all Computer types except Command Computers),
[ "shell.allow_startup" ] = true,
[ "lua.autocomplete" ] = true,
[ "list.show_hidden" ] = false,
[ "edit.autocomplete" ] = true,
}
</pre>

*'''<var>shell.autocomplete</var>''' - enables auto-completion in the [[Shell]].
*'''<var>lua.autocomplete</var>''' - enables auto-completion in the [[Lua]] program.
*'''<var>edit.autocomplete</var>''' - enables auto-completion in the [[Edit]] program.
*'''<var>bios.use_multishell</var>''' - enables [[Multishell]] on [[Advanced Computer]]s, [[Advanced Turtle|Turtles]], [[Advanced Pocket Computer|Pocket Computers]] and [[Command Computer]]s.
*'''<var>shell.allow_disk_startup</var>''' - if a [[Disk Drive]] with a [[Disk]] inside that has a 'startup' script is attached to a computer, this setting allows to automatically run that script when the computer starts.
*'''<var>shell.allow_startup</var>''' - if there is a 'startup' script in a computer's root, this setting allow to automatically run that script when the computer runs.
*'''<var>list.show_hidden</var>''' - determines, whether the [[List]] program will list hidden files or not.

==.settings==
If a file titled ".settings" is [[settings.save|saved]] to the root of a given computer's drive, it will be automatically [[settings.load|loaded]] after the default settings on boot (note "after", as opposed to "instead of").

For example, if the file simply contains:

<pre>
{
[ "bios.use_multishell" ] = false
}
</pre>

... then all regular defaults will apply except for the use of [[multishell]], which will be disabled.

==ComputerCraft.cfg==
You can change or add default settings for all computers through [[ComputerCraft.cfg]]. The format is as follows:
* each setting is separated by a comma (<var>,</var>)
* setting's name and value is separated by an equals sign (<var>=</var>)

This example will disable auto-completion features in the default programs.
<pre>
S:default_computer_settings=shell.autocomplete=false,lua.autocomplete=false,edit.autocomplete=false
</pre>

Set

2016-06-11T03:37:44Z

Bomb Bloke: Created page with "Added by ComputerCraft 1.77, the '''set''' command allows manipulation of system settings, such as the defaults listed here. Changes are au..."

Added by ComputerCraft 1.77, the '''set''' command allows manipulation of system settings, such as the [[Settings_(API)#Default_Settings|defaults listed here]]. Changes are automatically saved to [[Settings_(API)#.settings|the .settings file]], and will hence also be automatically re-applied on the next boot.

Specifying a value of "nil" completely unsets a setting. Doing this to a system default setting means that it will take on its original value when the system is next restarted.

{{Example
|desc=Disables shell auto-completion.
|code=set shell.autocomplete false
}}

[[Category:Programs]]

CraftOS Shell

2016-06-11T03:20:40Z

Bomb Bloke: Reformatted + added: paint, chat, set, wget, commands, exec

== Regular Shell Commands ==

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
CraftOS Shell Programs
</td></tr>
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Program Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Version Added</td></tr>

<div id="cmd-alias">
{{API table/row
|[[alias]]<br><tt>alias <alias> <program></tt>
|Maps an alias string to a program.
|1.2
|odd}}
</div>

<div id="cmd-apis">
{{API table/row
|[[apis]]<br><tt>apis</tt>
|Lists all loaded APIs.
|1.2
|}}
</div>

<div id="cmd-bg">
{{API table/row
|[[bg]]<br><tt>bg <program> <arguments></tt>
|Opens the specified script in a new [[multishell]] tab.
|1.6
|odd}}
</div>

<div id="cmd-cd">
{{API table/row
|[[cd]]<br><tt>cd <path></tt>
|Changes to the specified directory
|
|}}
</div>

<div id="cmd-chat">
{{API table/row
|[[chat]]<br><tt>chat host <hostname></tt>, <tt>chat join <hostname> <nickname></tt>
|Peer-to-peer rednet-based messaging software.
|1.6
|odd}}
</div>

<div id="cmd-clear">
{{API table/row
|[[clear]]<br><tt>clear</tt>
|Clears the terminal.
|
|}}
</div>

<div id="cmd-copy">
{{API table/row
|[[copy]]<br><tt>copy <source> <destination></tt>
|Copies a source file or folder to a destination
|1.2
|odd}}
</div>

<div id="cmd-delete">
{{API table/row
|[[delete]]<br><tt>delete <path></tt>
|Deletes the specified file (in the same manner as [[rm]]).
|1.2
|}}
</div>

<div id="cmd-dj">
{{API table/row
|[[dj]]<br><tt>dj</tt>
|Music box DJ - use <tt>dj</tt> for help.
|1.2
|odd}}
</div>

<div id="cmd-drive">
{{API table/row
|[[drive]]<br><tt>drive</tt>, <tt>drive <path></tt>
|Lists the mount location of the current directory, or the path specified.
|1.2
|}}
</div>

<div id="cmd-edit">
{{API table/row
|[[edit]]<br><tt>edit <path></tt>
|Edits the file specified.
|
|odd}}
</div>

<div id="cmd-eject">
{{API table/row
|[[eject]]<br><tt>eject <side></tt>
|Ejects the disk on the side specified.
|1.2
|}}
</div>

<div id="cmd-exit">
{{API table/row
|[[exit]]<br><tt>exit</tt>
|Exits the currently running shell session - if it is the only shell session, the computer will power off.
|
|odd}}
</div>

<div id="cmd-fg">
{{API table/row
|[[fg]]<br><tt>fg <program> <arguments></tt>
|Opens the specified script in a new [[multishell]] tab, then switches to it.
|1.6
|}}
</div>

<div id="cmd-gps">
{{API table/row
|[[Gps (program)|gps]]<br><tt>gps <?></tt>
|Minecraft Global Positioning tool. Use <tt>gps</tt> for help.
|1.31
|odd}}
</div>

<div id="cmd-help">
{{API table/row
|[[help]]<br><tt>help</tt>, <tt>help <topic></tt>
|Help utility. Opens the specified topic, or the introduction if no topic is specified.
|
|}}
</div>

<div id="cmd-id">
{{API table/row
|[[id]]<br><tt>id</tt>, <tt>id <side></tt>
|Returns the ID of the computer, or if a side is specified, the ID of the disk in the specified side.
|1.2
|odd}}
</div>

<div id="cmd-label">
{{API table/row
|[[label]]<br><tt>label</tt>
|Gets and sets the ID of the computer, or, the ID of a disk in a specified side. Use <tt>label</tt> for help.
|1.2
|}}
</div>

<div id="cmd-list">
{{API table/row
|[[list]]<br><tt>list</tt>, <tt>list <path></tt>
|Lists the content of the current directory, or, the directory specified.
|1.2
|odd}}
</div>

<div id="cmd-lua">
{{API table/row
|[[lua]]<br><tt>lua</tt>
|Interactive Lua interpreter at the shell.
|
|}}
</div>

<div id="cmd-mkdir">
{{API table/row
|[[mkdir]]<br><tt>mkdir <path></tt>
|Makes the directory at the path specified.
|
|odd}}
</div>

<div id="cmd-monitor">
{{API table/row
|[[Monitor (program)|monitor]]<br><tt>monitor <side> <program> <arguments></tt>
|Redirects a specified program to a monitor on the specified side.
|1.31
|}}
</div>

<div id="cmd-move">
{{API table/row
|[[move]]<br><tt>move <source> <destination></tt>
|Moves a file or folder at a specified source path to the specified destination path.
|1.2
|odd}}
</div>

<div id="cmd-multishell">
{{API table/row
|[[multishell]]<br><tt>multishell</tt>
|Opens a new instance of multishell, running within the ''current'' multishell session.
|1.6
|}}
</div>

<div id="cmd-paint">
{{API table/row
|[[paint]]<br><tt>paint <path></tt>
|Edits the image specified.
|1.45
|odd}}
</div>

<div id="cmd-pastebin">
{{API table/row
|[[Pastebin_(program)|pastebin]]<br><tt>pastebin <get/run/put> <pastebin code/file></tt>
|Allows the user to either retrieve a file from [http://pastebin.com/ pastebin.com], run it directly after downloading, or upload a file from the computer/turtle.
|1.31
|}}
</div>

<div id="cmd-peripherals">
{{API table/row
|[[peripherals_(program)|peripherals]]<br><tt>peripherals</tt>
|Lists all peripherals attacked to the system.
|1.76
|odd}}
</div>

<div id="cmd-programs">
{{API table/row
|[[programs]]<br><tt>programs</tt>
|Lists all programs on the system.
|
|}}
</div>

<div id="cmd-reboot">
{{API table/row
|[[reboot]]<br><tt>reboot</tt>
|Reboots the Computer.
|1.2
|odd}}
</div>

<div id="cmd-redstone">
{{API table/row
|[[redstone (program)|redstone]]<br><tt>redstone <?></tt>
|Controls the redstone output state(s) of the system.
|1.6
|}}
</div>

<div id="cmd-repeat">
{{API table/row
|[[repeat]]<br><tt>repeat</tt>
|Configures the system to act as a [[rednet (API)|rednet]] repeater.
|1.6
|odd}}
</div>

<div id="cmd-rename">
{{API table/row
|[[rename]]<br><tt>rename <old-name> <new-name></tt>
|Renames a file or directory.
|1.2
|}}
</div>

<div id="cmd-rm">
{{API table/row
|[[rm]]<br><tt>rm <path></tt>
|Deletes the specified file (in the same manner as [[delete]]).
|
|odd}}
</div>

<div id="cmd-set">
{{API table/row
|[[set]]<br><tt>set <env variable> <value></tt>
|Changes system settings.
|1.77
|}}
</div>

<div id="cmd-shell">
{{API table/row
|[[shell]]<br><tt>shell, shell <program> <arguments></tt>
|Opens another shell session. Runs a program if specified.
|
|odd}}
</div>

<div id="cmd-shutdown">
{{API table/row
|[[shutdown]]<br><tt>shutdown</tt>
|Powers off the Computer.
|
|}}
</div>

<div id="cmd-time">
{{API table/row
|[[time]]<br><tt>time</tt>
|Returns the Minecraft time of day.
|1.2
|odd}}
</div>

<div id="cmd-type">
{{API table/row
|[[type]]<br><tt>type <path></tt>
|Returns the type of the object or file at the specified path.
|
|}}
</div>

<div id="cmd-wget">
{{API table/row
|[[wget]]<br><tt>wget <url> <filename></tt>
|Fetches the content at the specified web address and saves it to the specified file.
|1.77
|odd}}
</div>

</table><br><br>

== Turtle-specific Commands ==

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Additional TurtleOS Shell Programs
</td></tr>
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Program Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Version Added</td></tr>

<div id="cmd-craft">
{{API table/row
|[[craft]]<br><tt>craft</tt>
|The turtle will, if it is able, craft an item from the contents of its inventory.
|1.4
|odd}}
</div>

<div id="cmd-dance">
{{API table/row
|[[dance]]<br><tt>dance</tt>
|Initiates "get down" procedure.
|1.3
|}}
</div>

<div id="cmd-equip">
{{API table/row
|[[equip]]<br><tt>equip <side></tt>
|The turtle will attempt to place a tool on its specified side.
|1.6
|odd}}
</div>

<div id="cmd-excavate">
{{API table/row
|[[excavate]]<br><tt>excavate <width></tt>
|Digs a square-shaped quarry to bedrock, of width equal to that specified.
|1.3
|}}
</div>

<div id="cmd-go">
{{API table/row
|[[go]]<br><tt>go <?></tt>
|Moves the turtle.
|1.3
|odd}}
</div>

<div id="cmd-refuel">
{{API table/row
|[[refuel]]<br><tt>refuel <amount></tt>
|Attempts to replenish the turtle's [[fuel]] supply with items from its inventory.
|1.4
|}}
</div>

<div id="cmd-tunnel">
{{API table/row
|[[tunnel]]<br><tt>tunnel <width></tt>
|Digs a horizontal tunnel leading off in the direction the turtle is facing.
|1.3
|odd}}
</div>

<div id="cmd-turn">
{{API table/row
|[[turn]]<br><tt>turn <?></tt>
|Causes the turtle to rotate.
|1.3
|}}
</div>

<div id="cmd-unequip">
{{API table/row
|[[unequip]]<br><tt>unequip<width></tt>
|Attempts to remove a tool from the turtle's specified side.
|1.6
|odd}}
</div>

</table><br><br>

== Command Computer-specific Commands ==

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Additional Command Computer Programs
</td></tr>
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Program Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Version Added</td></tr>

<div id="cmd-commands">
{{API table/row
|[[commands]]<br><tt>commands</tt>
|Lists all commands available to the [[Command Computer]] under the current version of Minecraft.
|1.7
|odd}}
</div>

<div id="cmd-exec">
{{API table/row
|[[exec]]<br><tt>exec <command></tt>
|Executes the specified [http://minecraft.gamepedia.com/Commands operator command] as if through a Command Block.
|1.7
|}}
</div>

</table><br><br>

== Removed Commands ==

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Removed Commands
</td></tr>
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Program Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Version Removed</td></tr>

<div id="cmd-redprobe">
{{API table/row
|[[redprobe]]<br><tt>redprobe</tt>
|List redstone stats.
|1.6
|odd}}
</div>

<div id="cmd-redpulse">
{{API table/row
|[[redpulse]]<br><tt>redpulse</tt>
|Redstone output pulse tool. Use <tt>redpulse</tt> for help.
|1.6
|}}
</div>

<div id="cmd-redset">
{{API table/row
|[[redset]]<br><tt>redset</tt>
|Redstone output set tool. Use <tt>redset</tt> for help.
|1.6
|odd}}
</div>

</table><br><br>

== See Also ==
* [[Built In Turtle Programs]]

[[Category:Programs]][[Category:Lists]][[Category:Tutorials]]

Settings (API)

2016-06-10T03:38:30Z

Bomb Bloke: .settings

{{lowercase}}
The '''settings API''' allows to store values and save them to a file for persistent configurations for your and CraftOS programs. The default file for saving settings is <var>.settings</var> sitting in the root of the computer. Settings can also be changed and added to all computers through [[ComputerCraft.cfg]]'s <var>S:default_computer_settings</var> value. It became available as of ComputerCraft 1.78, the first build for Minecraft 1.8.9.

{{API table|settings|image=Grid_disk.png|2=

{{API table/row
|[[settings.set]]({{type|string}} name, {{type|any}} value)
|{{type|nil}}
|Sets the setting <var>name</var> to <var>value</var>.
|odd}}

{{API table/row
|[[settings.get]]({{type|string}} name [, {{type|any}} default])
|{{type|any}} value
|Returns the setting's <var>name</var> value, or <var>default</var> if the setting does not exist.}}

{{API table/row
|[[settings.unset]]({{type|string}} name)
|{{type|nil}}
|Removes the setting <var>name</var>.
|odd}}

{{API table/row
|[[settings.clear]]()
|{{type|nil}}
|Removes all settings.}}

{{API table/row
|[[settings.getNames]]()
|{{type|table}} settingNames
|Returns a numerically-indexed table of all the setting's names.
|odd}}

{{API table/row
|[[settings.load]]({{type|string}} path)
|{{type|boolean}} loaded
|Loads settings from a file.}}

{{API table/row
|[[settings.save]]({{type|string}} path)
|{{type|boolean}} saved
|Saves current settings to a file.
|odd}}

}}

[[Category:APIs]]

==Notes==
* Settings are '''not''' automatically saved to a file, you have to do this [[settings.save|manually]].
* Setting's names can only be of type {{type|string}}.
* Setting's values can only be [[textutils.serialize|serializable]] types: {{type|string}}, {{type|number}}, {{type|boolean}} or {{type|table}}.

==Default Settings==
These are the default settings of a computer (as seen in CC 1.77 and later):

<pre>
{
[ "bios.use_multishell" ] = true,
[ "shell.autocomplete" ] = true,
[ "shell.allow_disk_startup" ] = true --# (for all Computer types except Command Computers),
[ "shell.allow_startup" ] = true,
[ "lua.autocomplete" ] = true,
[ "list.show_hidden" ] = false,
[ "edit.autocomplete" ] = true,
}
</pre>

*'''<var>shell.autocomplete</var>''' - enables auto-completion in the [[Shell]].
*'''<var>lua.autocomplete</var>''' - enables auto-completion in the [[Lua]] program.
*'''<var>edit.autocomplete</var>''' - enables auto-completion in the [[Edit]] program.
*'''<var>bios.use_multishell</var>''' - enables [[Multishell]] on [[Advanced Computer]]s, [[Advanced Turtle|Turtles]], [[Advanced Pocket Computer|Pocket Computers]] and [[Command Computer]]s.
*'''<var>shell.allow_disk_startup</var>''' - if a [[Disk Drive]] with a [[Disk]] inside that has a 'startup' script is attached to a computer, this setting allows to automatically run that script when the computer starts.
*'''<var>shell.allow_startup</var>''' - if there is a 'startup' script in a computer's root, this setting allow to automatically run that script when the computer runs.
*'''<var>list.show_hidden</var>''' - determines, whether the [[List]] program will list hidden files or not.

==.settings==
If a file titled ".settings" is [[settings.save|saved]] to the root of a given computer's drive, it will be automatically [[settings.load|loaded]] after the default settings on boot (note "after", as opposed to "instead of").

For example, if the file simply contains:

<pre>
{
[ "bios.use_multishell" ] = false
}
</pre>

... then all regular defaults will apply except for the use of [[multishell]], which will be disabled.

==ComputerCraft.cfg==
You can change or add default settings for all computers through [[ComputerCraft.cfg]]. The format is as follows:
* each setting is separated by a comma (<var>,</var>)
* setting's name and value is separated by an equals sign (<var>=</var>)

This example will disable auto-completion features in the default programs.
<pre>
S:default_computer_settings=shell.autocomplete=false,lua.autocomplete=false,edit.autocomplete=false
</pre>

Settings.set

2016-06-10T03:31:08Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=settings.set |args={{type|string}} name, {{type|any}} value |api=settings |addon=ComputerCraft |desc=Sets the specified setting to the specified..."

{{lowercase}}
{{Function
|name=settings.set
|args={{type|string}} name, {{type|any}} value
|api=settings
|addon=ComputerCraft
|desc=Sets the specified setting to the specified value. Values may be in the form of strings, numbers, booleans, or [[textutils.serialize|serialisable]] tables.

Settings apply until the next reboot, at which time the [[Settings_(API)#Default_Settings|defaults]] are reloaded. If you wish your custom settings to persist, either [[settings.save|save]] them to a file and [[settings.load|reload]] them on startup, or save them to ".settings" specifically if you wish them to be automatically reloaded.

Settings may not be cleared by use of settings.set(); for eg, settings.set("shell.autocomplete", nil) is invalid. Instead use [[settings.unset]]() for this purpose.
|examples=
{{Example
|desc=Disables use of startup files from floppies on subsequent reboots by saving a new default settings file.
|code= settings.set("shell.allow_disk_startup", false)
[[settings.save]](".settings")
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.get

2016-06-10T03:22:04Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=settings.get |args={{type|string}} name [, {{type|any}} default] |returns={{type|any}} value |api=settings |addon=ComputerCraft |desc=Returns th..."

{{lowercase}}
{{Function
|name=settings.get
|args={{type|string}} name [, {{type|any}} default]
|returns={{type|any}} value
|api=settings
|addon=ComputerCraft
|desc=Returns the value of a given setting, or if the setting doesn't exist and a "default" is specified, returns the specified default instead.
|examples=
{{Example
|desc=Indicates whether the system is currently configured to boot from disk.
|code= local bootFromDisk = settings.get("shell.allow_disk_startup", "not set")

print("Ability to boot from disk is currently " .. tostring( bootFromDisk ) )
|output=Either states "true", "false", or "not set".
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.clear

2016-06-10T03:14:14Z

Bomb Bloke: Extra link.

{{lowercase}}
{{Function
|name=settings.clear
|args=
|api=settings
|addon=ComputerCraft
|desc=Simply wipes all currently loaded settings. Compare [[settings.unset]](), which wipes one setting at a time.<br><br>

Note that when the system reboots, first the [[Settings_(API)#Default_Settings|default settings]] will be reloaded, and then (if it exists on the root of the drive) the ".settings" file will also be reloaded. Saving an empty ".settings" file will not in any way affect the loaded defaults - if you want all default settings completely cleared on boot, then settings.clear() must be called on startup.
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.load

2016-06-10T03:14:09Z

Bomb Bloke: Code fix.

{{lowercase}}
{{Function
|name=settings.load
|args={{Type|string}} path
|returns={{Type|boolean}} success
|api=settings
|addon=ComputerCraft
|desc=Loads settings from the specified file. Any settings that've already been loaded (eg [[Settings_(API)#Default_Settings|the defaults]]) will not be affected unless the target file contains entries with the same names.<br><br>

If a file titled ".settings" is [[settings.save|saved]] to the root of a computer's drive, it will be automatically loaded on startup after the default settings (without need to call this function manually).
|examples=
{{Example
|desc=Loads all settings specified within the file "mySettings", displaying before / after lists.
|code=print("Initial loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )

settings.load("mySettings")

print("\nResulting loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.unset

2016-06-10T03:13:37Z

Bomb Bloke:

{{lowercase}}
{{Function
|name=settings.unset
|args={{Type|string}} setting
|api=settings
|addon=ComputerCraft
|desc=Removes a setting from the currently loaded set. If you wish to unload all settings, refer to [[settings.clear]]().<br><br>

Note that when the system reboots, first the [[Settings_(API)#Default_Settings|default settings]] will be reloaded, and then (if it exists on the root of the drive) the ".settings" file will also be reloaded. Saving an empty ".settings" file will not in any way affect the loaded defaults - if you want a particular default setting completely cleared on boot, then settings.unset(''setting'') must be called on startup.
|examples=
{{Example
|desc=Randomly unsets a setting.
|code= local curSettings = [[settings.getNames]]()

print("Initial loaded settings:\n")
[[textutils.pagedTabulate]]( curSettings )

if #curSettings > 0 then settings.unset( curSettings[ math.random( #curSettings ) ] ) end

print("\nResulting loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.unset

2016-06-10T03:10:04Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=settings.unset |args={{Type|string}} setting |api=settings |addon=ComputerCraft |desc=Removes a setting from the currently loaded set. If you wi..."

Settings.clear

2016-06-10T03:02:09Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=settings.clear |args= |api=settings |addon=ComputerCraft |desc=Simply wipes all currently loaded settings.<br><br> Note that when the system re..."

{{lowercase}}
{{Function
|name=settings.clear
|args=
|api=settings
|addon=ComputerCraft
|desc=Simply wipes all currently loaded settings.<br><br>

Note that when the system reboots, first the [[Settings_(API)#Default_Settings|default settings]] will be reloaded, and then (if it exists on the root of the drive) the ".settings" file will also be reloaded. Saving an empty ".settings" file will not in any way affect the loaded defaults - if you want all settings cleared on boot, then settings.clear() must be called on startup.
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.load

2016-06-10T02:56:37Z

Bomb Bloke: .settings is loaded "in addition to" the defaults, as opposed to "instead of"

{{lowercase}}
{{Function
|name=settings.load
|args={{Type|string}} path
|returns={{Type|boolean}} success
|api=settings
|addon=ComputerCraft
|desc=Loads settings from the specified file. Any settings that've already been loaded (eg [[Settings_(API)#Default_Settings|the defaults]]) will not be affected unless the target file contains entries with the same names.<br><br>

If a file titled ".settings" is [[settings.save|saved]] to the root of a computer's drive, it will be automatically loaded on startup after the default settings (without need to call this function manually).
|examples=
{{Example
|desc=Loads all settings specified within the file "mySettings", displaying before / after lists.
|code=print("Initial loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )

settings.load("mySettings")

print("Resulting loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.getNames

2016-06-10T02:46:45Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=settings.getNames |args= |returns={{Type|table}} setting names |api=settings |addon=ComputerCraft |desc=Returns a numerically indexed table cont..."

{{lowercase}}
{{Function
|name=settings.getNames
|args=
|returns={{Type|table}} setting names
|api=settings
|addon=ComputerCraft
|desc=Returns a numerically indexed table containing all currently loaded setting names.
|examples=
{{Example
|desc=Prints all current settings alongside their values.
|code= local curSettings = settings.getNames()

for i = 1, #curSettings do
[[textutils.pagedPrint]]( curSettings[i] .. ": " .. tostring( [[settings.get]]( curSettings[i] ) ) )
end
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.save

2016-06-10T02:37:35Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=settings.save |args={{Type|string}} path |returns={{Type|boolean}} success |api=settings |addon=ComputerCraft |desc=Saves all current settings -..."

{{lowercase}}
{{Function
|name=settings.save
|args={{Type|string}} path
|returns={{Type|boolean}} success
|api=settings
|addon=ComputerCraft
|desc=Saves all current settings - including those loaded as [[Settings_(API)#Default_Settings|defaults]] - to the specified file, as a serialised table.<br><br>

If a file titled ".settings" is saved to the root of a computer's drive, it will be automatically loaded on startup (without need to call [[settings.load|settings.load()]]).
|examples=
{{Example
|desc=Disables use of startup files from floppies on subsequent reboots by saving a new default settings file.
|code= [[settings.set]]("shell.allow_disk_startup", false)
settings.save(".settings")
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.load

2016-06-10T02:37:18Z

Bomb Bloke: Type templates

{{lowercase}}
{{Function
|name=settings.load
|args={{Type|string}} path
|returns={{Type|boolean}} success
|api=settings
|addon=ComputerCraft
|desc=Loads settings from the specified file. Any settings that've already been loaded (eg [[Settings_(API)#Default_Settings|the defaults]]) will not be affected unless the target file contains entries with the same names.<br><br>

If a file titled ".settings" is [[settings.save|saved]] to the root of a computer's drive, it will be automatically loaded on startup (without need to call this function manually).
|examples=
{{Example
|desc=Loads all settings specified within the file "mySettings", displaying before / after lists.
|code=print("Initial loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )

settings.load("mySettings")

print("Resulting loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Settings.load

2016-06-10T02:30:05Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=settings.load |args=string path |returns=boolean success |api=settings |addon=ComputerCraft |desc=Loads settings from the..."

{{lowercase}}
{{Function
|name=settings.load
|args=[[string]] path
|returns=[[boolean_(type)|boolean]] success
|api=settings
|addon=ComputerCraft
|desc=Loads settings from the specified file. Any settings that've already been loaded (eg [[Settings_(API)#Default_Settings|the defaults]]) will not be affected unless the target file contains entries with the same names.<br><br>

If a file titled ".settings" is [[settings.save|saved]] to the root of a computer's drive, it will be automatically loaded on startup (without need to call this function manually).
|examples=
{{Example
|desc=Loads all settings specified within the file "mySettings", displaying before / after lists.
|code=print("Initial loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )

settings.load("mySettings")

print("Resulting loaded settings:\n")
[[textutils.pagedTabulate]]( [[settings.getNames]]() )
}}
}}

{{SettingsAPIFunctions}}

[[Category:API_Functions]]

Template:SettingsAPIFunctions

2016-06-10T02:16:31Z

Bomb Bloke: Created page with "<center> {| class="wikitable" ! style="background: #D3FFC2; text-align: center" | 18px Settings API Functions |- |settings.set -..."

<center>
{| class="wikitable"
! style="background: #D3FFC2; text-align: center" | [[File:Grid_disk.png|18px]] [[Settings_(API)|Settings API]] Functions
|-
|[[settings.set]] - [[settings.get]] - [[settings.unset]] - [[settings.clear]] - [[settings.getNames]] - [[settings.load]] - [[settings.save]]
|}
</center>

Turtle.dig

2016-06-10T02:07:32Z

Bomb Bloke: Undo revision 7419 by Dan200 (talk) Reverted without comment? Appears to've been a mistake.

{{lowercase}}
{{Function
|name=turtle.dig
|args=
|api=turtle
|returns={{Type|boolean}} whether the turtle succeeded in digging, {{type|string}} error message
|addon=ComputerCraft
|desc=Attempts to dig the block in front of the turtle. If successful, [[Turtle.suck|suck()]] is automatically called, placing the item in turtle inventory in the selected slot if possible (block type matches and the slot is not a full stack yet), or in the next available slot.<br><br>

If a hoe is used to attempt to "dig" a dirt block, it will be tilled instead. Tilling is also possible if the space in front of the turtle is empty but dirt exists below that point.
|examples=
{{Example
|desc=Digs the block in front of the turtle.
|code=[[print]](turtle.dig())
|output=true if the turtle could dig the block, false if it could not or no block present.
}}
{{Example
|desc=Digs the block in front of the turtle, but only if there is a block to dig (saves time).
|code=if [[turtle.detect]]() then
turtle.dig()
end
|output=the turtle digs if there is a block in front.
}}
}}

==See also==
*[[turtle.digUp]]
*[[turtle.digDown]]

[[Category:Lua_Core_Functions]]

Turtle.digDown

2016-06-09T11:44:44Z

Bomb Bloke: Tilling specifics.

{{lowercase}}
{{Function
|name=turtle.digDown
|args=
|api=turtle
|returns={{Type|boolean}} whether the turtle succeeded in digging, {{type|string}} error message
|addon=ComputerCraft
|desc=Attempts to dig the block below the turtle. If successful, [[Turtle.suck|suck()]] is automatically called, placing the item in turtle inventory in the selected slot if possible (block type matches and the slot is not a full stack yet), or in the next available slot.<br><br>

When using a hoe, if the space beneath the turtle consists of air and the space beneath ''that'' is dirt, then the turtle may till that dirt by use of this function.
|examples=
{{Example
|desc=Attempts to dig the block below the turtle.
|code=print(turtle.digDown())
|output=true if the turtle could dig the block, false if it could not or no block present.
}}
}}

==See also==
*[[turtle.dig]]
*[[turtle.digUp]]

[[Category:Lua_Core_Functions]]

Turtle.dig

2016-06-09T11:41:38Z

Bomb Bloke: Tilling specifics.

Turtle (API)

2016-06-09T11:37:47Z

Bomb Bloke: Tilling specifics.

The Turtle API is used to work with your [[Turtle|Turtles]].

===Key===
{| class="wikitable"
! Color !! Turtles that can perform this
|-
| White ||All
|-{{row-lightgreen}}
|Green || Crafty
|-{{row-lightyellow}}
| Yellow || Mining, Felling, Digging, Farming
|-{{row-lightred}}
| Red || Any tool
|}


===API===
{| class="wikitable"
! width="100px" | Return
! width="200px" | Method name
! Description
! Min version
|-{{row-lightgreen}}
|{{type|boolean}} success
|[[turtle.craft]]({{type|number}} quantity)
|Craft items using ingredients anywhere in the turtle's inventory and place results in the active slot. If a quantity is specified, it will craft only up to that many items, otherwise, it will craft as many of the items as possible.
|1.4
|-
|{{type|boolean}} success
|[[turtle.forward]]()
|Try to move the turtle forward
|?
|-
|{{type|boolean}} success
|[[turtle.back]]()
|Try to move the turtle backward
|?
|-
|{{type|boolean}} success
|[[turtle.up]]()
|Try to move the turtle up
|?
|-
|{{type|boolean}} success
|[[turtle.down]]()
|Try to move the turtle down
|?
|-
|{{type|boolean}} success
|[[turtle.turnLeft]]()
|Turn the turtle left
|?
|-
|{{type|boolean}} success
|[[turtle.turnRight]]()
|Turn the turtle right
|?
|-
|{{type|boolean}} success
|[[turtle.select]]({{type|number}} slotNum)
|Make the turtle select slot <var>slotNum</var> (1 is top left, 16 (9 in 1.33 and earlier) is bottom right)
|?
|-
|{{type|number}} slot
|[[turtle.getSelectedSlot]]()
|Indicates the currently selected inventory slot
| 1.6
|-
|{{type|number}} count
|[[turtle.getItemCount]]([<nowiki/>{{type|number}} slotNum])
|Counts how many items are in the currently selected slot or, if specified, <var>slotNum</var> slot
|?
|-
|{{type|number}} count
|[[turtle.getItemSpace]]([<nowiki/>{{type|number}} slotNum])
|Counts how many remaining items you need to fill the stack in the currently selected slot or, if specified, <var>slotNum</var> slot
|?
|-
|{{type|table}} data
|[[turtle.getItemDetail]]([<nowiki/>{{type|number}} slotNum])
|Returns the ID string, count and damage values of currently selected slot or, if specified, <var>slotNum</var> slot
|1.64
|-
|{{type|boolean}} success
|[[turtle.equipLeft]]()
|Attempts to equip an item in the current slot to the turtle's left side, switching the previously equipped item back into the inventory
|1.6
|-
|{{type|boolean}} success
|[[turtle.equipRight]]()
|Attempts to equip an item in the current slot to the turtle's right side, switching the previously equipped item back into the inventory
|1.6
|-{{row-lightred}}
|{{type|boolean}} success
|[[turtle.attack]]()
|Attacks in front of the turtle.
| 1.4
|-{{row-lightred}}
|{{type|boolean}} success
|[[turtle.attackUp]]()
|Attacks above the turtle.
| 1.4
|-{{row-lightred}}
|{{type|boolean}} success
|[[turtle.attackDown]]()
|Attacks under the turtle.
| 1.4
|-{{row-lightyellow}}
|{{type|boolean}} success
|[[turtle.dig]]()
|Breaks the block in front. With hoe: tills the dirt in front of it.
|?
|-{{row-lightyellow}}
|{{type|boolean}} success
|[[turtle.digUp]]()
|Breaks the block above.
|?
|-{{row-lightyellow}}
|{{type|boolean}} success
|[[turtle.digDown]]()
|Breaks the block below. With hoe: tills the dirt beneath the space below it.
|?
|-
|{{type|boolean}} success
|[[turtle.place]]([<nowiki></nowiki>{{type|string}} signText])
|Places a block of the selected slot in front. Engrave <var>signText</var> on signs if provided. Collects [[water]] or [[lava]] if the currently selected slot is an empty bucket.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.placeUp]]()
|Places a block of the selected slot above. Collects water or lava if the currently selected slot is an empty bucket.
|?
|-
|{{type|boolean}} success
|[[turtle.placeDown]]()
|Places a block of the selected slot below. Collects water or lava if the currently selected slot is an empty bucket.
|?
|-
|{{type|boolean}} result
|[[turtle.detect]]()
|Detects if there is a block in front. Does not detect mobs.
|?
|-
|{{type|boolean}} result
|[[turtle.detectUp]]()
|Detects if there is a block above
|?
|-
|{{type|boolean}} result
|[[turtle.detectDown]]()
|Detects if there is a block below
|?
|-
|{{type|boolean}} success, {{type|table}} data/{{type|string}} error message
|[[turtle.inspect]]()
|Returns the ID string and metadata of the block in front of the Turtle
|1.64
|-
|{{type|boolean}} success, {{type|table}} data/{{type|string}} error message
|[[turtle.inspectUp]]()
|Returns the ID string and metadata of the block above the Turtle
|1.64
|-
|{{type|boolean}} success, {{type|table}} data/{{type|string}} error message
|[[turtle.inspectDown]]()
|Returns the ID string and metadata of the block below the Turtle
|1.64
|-
|{{type|boolean}} result
|[[turtle.compare]]()
|Detects if the block in front is the same as the one in the currently selected slot
|1.31
|-
|{{type|boolean}} result
|[[turtle.compareUp]]()
|Detects if the block above is the same as the one in the currently selected slot
|?
|-
|{{type|boolean}} result
|[[turtle.compareDown]]()
|Detects if the block below is the same as the one in the currently selected slot
|?
|-
|{{type|boolean}} result
|[[turtle.compareTo]]({{type|number}} slot)
|Compare the current selected slot and the given slot to see if the items are the same. Returns true if they are the same, false if not.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.drop]]([<nowiki></nowiki>{{type|number}} count])
|Drops all items in the selected slot, or specified, drops <var>count</var> items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e in front of the turtle) it will try to place into the inventory, returning false if the inventory is full.
|?
|-
|{{type|boolean}} success
|[[turtle.dropUp]]([<nowiki></nowiki>{{type|number}} count])
|Drops all items in the selected slot, or specified, drops <var>count</var> items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e above the turtle) it will try to place into the inventory, returning false if the inventory is full.
|1.4
|-
|{{type|boolean}} success
|[[turtle.dropDown]]([<nowiki></nowiki>{{type|number}} count])
|Drops all items in the selected slot, or specified, drops <var>count</var> items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e below the turtle) it will try to place into the inventory, returning false if the inventory is full. If above a furnace, will place item in the top slot.
|1.4
|-
|{{type|boolean}} success
|[[turtle.suck]]([<nowiki></nowiki>{{type|number}} amount])
|Picks up an item stack of any number, from the ground or an inventory in front of the turtle, then places it in the selected slot. If the turtle can't pick up the item, the function returns false. <var>amount</var> parameter requires ComputerCraft 1.6 or later.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.suckUp]]([<nowiki></nowiki>{{type|number}} amount])
|Picks up an item stack of any number, from the ground or an inventory above the turtle, then places it in the selected slot. If the turtle can't pick up the item, the function returns false. <var>amount</var> parameter requires ComputerCraft 1.6 or later.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.suckDown]]([<nowiki></nowiki>{{type|number}} amount])
|Picks up an item stack of any number, from the ground or an inventory below the turtle, then places it in the selected slot. If the turtle can't pick up the item, the function returns false. <var>amount</var> parameter requires ComputerCraft 1.6 or later.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.refuel]]([<nowiki></nowiki>{{type|number}} quantity])
|If the current selected slot contains a fuel item, it will consume it to give the turtle the ability to move.<br />Added in 1.4 and is only needed in needfuel mode. If the current slot doesn't contain a fuel item, it returns false. Fuel values for different items can be found at [[Turtle.refuel#Fuel_Values]]. If a quantity is specified, it will refuel only up to that many items, otherwise, it will consume all the items in the slot.
| 1.4
|-
|{{type|number}} fuel
|[[turtle.getFuelLevel]]()
|Returns the current fuel level of the turtle, this is the number of blocks the turtle can move.<br />If <var>turtleNeedFuel = 0</var> then it returns <var>"unlimited"</var>.
| 1.4
|-
|{{type|number}} fuel
|[[turtle.getFuelLimit]]()
|Returns the maximum amount of fuel a turtle can store - by default, 20,000 for regular turtles, 100,000 for advanced.<br />If <var>turtleNeedFuel = 0</var> then it returns <var>"unlimited"</var>.
| 1.6
|-
|{{type|boolean}} success
|[[turtle.transferTo]]({{type|number}} slot [, {{type|number}} quantity])
|Transfers <var>quantity</var> items from the selected slot to <var>slot</var>. If <var>quantity</var> isn't specified, will attempt to transfer everything in the selected slot to <var>slot</var>.
| 1.45
|}
[[Category:APIs]]

Turtle (API)

2016-06-09T11:28:56Z

Bomb Bloke: dropUp/dropDown pages now exist.

The Turtle API is used to work with your [[Turtle|Turtles]].

===Key===
{| class="wikitable"
! Color !! Turtles that can perform this
|-
| White ||All
|-{{row-lightgreen}}
|Green || Crafty
|-{{row-lightyellow}}
| Yellow || Mining, Felling, Digging, Farming
|-{{row-lightred}}
| Red || Any tool
|}


===API===
{| class="wikitable"
! width="100px" | Return
! width="200px" | Method name
! Description
! Min version
|-{{row-lightgreen}}
|{{type|boolean}} success
|[[turtle.craft]]({{type|number}} quantity)
|Craft items using ingredients anywhere in the turtle's inventory and place results in the active slot. If a quantity is specified, it will craft only up to that many items, otherwise, it will craft as many of the items as possible.
|1.4
|-
|{{type|boolean}} success
|[[turtle.forward]]()
|Try to move the turtle forward
|?
|-
|{{type|boolean}} success
|[[turtle.back]]()
|Try to move the turtle backward
|?
|-
|{{type|boolean}} success
|[[turtle.up]]()
|Try to move the turtle up
|?
|-
|{{type|boolean}} success
|[[turtle.down]]()
|Try to move the turtle down
|?
|-
|{{type|boolean}} success
|[[turtle.turnLeft]]()
|Turn the turtle left
|?
|-
|{{type|boolean}} success
|[[turtle.turnRight]]()
|Turn the turtle right
|?
|-
|{{type|boolean}} success
|[[turtle.select]]({{type|number}} slotNum)
|Make the turtle select slot <var>slotNum</var> (1 is top left, 16 (9 in 1.33 and earlier) is bottom right)
|?
|-
|{{type|number}} slot
|[[turtle.getSelectedSlot]]()
|Indicates the currently selected inventory slot
| 1.6
|-
|{{type|number}} count
|[[turtle.getItemCount]]([<nowiki/>{{type|number}} slotNum])
|Counts how many items are in the currently selected slot or, if specified, <var>slotNum</var> slot
|?
|-
|{{type|number}} count
|[[turtle.getItemSpace]]([<nowiki/>{{type|number}} slotNum])
|Counts how many remaining items you need to fill the stack in the currently selected slot or, if specified, <var>slotNum</var> slot
|?
|-
|{{type|table}} data
|[[turtle.getItemDetail]]([<nowiki/>{{type|number}} slotNum])
|Returns the ID string, count and damage values of currently selected slot or, if specified, <var>slotNum</var> slot
|1.64
|-
|{{type|boolean}} success
|[[turtle.equipLeft]]()
|Attempts to equip an item in the current slot to the turtle's left side, switching the previously equipped item back into the inventory
|1.6
|-
|{{type|boolean}} success
|[[turtle.equipRight]]()
|Attempts to equip an item in the current slot to the turtle's right side, switching the previously equipped item back into the inventory
|1.6
|-{{row-lightred}}
|{{type|boolean}} success
|[[turtle.attack]]()
|Attacks in front of the turtle.
| 1.4
|-{{row-lightred}}
|{{type|boolean}} success
|[[turtle.attackUp]]()
|Attacks above the turtle.
| 1.4
|-{{row-lightred}}
|{{type|boolean}} success
|[[turtle.attackDown]]()
|Attacks under the turtle.
| 1.4
|-{{row-lightyellow}}
|{{type|boolean}} success
|[[turtle.dig]]()
|Breaks the block in front. With hoe: tills the dirt in front of it.
|?
|-{{row-lightyellow}}
|{{type|boolean}} success
|[[turtle.digUp]]()
|Breaks the block above. With hoe: tills the dirt above it.
|?
|-{{row-lightyellow}}
|{{type|boolean}} success
|[[turtle.digDown]]()
|Breaks the block below. With hoe: tills the dirt below it.
|?
|-
|{{type|boolean}} success
|[[turtle.place]]([<nowiki></nowiki>{{type|string}} signText])
|Places a block of the selected slot in front. Engrave <var>signText</var> on signs if provided. Collects [[water]] or [[lava]] if the currently selected slot is an empty bucket.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.placeUp]]()
|Places a block of the selected slot above. Collects water or lava if the currently selected slot is an empty bucket.
|?
|-
|{{type|boolean}} success
|[[turtle.placeDown]]()
|Places a block of the selected slot below. Collects water or lava if the currently selected slot is an empty bucket.
|?
|-
|{{type|boolean}} result
|[[turtle.detect]]()
|Detects if there is a block in front. Does not detect mobs.
|?
|-
|{{type|boolean}} result
|[[turtle.detectUp]]()
|Detects if there is a block above
|?
|-
|{{type|boolean}} result
|[[turtle.detectDown]]()
|Detects if there is a block below
|?
|-
|{{type|boolean}} success, {{type|table}} data/{{type|string}} error message
|[[turtle.inspect]]()
|Returns the ID string and metadata of the block in front of the Turtle
|1.64
|-
|{{type|boolean}} success, {{type|table}} data/{{type|string}} error message
|[[turtle.inspectUp]]()
|Returns the ID string and metadata of the block above the Turtle
|1.64
|-
|{{type|boolean}} success, {{type|table}} data/{{type|string}} error message
|[[turtle.inspectDown]]()
|Returns the ID string and metadata of the block below the Turtle
|1.64
|-
|{{type|boolean}} result
|[[turtle.compare]]()
|Detects if the block in front is the same as the one in the currently selected slot
|1.31
|-
|{{type|boolean}} result
|[[turtle.compareUp]]()
|Detects if the block above is the same as the one in the currently selected slot
|?
|-
|{{type|boolean}} result
|[[turtle.compareDown]]()
|Detects if the block below is the same as the one in the currently selected slot
|?
|-
|{{type|boolean}} result
|[[turtle.compareTo]]({{type|number}} slot)
|Compare the current selected slot and the given slot to see if the items are the same. Returns true if they are the same, false if not.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.drop]]([<nowiki></nowiki>{{type|number}} count])
|Drops all items in the selected slot, or specified, drops <var>count</var> items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e in front of the turtle) it will try to place into the inventory, returning false if the inventory is full.
|?
|-
|{{type|boolean}} success
|[[turtle.dropUp]]([<nowiki></nowiki>{{type|number}} count])
|Drops all items in the selected slot, or specified, drops <var>count</var> items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e above the turtle) it will try to place into the inventory, returning false if the inventory is full.
|1.4
|-
|{{type|boolean}} success
|[[turtle.dropDown]]([<nowiki></nowiki>{{type|number}} count])
|Drops all items in the selected slot, or specified, drops <var>count</var> items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e below the turtle) it will try to place into the inventory, returning false if the inventory is full. If above a furnace, will place item in the top slot.
|1.4
|-
|{{type|boolean}} success
|[[turtle.suck]]([<nowiki></nowiki>{{type|number}} amount])
|Picks up an item stack of any number, from the ground or an inventory in front of the turtle, then places it in the selected slot. If the turtle can't pick up the item, the function returns false. <var>amount</var> parameter requires ComputerCraft 1.6 or later.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.suckUp]]([<nowiki></nowiki>{{type|number}} amount])
|Picks up an item stack of any number, from the ground or an inventory above the turtle, then places it in the selected slot. If the turtle can't pick up the item, the function returns false. <var>amount</var> parameter requires ComputerCraft 1.6 or later.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.suckDown]]([<nowiki></nowiki>{{type|number}} amount])
|Picks up an item stack of any number, from the ground or an inventory below the turtle, then places it in the selected slot. If the turtle can't pick up the item, the function returns false. <var>amount</var> parameter requires ComputerCraft 1.6 or later.
| 1.4
|-
|{{type|boolean}} success
|[[turtle.refuel]]([<nowiki></nowiki>{{type|number}} quantity])
|If the current selected slot contains a fuel item, it will consume it to give the turtle the ability to move.<br />Added in 1.4 and is only needed in needfuel mode. If the current slot doesn't contain a fuel item, it returns false. Fuel values for different items can be found at [[Turtle.refuel#Fuel_Values]]. If a quantity is specified, it will refuel only up to that many items, otherwise, it will consume all the items in the slot.
| 1.4
|-
|{{type|number}} fuel
|[[turtle.getFuelLevel]]()
|Returns the current fuel level of the turtle, this is the number of blocks the turtle can move.<br />If <var>turtleNeedFuel = 0</var> then it returns <var>"unlimited"</var>.
| 1.4
|-
|{{type|number}} fuel
|[[turtle.getFuelLimit]]()
|Returns the maximum amount of fuel a turtle can store - by default, 20,000 for regular turtles, 100,000 for advanced.<br />If <var>turtleNeedFuel = 0</var> then it returns <var>"unlimited"</var>.
| 1.6
|-
|{{type|boolean}} success
|[[turtle.transferTo]]({{type|number}} slot [, {{type|number}} quantity])
|Transfers <var>quantity</var> items from the selected slot to <var>slot</var>. If <var>quantity</var> isn't specified, will attempt to transfer everything in the selected slot to <var>slot</var>.
| 1.45
|}
[[Category:APIs]]

Ender Modem

2016-01-21T06:42:55Z

Bomb Bloke: Unaffected by height or weather.

:''This page is for the Modem blocks. For the modem API, see [[Modem_(API)|Modem (API)]]''
{{Block
|name=Ender Modem
|image=EnderModem.png
|id=computercraft:advanced_modem
|damage-value=0
|is-peripheral=Yes
|peripheral-api=Modem (API)
}}
'''Ender Modems''' are advanced versions of the [[Wireless Modem]], introduced by ComputerCraft version 1.76 (for Minecraft 1.8). They use the same [[Modem_(API)|Modem API]], but are capable of cross-dimensional transmissions.

They have an extreme range, capable of functioning across distances of up to 2,147,483,647 blocks (2^31-1, unaffected by height or weather), and are compatible with regular Wireless Modem signals. If the modems are not located with the same dimension, however, then the "distance" parameter will be excluded from the resulting [[modem_message (event)|modem_message events]].

Whether or not communications between two modems are possible depends only on the range of the stronger of the two. This means, for example, that a single system running the [[Repeat]] script through an Ender Modem effectively opens up [[Rednet (API)|Rednet]] communications between regular Wireless Modems server-wide; while one Ender Modem-equipped [[Gps (API)|GPS cluster]] per dimension is sufficient to handle most all location requests.

See also: [[Wired Modem]], [[Wireless Modem]].

== Recipe ==
{{Crafting grid
|A1=Gold_Ingot |B1=Gold_Ingot |C1=Gold_Ingot
|A2=Gold_Ingot |B2=Eye_of_Ender |C2=Gold_Ingot
|A3=Gold_Ingot |B3=Gold_Ingot |C3=Gold_Ingot
|Output=Ender_Modem
}}

== Example (Modem API)==
* Place 2 computers and add modems to them by clicking the right mouse button while sneaking.
* Access them, and start Lua.
* Once Lua has started, wrap your modem using peripheral.wrap() (something like "modem = peripheral.wrap("<side of modem>")
* Type "[[modem_(API)|modem.open]] (<A modem port number, anything from 1 to 65535>)" on one computer.
* Check if there exists a connection: a dim, red light should be found on the modem.
* Now, type "[[modem_(API)|modem.transmit]] (<Same number as above>, <Also the same number>, 'Your message')" on the other computer. This should send your message to all computers connected.
* Opening the first computer should show the message written on the second computer.

==Modem as a Peripheral==
To use a Modem as a peripheral, you need to either call a method directly using [[peripheral.call]](), or, wrap the modem using the [[Peripheral_(API)|Peripheral API]]. Wrapped modems provide all functions listed in the [[Modem_(API)|Modem API]].

For this example, we have a Modem connected to the top of our [[Computer]], we are going to open channel 5:

''-- Immediately invoke a method without wrapping''
[[peripheral.call]]( "top", "open", 5 )

''-- You can also "wrap" the peripheral side to a variable:''
local modem = [[peripheral.wrap]]( "top" )
[[modem.open]]( 5 )

{{BlocksItemsList}}

Disk Drive

2016-01-16T02:04:50Z

Bomb Bloke: 1.77

{{Block
|name=Disk Drive
|image=Iso_DiskDrive.png
|id=ComputerCraft:CC-Peripheral
|damage-value=0
|is-peripheral=Yes
|peripheral-api=Disk (API)
}}
The Disk Drive arrived with the [[ComputerCraft]] 1.2 update and with that also came [[Floppy Disk]]s. The Disk Drive is an object that, when placed adjacently but not diagonally next to a [[computer]], does the same as a disk drive for real computers in the real world would do: they allow the access to portable data storage devices ([[Floppy Disk]]s). Since the [[ComputerCraft]] 1.6 update, both types of [[Pocket Computer]]s can also be inserted into disk drives, allowing access to their files. As of 1.77, all systems other than [[Command Computer]]s can be used as disks.
== Recipe ==
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=Redstone |C2=stone
|A3=stone |B3=Redstone |C3=stone
|Output=Disk_Drive
}}
== Usage ==
[[File:Computer_w_DiskDrive_w_Monitor.png|frame|428x241px|right|A 2x2 [[Monitor]], connected to a [[Computer]], with a [[Disk Drive]] connected.]]
[[File:DiskDriveGUI.png|thumb|350px|GUI of the Disk Drive]]
To use a disk drive, place it adjacently but not diagonally next to a computer (left, right, top, bottom, front, or back side). Insert a disk by right-clicking on the disk drive and placing the disk in the slot above the inventory. When a disk is inserted, a [[Disk (event)|disk]] event is fired, and when a disk is removed or ejected, a [[Disk eject (event)|disk_eject]] event is fired.

If you sneak and right click the disk drive with a disk/music disc in 1.4+ the disk will placed into the Disk Drive without needing to open the disk drives interface.

In [[ComputerCraft]] 1.6 and above, [[Pocket Computer]]s can also be inserted into a disk drive to browse their files. 1.77 and later allow all systems othat than [[Command Computer]]s.

==Renaming with Anvils==
In [[ComputerCraft]] 1.7 and above Disk Drives can be renamed using [http://minecraft.gamepedia.com/Anvil#Renaming Anvils].

== API ==
See [[Disk (API)]] for the disk API.

{{BlocksItemsList}}
[[Category:Blocks]]

Modem.isPresentRemote

2016-01-10T23:13:07Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=''modem''.isPresentRemote |args={{type|string}} peripheralName |returns={{type|boolean}} present |api=Modem |addon=ComputerCraft |desc=Tells you..."

{{lowercase}}
{{Function
|name=''modem''.isPresentRemote
|args={{type|string}} peripheralName
|returns={{type|boolean}} present
|api=Modem
|addon=ComputerCraft
|desc=Tells you whether a peripheral is currently connected to the [[Wired Modem]]. Note that [[peripheral.isPresent]]() can do the same for all peripherals attached to the computer, through modems or otherwise.
|examples=
{{Example
|desc=Outputs whether a peripheral is detected under the specified network name.
|code=local modem = [[peripheral.wrap]]("top") -- Or whichever side the modem is connected to.

print( modem.isPresentRemote( "printer_0" ) )
|output="true" if a peripheral called "printer_0" is connected to the modem, otherwise "false".
}}
}}

[[Category:API_Functions]]

Modem.getTypeRemote

2016-01-10T01:07:50Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=''modem''.getTypeRemote |args={{type|string}} peripheralName |returns={{type|string}} peripheralType |api=Modem |addon=ComputerCraft |desc=Retur..."

{{lowercase}}
{{Function
|name=''modem''.getTypeRemote
|args={{type|string}} peripheralName
|returns={{type|string}} peripheralType
|api=Modem
|addon=ComputerCraft
|desc=Returns the type of peripheral that's connected to the [[Wired Modem]], under the specified network name. Note that [[peripheral.getType]]() can do exactly the same thing for ALL peripherals which are attached to the system, through modems or otherwise.
|examples=
{{Example
|desc=Prints the type of the first peripheral detected through the modem.
|code=local modem = [[peripheral.wrap]]("left") -- Or whatever side the modem is connected to.

print( modem.getTypeRemote( [[modem.getNamesRemote]]()[1] or "none") )
|output=Either "[[computer]]", "[[Disk Drive|drive]]", "[[monitor]]", "[[printer]]", or nothing if nothing is connected.
}}
}}

[[Category:API_Functions]]

Modem.getNamesRemote

2016-01-09T14:12:16Z

Bomb Bloke: Created page with "{{Function |name=''modem''.getNamesRemote |returns={{type|table}} peripheralNames |api=Modem |addon=ComputerCraft |desc=Essentially the same as peripheral.getNames(), whic..."

{{Function
|name=''modem''.getNamesRemote
|returns={{type|table}} peripheralNames
|api=Modem
|addon=ComputerCraft
|desc=Essentially the same as [[peripheral.getNames]](), which returns a numerically-indexed table containing the names of all peripherals attached to the system; however, this function only returns peripherals which are specifically connected to the [[Wired Modem]] you called it through.
|examples=
{{Example
|desc=Prints a list of all peripherals attached to a modem, along with their type.
|code=local modem = [[peripheral.wrap]]("top") -- Or whatever side the modem is attached to.

local periList = modem.getNamesRemote()

for i = 1, #periList do
print("I have a "..[[peripheral.getType]](periList[i]).." attached as \""..periList[i].."\".")
end
|output=Depending on the peripherals available, along the lines of:<br>
<i>I have a monitor attached as "monitor_0".<br>
I have a printer attached as "printer_0".<br>
etc...</i>
}}
}}

[[Category:API_Functions]]

Modem (API)

2016-01-09T03:33:13Z

Bomb Bloke: Additional functions for wired modems.

:''This page is for the modem API. For the blocks, see [[Modem]].''
{{PeripheralAPI}}

Available to [[peripheral.wrap|wrapped]] [[Wireless Modem|Wireless]], [[Ender Modem|Ender]], or [[Wired Modem|Wired]] Modems.

Direct use of modems requires understanding of the "channels" system - these are essentially networks which can be [[modem.open|opened]], [[modem.close|closed]] and [[modem_message_(event)|listened]] on by any [[Computer]] within range, without need of independent computer IDs. To interact with channels, one must [[peripheral.wrap|wrap]] or otherwise interact directly with the peripheral. The [[Rednet_(API)|Rednet API]] acts as a wrapper for your modem's functionality, handling the channel system for you (basically by having each system listen on a channel equal to its ID number).

Functions in ''italics'' are only available to [[Wired Modem]]s, which are able to connect to remote peripherals and control them from afar.

{{API table|Modem|image=Grid disk.png|2=

{{API table/row
|[[modem.isOpen|''modem''.isOpen]]({{type|number}} channel)
|{{type|boolean}} isChannelOpen
|Checks to see if ''channel'' is open.
|odd}}

{{API table/row
|[[modem.open|''modem''.open]]({{type|number}} channel)
|{{type|nil}}
|Opens ''channel'' to allow for listening. The channel specified must be larger than 0 and less than 65535.}}

{{API table/row
|[[modem.close|''modem''.close]]({{type|number}} channel)
|{{type|nil}}
|Closes an open channel to disallow listening.
|odd}}

{{API table/row
|[[modem.closeAll|''modem''.closeAll]]()
|{{type|nil}}
|Closes all open channels.}}

{{API table/row
|[[modem.transmit|''modem''.transmit]]({{type|number}} channel, {{type|number}} replyChannel, {{type|any}} message)
|{{type|nil}}
|Transmits a message on the specified channel.
|odd}}

{{API table/row
|[[modem.isWireless|''modem''.isWireless]]()
|{{type|boolean}} isWireless
|Returns if the modem is wireless or wired.}}

{{API table/row
|''[[modem.getNamesRemote|modem.getNamesRemote]]()''
|{{type|table}} peripheralNames
|Returns a table containing the network names of the peripherals connected to the modem.
|odd}}

{{API table/row
|''[[modem.getTypeRemote|modem.getTypeRemote]]({{type|string}} peripheralName)''
|{{type|string}} type
|Returns the type of a given peripheral connected to the modem.}}

{{API table/row
|''[[modem.isPresentRemote|modem.isPresentRemote]]({{type|string}} peripheralName)''
|{{type|boolean}} present
|Returns whether a given peripheral is actively connected to the modem.
|odd}}

{{API table/row
|''[[modem.getMethodsRemote|modem.getMethodsRemote]]({{type|string}} peripheralName)''
|{{type|table}} methodNames
|Returns a list strings naming the functions available to the specified peripheral.}}

{{API table/row
|''[[modem.callRemote|modem.callRemote]]({{type|string}} peripheralName, {{type|string}} method, ...)''
|any
|Has the remote peripheral execute its specified function.
|odd}}

}}

{{Event
|name=modem_message
|return1={{type|string}} modemSide
|return2={{type|number}} senderChannel
|return3={{type|number}} replyChannel
|return4= message
|return5={{type|number}} distance
|desc=Fired when a modem message is received.}}

== Sending Messages ==
Sending a message is simple and does not require that you open any channels. Simply use the transmit function like so:
local modem = [[peripheral.wrap]]("right") -- Wraps the modem on the right side.
[[modem.transmit]](3, 1, "Hello world!")

[[peripheral.call]]("right", "transmit", 3, 1, "This will also work!")

What did that do? First I wrapped the peripheral in order to interact with it. Second, I used [[modem.transmit]](channel, replyChannel, message) in order to send my message. In case you were wondering, the reply channel is captured by the listening computer and suggests which channel they should reply on.

== Receiving Messages ==
Receiving a message requires that you be familiar with [[os.pullEvent|events]]. An example:
local modem = [[peripheral.wrap]]("left")
[[modem.open]](3) -- Open channel 3 so that we can listen on it
local event, modemSide, senderChannel,
replyChannel, message, senderDistance = [[os.pullEvent]]("modem_message")

print("I just received a message on channel: "..senderChannel)
print("I should apparently reply on channel: "..replyChannel)
print("The modem receiving this is located on my "..modemSide.." side")
print("The message was: "..message)
print("The sender is: "..(senderDistance or "an unknown number of").." blocks away from me.")

So what did I do? Quite simply, I called [[os.pullEvent]]() with the string argument "modem_message", which blocks all other events from being returned. When [[modem_message_(event)|the "modem_message" event]] is captured, it returns the arguments: event, modemSide, senderChannel, replyChannel, message, senderDistance. I captured these and then printed them out.

== Modem Limitations ==
* You can only open 128 channels at any given time, per modem.
* The highest channel you can open is 65535.
* You can listen on more than one channel at a time. For example, if the modem has channel 3 and channel 5 open, and somebody sends a message on channel 5, the modem will receive it. If a message is sent on channel 3, the modem will also receive the message.
* Sending messages does not require you to open any channels prior to sending it.
* If you aren't receiving a message when you think you should, check to make sure that you have opened the channel first.
* Modems and channels are not secure - if you are sending a message using the Modem API, messages are still available to any computer listening on the sent channel. By extension, the [[rednet (API)|Rednet API]] (which handles your modems for you using their peripheral APIs) is also insecure.

[[Category:Peripheral APIs]]

Ender Modem

2015-12-27T11:47:58Z

Bomb Bloke:

:''This page is for the Modem blocks. For the modem API, see [[Modem_(API)|Modem (API)]]''
{{Block
|name=Ender Modem
|image=EnderModem.png
|id=computercraft:advanced_modem
|damage-value=0
|is-peripheral=Yes
|peripheral-api=Modem (API)
}}
'''Ender Modems''' are advanced versions of the [[Wireless Modem]], introduced by ComputerCraft version 1.76 (for Minecraft 1.8). They use the same [[Modem_(API)|Modem API]], but are capable of cross-dimensional transmissions.

They have an extreme range, capable of functioning across distances of up to 2,147,483,647 blocks (2^31-1), and are compatible with regular Wireless Modem signals. If the modems are not located with the same dimension, however, then the "distance" parameter will be excluded from the resulting [[modem_message (event)|modem_message events]].

Whether or not communications between two modems are possible depends only on the range of the stronger of the two. This means, for example, that a single system running the [[Repeat]] script through an Ender Modem effectively opens up [[Rednet (API)|Rednet]] communications between regular Wireless Modems server-wide; while one Ender Modem-equipped [[Gps (API)|GPS cluster]] per dimension is sufficient to handle most all location requests.

See also: [[Wired Modem]], [[Wireless Modem]].

== Recipe ==
{{Crafting grid
|A1=Gold_Ingot |B1=Gold_Ingot |C1=Gold_Ingot
|A2=Gold_Ingot |B2=Eye_of_Ender |C2=Gold_Ingot
|A3=Gold_Ingot |B3=Gold_Ingot |C3=Gold_Ingot
|Output=Ender_Modem
}}

== Example (Modem API)==
* Place 2 computers and add modems to them by clicking the right mouse button while sneaking.
* Access them, and start Lua.
* Once Lua has started, wrap your modem using peripheral.wrap() (something like "modem = peripheral.wrap("<side of modem>")
* Type "[[modem_(API)|modem.open]] (<A modem port number, anything from 1 to 65535>)" on one computer.
* Check if there exists a connection: a dim, red light should be found on the modem.
* Now, type "[[modem_(API)|modem.transmit]] (<Same number as above>, <Also the same number>, 'Your message')" on the other computer. This should send your message to all computers connected.
* Opening the first computer should show the message written on the second computer.

==Modem as a Peripheral==
To use a Modem as a peripheral, you need to either call a method directly using [[peripheral.call]](), or, wrap the modem using the [[Peripheral_(API)|Peripheral API]]. Wrapped modems provide all functions listed in the [[Modem_(API)|Modem API]].

For this example, we have a Modem connected to the top of our [[Computer]], we are going to open channel 5:

''-- Immediately invoke a method without wrapping''
[[peripheral.call]]( "top", "open", 5 )

''-- You can also "wrap" the peripheral side to a variable:''
local modem = [[peripheral.wrap]]( "top" )
[[modem.open]]( 5 )

{{BlocksItemsList}}

Rednet (API)

2015-12-27T11:46:57Z

Bomb Bloke: /* Range */

''For a tutorial on how to use the API, visit [[Rednet Tutorial]].''

The Rednet API allows systems to communicate between each other without using redstone. It serves as a wrapper for the [[modem (API)|modem API]], offering ease of functionality (particularly in regards to [[Repeat|repeating signals]]) with some expense of fine control.

In order to send and receive data, a [[modem]] (either [[Wired Modem|wired]], [[Wireless Modem|wireless]], or [[Ender Modem|ender]]) is required. The data reaches any possible destinations immediately after sending it, but is [[#Range|range limited]].

==API==
{{API table|rednet|image=Grid_disk.png|2=

{{API table/row
|[[rednet.open]]({{type|string}} side)
|{{type|nil}}
|Tells the computer that the side can be used for networking.}}

{{API table/row
|[[rednet.close]]({{type|string}} side)
|{{type|nil}}
|Tells the computer that the side can no longer be used for networking.
|odd}}

{{API table/row
|[[rednet.send]]({{type|number}} receiverID, {{type|any}} message, [<nowiki/>{{type|string}} protocol])
|{{type|nil}}
|Sends a message "intended" for another system with a specific ID, using the currently opened sides. The <var>receiverID</var> is the ID {{type|number}} (note - '''not''' a {{type|string}}) of the computer you're sending the message to. The [[Variables|types]] that can be sent as the message vary depending on the version of ComputerCraft in use.}}

{{API table/row
|[[rednet.broadcast]]({{type|any}} message, [<nowiki/>{{type|string}} protocol])
|{{type|nil}}
|Sends the message to ''all'' connected and open computers.
|odd}}

{{API table/row
|[[rednet.receive]]([<nowiki/> [<nowiki/>{{type|string}} protocolFilter, ] {{type|number}} timeout])
|{{type|number}} senderID, {{type|any}} message, {{type|number}} distance / {{type|string}} protocol
|Waits until a rednet message of the specified protocol has been received, or until <var>timeout</var> seconds have passed. Leave all arguments empty to wait for any message indefinitely. If only a single, numerical argument is passed, will wait that many seconds for a message of any protocol. Versions of ComputerCraft prior to 1.6 may return the distance to the transmitting computer - 1.6 or later returns message protocols instead, though distance can still be obtained via direct use of the [[Modem (API)|Modem API]].}}

{{API table/row
|[[rednet.isOpen]]({{type|string}} side)
|{{type|boolean}} isOpen
|Returns [[Boolean_(type)|true]] if the wireless modem is open.
|odd}}

{{API table/row
|[[rednet.host]]({{type|string}} protocol, {{type|string}} hostname)
|{{type|nil}}
|Registers <var>hostname</var> against <var>protocol</var> for the purposes of [[rednet.lookup]](). '''Only available in ComputerCraft 1.6 and above.'''}}

{{API table/row
|[[rednet.unhost]]({{type|string}} protocol, {{type|string}} hostname)
|{{type|nil}}
|Unregisters <var>hostname</var> from <var>protocol</var>. '''Only available in ComputerCraft 1.6 and above.'''
|odd}}

{{API table/row
|[[rednet.lookup]]({{type|string}} protocol, {{type|string}} hostname)
|{{type|number}} ID1, {{type|number}} ID2, ...
|Searches the local network for systems registered with a matching <var>hostname</var> and/or <var>protocol</var>, and returns matching IDs found. '''Only available in ComputerCraft 1.6 and above.'''
}}

{{API table/row
|[[rednet.run]]()
|{{type|nil}}
|Internal use function - runs automatically and does not need to be called directly. Waits for [[Modem_message_(event)|modem_message]] events to appear within the event queue and generates corresponding [[Rednet_message_(event)|rednet_message]] events for use with this API. Also responds to [[rednet.lookup]]() requests.
|odd}}

}}

==Events==
{{Event|name=[[rednet_message_(event)|rednet_message]]
|desc=Fired when a rednet message is received (can be pulled via [[os.pullEvent|os.pullEvent()]] directly as an alternative to using [[rednet.receive|rednet.receive()]]).
|return1={{type|number}} senderId
|return2={{type|any}} message
|return3={{type|number}} distance / {{type|string}} protocol
}}

==Range==
The range of a wireless network transmission can be determined via the following formula:

minRange + (position.yCoord - 96.0) * ((maxRange - minRange) / ((world.getHeight() - 1) - 96.0))

Where, for a [[Wireless Modem]]:

minRange = 64 (or 16 in a storm)
maxRange = 384 (or 96 in a storm)
world.getHeight() = 256

For an [[Ender Modem]], the maximum range is thought to be 2,147,483,647 blocks. It's unknown if this is affected by world height or weather.

Catch is, that formula is quite capable of returning values that are well below 0... More research is required, it seems. Anyway, min/max range figures can be altered in [[ComputerCraft.cfg]], and the maximum range of a system located at world height will generally be equal to the maxRange for the current weather.

Even for the purposes of two-way communications, only the system with the best range is checked - a system located at the bottom of the world may hence send to and receive from a system at the top. Range is calculated in three dimensions, so the area a given system can reach wirelessly is represented by a sphere.

For wired networks, range between devices is 256 blocks of [[Networking_Cable|network cable]] (unconfigurable). Either method of communication works regardless as to whether the intervening chunks are loaded or not.

As of ComputerCraft 1.6, a [[Repeat|repeater script]] is available to all systems by default.

==Protocols==
Introduced by ComputerCraft 1.6, "protocols" are simple string names indicating what [[rednet.send|sent messages]] are about. [[rednet.receive|Receiving systems]] may filter messages according to their protocols, thereby automatically ignoring incoming messages which don't specify an identical string. It's also possible to [[rednet.lookup|lookup]] which systems in the area are interested in certain protocols, hence making it easier to determine where given messages should be sent in the first place.

==History==
Before the creation of the in-game wireless networking API, the term "Rednet" referred to a system created by a ComputerCraft user based on bundled cables from the popular Minecraft mod [http://www.eloraam.com RedPower]. That also allowed communication between computers, but the data was transferred slowly - every bit was converted to redstone signal (using the [[redstone (API)|redstone API]]) that lasted about 0.05 seconds (the length of a Minecraft "tick"). That system was rendered redundant by the release of ComputerCraft 1.3, as this heralded the arrival of [[Wireless Modem|wireless networking]] to the mod and allowed instant communications between computers.

Later, ComputerCraft 1.51 brought forward [[Wired Modem]]s, which could not only be used for regular network communications, but to interact with [[peripheral]]s remotely.

==Security==
In current versions of ComputerCraft (1.5 or later), Rednet is not to be considered a "secure" method of communication. The identity data indicating who sent a given message is set ''by the sender'', and hence cannot be trusted. Messages intended for a given system may be received and read by any other system in range.

This is because Rednet is simply a convenience wrapper for the [[modem (API)|modem API]], and while it typically sends/receives using channel numbers matching the IDs of systems you control, the latter offers ''complete control'' over channel usage. Another user can hence easily task the modem API directly to sniff and find out what messages a computer is receiving if he knows (or can even guess) its ID, or pretend to send from any ID he wishes.

When using Rednet for anything with security implications, be sure to implement your own methods of protection.

==Deprecated Functions==
{{Deprecated
|plural=yes
|type=These functions
}}

{{API table|Deprecated Rednet Functions|image=Grid disk.png|2=

{{API table/row
|[[rednet.announce]]()
|{{type|nil}}
|Broadcasts an empty rednet message. Removed from ComputerCraft by version ''1.5'' in favor of [[rednet.broadcast]]()
|odd}}

}}

[[Category:APIs]]

Repeat

2015-12-27T11:43:41Z

Bomb Bloke:

Added by ComputerCraft 1.6, the "repeat" script can be started by typing its name into any system with an attached [[modem]] (either [[Wired Modem|wired]], [[Wireless Modem|wireless]], or [[Ender Modem|ender]]).

While running, it constantly monitors modem channel 65533 for incoming rednet messages, and re-sends anything it detects (as of CC 1.6, all messages sent via [[rednet.send|rednet.send()]] are automatically distributed both on the channel the coder specifies ''and'' on channel 65533, making it possible for repeater systems to pick them up without monitoring the entire channel range).

Bearing in mind that the [[Rednet_(API)#Range|wireless range]] of a given system will be higher the closer it is to world height, and that two-way communications are possible between systems so long as at least ''one'' of them has sufficient range, one repeater system placed at max altitude can provide coverage between quite a large number of systems down below that otherwise might not be able to reach each other. If an [[Ender Modem]] is used, then a single repeater system will typically cover the needs of an entire server.

The system running the repeat script will maintain a visible running tally of how many messages it has repeated.

==Launching==
If you wish to have a system automatically boot the repeat script every time it becomes chunk-loaded, you might create a [[startup]] script with the following content:

[[shell.run]]("repeat")

If you wish to continue using a system while it's acting as a repeater, consider firing it up in a new [[multishell]] tab:

[[bg]] repeat

[[Category:Programs]]

Peripherals (program)

2015-12-27T11:41:53Z

Bomb Bloke:

Added by ComputerCraft 1.76, "peripherals" a [[CraftOS Shell|CraftOS Shell command]] which simply lists all [[peripheral]]s attached to the system. Output is in a "<side> (<type>)" format.

[[Category:Programs]]

Peripherals (program)

2015-12-27T11:40:29Z

Bomb Bloke: Created page with "Added by ComputerCraft 1.76, "peripherals" a CraftOS Shell command which simply lists all peripherals attached to the system. Output is formatted in a "<..."

Added by ComputerCraft 1.76, "peripherals" a [[CraftOS Shell|CraftOS Shell command]] which simply lists all [[peripheral]]s attached to the system. Output is formatted in a "<side> (<type>)" format.

[[Category:Programs]]

CraftOS Shell

2015-12-27T11:36:01Z

Bomb Bloke: peripherals script

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
CraftOS Shell Programs
</td></tr>
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Program Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-alias">[[alias]]</div><tt>alias <alias> <program></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Maps an alias string to a program.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-apis">[[apis]]</div><tt>apis</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Lists all loaded APIs.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-apis">[[bg]]</div><tt>bg <program> <arguments></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Opens the specified script in a new [[multishell]] tab. <b>Note:</b> Added by ComputerCraft 1.6</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-cd">[[cd]]</div><tt>cd <path></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Changes to the specified directory</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-clear">[[clear]]</div><tt>clear</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Clears the terminal.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-copy">[[copy]]</div><tt>copy <source> <destination></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Copies a source file or folder to a destination</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-dj">[[delete]]</div><tt>delete <path></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Deletes the specified file (in the same manner as [[rm]]).</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-dj">[[dj]]</div><tt>dj</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Music box DJ - use <tt>dj</tt> for help.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-drive">[[drive]]</div><tt>drive</tt>, <tt>drive <path></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Lists the mount location of the current directory, or the path specified.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-edit">[[edit]]</div><tt>edit <path></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Edits the file specified.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-eject">[[eject]]</div><tt>eject <side></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Ejects the disk on the side specified.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-exit">[[exit]]</div><tt>exit</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Exits the currently running shell session - if it is the only shell session, the computer will power off.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-exit">[[fg]]</div><tt>fg <program> <arguments></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Opens the specified script in a new [[multishell]] tab, then switches to it. <b>Note:</b> Added by ComputerCraft 1.6</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-gps">[[Gps (program)|gps]]</div><tt>gps <?></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Minecraft Global Positioning tool. Use <tt>gps</tt> for help.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-help">[[help]]</div><tt>help</tt>, <tt>help <topic></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Help utility. Opens the specified topic, or the introduction if no topic is specified.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-id">[[id]]</div><tt>id</tt>, <tt>id <side></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the ID of the computer, or if a side is specified, the ID of the disk in the specified side.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-label">[[label]]</div><tt>label</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets and sets the ID of the computer, or, the ID of a disk in a specified side. Use <tt>label</tt> for help.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-list">[[list]]</div><tt>list</tt>, <tt>list <path></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Lists the content of the current directory, or, the directory specified.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-lua">[[lua]]</div><tt>lua</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Interactive Lua interpreter at the shell.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-mkdir">[[mkdir]]</div><tt>mkdir <path></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes the directory at the path specified.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-monitor">[[Monitor (program)|monitor]]</div><tt>monitor <side> <program> <arguments></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Redirects a specified program to a monitor on the specified side.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-move">[[move]]</div><tt>move <source> <destination></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Moves a file or folder at a specified source path to the specified destination path.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-move">[[multishell]]</div><tt>multishell</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Opens a new instance of multishell, running within the ''current'' multishell session. <b>Note:</b> Added by ComputerCraft 1.6</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-pastebin">[[Pastebin_(program)|pastebin]]</div><tt>pastebin <get/run/put> <pastebin code/file></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Allows the user to either retrieve a file from [http://pastebin.com/ pastebin.com], run it directly after downloading, or upload a file from the computer/turtle.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-peripherals">[[peripherals_(program)|peripherals]]</div><tt>peripherals</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Lists all peripherals attacked to the system.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-programs">[[programs]]</div><tt>programs</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Lists all programs on the system.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-reboot">[[reboot]]</div><tt>reboot</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Reboots the Computer.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-redprobe">[[redprobe]]</div><tt>redprobe</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">List redstone stats. <b>Note:</b> Removed in ComputerCraft 1.6</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-redpulse">[[redpulse]]</div><tt>redpulse</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Redstone output pulse tool. Use <tt>redpulse</tt> for help. <b>Note:</b> Removed in ComputerCraft 1.6</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-redset">[[redset]]</div><tt>redset</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Redstone output set tool. Use <tt>redset</tt> for help. <b>Note:</b> Removed in ComputerCraft 1.6</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-redset">[[redstone (program)|redstone]]</div><tt>redstone <?></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Controls the redstone output state(s) of the system. <b>Note:</b> Added by ComputerCraft 1.6</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-redset">[[repeat]]</div><tt>repeat</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Configures the system to act as a [[rednet (API)|rednet]] repeater. <b>Note:</b> Added by ComputerCraft 1.6</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-time">[[time]]</div><tt>time</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the Minecraft time of day.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-type">[[type]]</div><tt>type <path></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the type of the object or file at the specified path.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-rename">[[rename]]</div><tt>rename <old-name> <new-name></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Renames a file or directory.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-rename">[[rm]]</div><tt>rm <path></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Deletes the specified file (in the same manner as [[delete]]).</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-shell">[[shell]]</div><tt>shell, shell <program> <arguments></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Opens another shell session. Runs a program if specified.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-shutdown">[[shutdown]]</div><tt>shutdown</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Powers off the Computer.</td></tr>
</table><br><br>

== Added TurtleOS programs ==

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Additional TurtleOS Shell Programs
</td></tr>
<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Program Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-apis">[[craft]]</div><tt>craft</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The turtle will, if it is able, craft an item from the contents of its inventory.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-alias">[[dance]]</div><tt>dance</tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Initiates "get down" procedure.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-alias">[[equip]]</div><tt>equip <side></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The turtle will attempt to place a tool on its specified side. <b>Note:</b> Added by ComputerCraft 1.6</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-apis">[[excavate]]</div><tt>excavate <width></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Digs a square-shaped quarry to bedrock, of width equal to that specified.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-alias">[[go]]</div><tt>go <?></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Moves the turtle.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-apis">[[refuel]]</div><tt>refuel <amount></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Attempts to replenish the turtle's [[fuel]] supply with items from its inventory.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-alias">[[tunnel]]</div><tt>tunnel <width></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Digs a horizontal tunnel leading off in the direction the turtle is facing.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-apis">[[turn]]</div><tt>turn <?></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Causes the turtle to rotate.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;"><div id="cmd-alias">[[unequip]]</div><tt>unequip<width></tt></td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Attempts to remove a tool from the turtle's specified side. <b>Note:</b> Added by ComputerCraft 1.6</td></tr>
</table>

== See also ==
* [[Built In Turtle Programs]]

[[Category:Programs]][[Category:Lists]][[Category:Tutorials]]

Fs.open

2015-12-27T11:29:42Z

Bomb Bloke: CC 1.76

{{lowercase}}
{{Function
|name=fs.open
|args={{Type|string}} path, {{Type|string}} mode
|api=fs
|returns={{Type|table}} the file handle, or [[nil]] on error (e.g. if <var>mode</var> was "r" and the file did not exist, or if <var>mode</var> was "w" or "a" and the file was in a read-only location)
|desc=
'''Supported File Modes'''
Opens a file so it can be read or written. <var>mode</var> consists of a first character which is one of the following:
* "r" to open the file read-only,
* "w" to open it for writing and remove any existing data on file open, or
* "a" to open for writing but keep existing data and append any writes to the end of the file
Any of the three may be optionally followed by "b" to open the file for binary access instead of the default text access (eg, "wb" opens a file for binary output).

Text mode file handles assume UTF-8 encoding for both input and output purposes, and supports all characters within the [https://en.wikipedia.org/wiki/ISO/IEC_8859-1 ISO 8859-1 codepage] (plus a few extras). Prior to ComputerCraft 1.76, instead only [https://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters printable ASCII] characters are supported. In either case, any characters ''not'' supported are translated to 0x3F (representing a question mark).

When you have opened a file you must always [[#Closing a file handle|close the file handle]], or else data may not be saved.

Append mode and write mode both create a new file if none already exists (and write mode creates a new one even if one does); however, under a few builds of ComputerCraft in the 1.5x range, append mode will fail if an existing file cannot be found.
|examples=
{{Example
|desc=Creates the file "abcd" for writing, and holds a file handle to it
|code=local h = fs.open("abcd", "w")
}}
{{Example
|desc=Opens "abcd" in either append or write mode, depending on whether it already exists or not.
|code=local h = fs.open("abcd", fs.exists("abcd") and "a" or "w")
}}
}}

== File Handles ==

A file handle allows access to a file. A file handle is a table; the functions within the table are accessed with the dot operator (<em>not</em> the colon operator, as may be more intuitive!). The examples below assume a file has already been opened and the handle stored in the variable <var>h</var>.

=== Closing a file handle ===

When you open a file you must remember to close the handle when you've finished with it! The write modes supported by ComputerCraft may not actually output data until this is done. A file opened in any mode exposes the following close function:
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in text read mode ===

A file opened in mode "r" (text read mode) exposes the following functions.

{{Function
|name=<var>h</var>.readLine
|api=fs
|returns=[[string]] the next line read from the file, with the end-of-line character stripped; or nil if there are no more lines in the file
|desc=Reads the next line from the file
}}
{{Function
|name=<var>h</var>.readAll
|api=fs
|returns=[[string]] the entire rest of the file, with the end-of-line character on the very last line (if present) stripped
|desc=Reads the all the text in the file
}}

=== Files opened in text write/append mode ===

A file opened in mode "w" (text write mode) or "a" (text append mode) exposes the following functions:

{{Function
|name=<var>h</var>.write
|args=[[string (type)|string]] data
|api=fs
|desc=Writes a string of characters to the file exactly as they appear in the string <var>data</var>
}}
{{Function
|name=<var>h</var>.writeLine
|args=[[string (type)|string]] data
|api=fs
|desc=Writes a string of characters to the file, then appends an end-of-line character
}}
if you just want to save a file, without closing the handle, then you could do a flush. ( this is normally used for logging etc...)
{{Function
|name=<var>h</var>.flush
|api=fs
|desc=Flushes the data to the specified file. (keeps the handle available afterwards)
}}

=== Files opened in binary read mode ===

A file opened in mode "rb" (binary read mode) exposes the following functions:

{{Function
|name=<var>h</var>.read
|api=fs
|returns={{type|number}} the byte read from the file, or [[Nil|nil]] if there are no more bytes
|desc=Reads a single byte from the file and returns it
}}

=== Files opened in binary write/append mode ===

A file opened in mode "wb" (binary write mode) or "ab" (binary append mode) exposes the following functions:

{{Function
|name=<var>h</var>.write
|args={{type|number}} byte
|api=fs
|desc=Writes a single byte into the file
}}

[[Category:Lua_Core_Functions]]

Template:Changelog

2015-12-27T11:25:44Z

Bomb Bloke:

{| class="wikitable sortable" style="width: 100%"
! style="width: 15%" | Version
! class="unsortable" | New Features or Changes
! style="width: 15%" | Minecraft Version
|-
|align=center|[http://www.computercraft.info/2015/12/24/computercraft-1-76/ ComputerCraft 1.76]
|
*Ported to Minecraft 1.8
*Added [[Ender Modem]]s for cross-dimensional communication
*Fixed handling of 8-bit characters. All the characters in the [https://en.wikipedia.org/wiki/ISO/IEC_8859-1 ISO 8859-1 codepage] can now be displayed
*Added some extra graphical characters in the unused character positions, including a suite of characters for [http://teletextart.tumblr.com/ Teletext-style drawing]
*Added support for the new commands in Minecraft 1.8 to the [[Command Computer]]
*The return values of [[turtle.inspect]]() and [[commands.getBlockInfo]]() now include blockstate information
*Added [[commands.getBlockInfos]]() function for Command Computers
*Added new "[[Peripherals (program)|peripherals]]" program
*Replaced the "_CC_VERSION" and "_MC_VERSION" constants with a new "_HOST" constant
*Shortened the length of time that "Ctrl+T", "Ctrl+S" and "Ctrl+R" must be held down to terminate, shutdown or reboot the computer
*[[textutils.serializeJSON]]() now takes an optional parameter allowing it to produce JSON text with unquoted object keys. This is used by all autogenerated methods in the [[commands (API)|commands API]] except for "title" and "tellraw"
*Fixed many bugs
|align=center|1.8
|-
|align=center|[http://www.computercraft.info/2015/12/04/computercraft-1-75/ ComputerCraft 1.75]
|
*Fixed monitors sometimes rendering without part of their text.
*Fixed a regression in the [[Bit_(API)|“bit” API]].
|align=center|1.7.10
|-
|align=center|[http://www.computercraft.info/2015/06/27/computercraft-1-74/ ComputerCraft 1.74]
|
*Added tab completion to [[Edit|“edit”]], [[Lua|“lua”]] and the [[shell]].
*Added [[textutils.complete]](), [[fs.complete]](), [[shell.complete]](), [[shell.completeProgram]](), [[shell.setCompletionFunction]](), [[shell.getCompletionInfo]](), and [[help.completeTopic]]().
*Added tab completion options to [[read]]().
*Added [[key_up_(event)|“key_up”]] and [[mouse_up_(event)|“mouse_up”]] events.
*Non-advanced terminals now accept both grey [[Color_(API)|colour]]s.
*Added [[term.getTextColor]](), [[term.getBackgroundColor]]() and [[term.blit]]().
*Improved the performance of text rendering on [[Advanced Computer]]s.
*Added a “Run” button to the [[edit|“edit”]] program on [[Advanced Computer]]s.
*[[Turtle]]s can now push players and entities ([[ComputerCraft.cfg|configurable]]).
*[[Turtle]]s now respect server spawn protection ([[ComputerCraft.cfg|configurable]]).
*Added a turtle permissions API for mod authors.
*Implemented a subset of the Lua 5.2 API so programs can be written against it now, ahead of a future Lua version upgrade.
*Added a [[ComputerCraft.cfg|config option]] to disable parts of the Lua 5.1 API which will be removed when a future Lua version upgrade happens.
*[[Command Computer]]s can no longer be broken by survival players.
*Fixed the “pick block” key not working on ComputerCraft items in creative mode.
*Fixed the [[edit|“edit”]] program being hard to use on certain European keyboards.
*Added “_CC_VERSION” and “_MC_VERSION” constants.
|align=center|1.7.10
|-
|align=center|[http://www.computercraft.info/2015/02/22/computercraft-1-73/ ComputerCraft 1.71 - 1.73]
|
*[CC 1.71] The [[exec|“exec”]] program, [[commands.exec]]() and all related [[Command Computer]] functions now return the console output of the command.
*[CC 1.72 - 1.73] Fixed two multiplayer-only crash bugs when placing certain blocks.
|align=center|1.7.10
|-
|align=center|[http://www.computercraft.info/2015/02/15/computercraft-1-7/ ComputerCraft 1.7]
|
*Added [[Command Computer]]s.
*Added new API: [[commands_(API)|commands]].
*Added new programs: [[commands]], [[exec]].
*Added [[textutils.serializeJSON]]().
*Added ILuaContext.executeMainThreadTask() for peripheral developers.
*[[Disk Drive]]s and [[Printer]]s can now be renamed with Anvils.
*Fixed problems with HD texture packs.
*Fixed various bugs and crashes.
*Documented all the new features in the in-game help system.
|align=center|1.7.10
|-
|align=center|[http://www.computercraft.info/2014/10/09/computercraft-1-65/ ComputerCraft 1.65]
|
*Fixed a multiplayer-only crash with [[turtle.place]]().
*Fixed some problems with [[http.post]]().
*Fixed [[fs.getDrive]]() returning incorrect results on remote peripherals.
|align=center|1.7.10
|-
|align=center|[http://www.computercraft.info/2014/09/27/computercraft-1-64/ ComputerCraft 1.64]
|
*Ported to Minecraft 1.7.10.
*New [[turtle_(API)|turtle API]] functions: [[turtle.inspect]](), [[turtle.inspectUp]](), [[turtle.inspectDown]](), [[turtle.getItemDetail]]().
*Lots of bug fixes and crash fixes, a huge stability improvement over previous versions.
*New [[paintutils_(API)|paintutils API]] functions: [[paintutils.drawBox]]( startX, startY, endX, endY [, color] ), [[paintutils.drawFilledBox]]( startX, startY, endX, endY [, color] ).
|align=center|1.7.10
|-
|align=center|[http://www.computercraft.info/2014/04/16/computercraft-1-63/ ComputerCraft 1.63]
|
*[[Turtle]]s can now be painted with dyes, and cleaned with water buckets.
*Added a new game: [[Redirection]] – ComputerCraft Edition by [http://www.computercraft.info/forums2/index.php?/user/16414-ramilego4game/ RamiLego] (type “redirection” on an Advanced Computer to play).
*[[Turtle]] label nameplates now only show when the [[Turtle]] is moused-over.
*The HTTP API is now enabled by default, and can be configured with a whitelist of permitted domains.
*[[http.get]]() and [[http.post]]() now accept parameters to control the request headers.
*New [[Fs_(API)|fs API]] function: [[fs.getDir]]( path ).
*Fixed some bugs.
|align=center|1.6.4
|-
|align=center|[http://www.computercraft.info/2014/04/04/computercraft-1-62/ ComputerCraft 1.62]
|
*Fixed some bugs which were crashing the game.
*[[Chat]] now supports IRC commands.
|align=center|1.6.4
|-
|align=center|[http://www.computercraft.info/2014/04/01/computercraft-1-61-bug-fix-update/ ComputerCraft 1.61]
|
*Fixed a bug where newly placed [[Computer]]s would share their folder structure until game restart.
*Fixed a bug where running [[Computer]]s might not automatically restart as the game did so.
|align=center|1.6.4
|-
|align=center|[http://www.computercraft.info/2014/03/27/computercraft-1-6-is-here/ ComputerCraft 1.6]
|
*Added [[Pocket Computer]]s.
*Added a [[Multishell|multi-tasking system]] for [[Advanced Computer]]s and [[Turtle]]s.
*[[Turtle]]s can now [[Equip|swap out their tools and peripherals]] at runtime.
*[[Turtle]]s can now carry two tools or peripherals at once in any combination.
*[[Turtle]]s and [[Computer]]s can now be labelled using Name Tags and Anvils.
*Added a [[ComputerCraft.cfg|configurable fuel limit]] for [[Turtle]]s.
*Added hostnames, protocols and long distance routing to the [[Rednet (API)|rednet API]].
*Added a peer-to-peer [[chat]] program to demonstrate new rednet capabilities.
*Added a new game, only on [[Pocket Computer]]s: “[[falling]]” by [http://www.computercraft.info/forums2/index.php?/user/3545-gopheratl/ GopherATL].
*File system commands in the shell now accept wildcard arguments.
*The shell now accepts long arguments in quotes.
*[[term.redirect|Terminal redirection]] now no longer uses a stack-based system. Instead: [[term.current]]() gets the current terminal object and [[term.redirect]]() replaces it. [[term.restore]]() has been removed.
*Added a new [[Window (API)|Windowing API]] for addressing sub-areas of the terminal.
*New programs: [[fg]], [[bg]], [[multishell]], [[chat]], [[repeat]], [[Redstone (program)|redstone]], [[equip]], [[unequip]].
*Improved programs: [[copy]], [[move]], [[delete]], [[rename]], [[paint]], [[CraftOS|shell]].
*Removed programs: redset, redprobe, redpulse.
*New [[:Category:APIs|APIs]]: [[Window (API)|window]], [[Multishell (API)|multishell]].
*New [[Turtle (API)|turtle API]] functions: [[turtle.equipLeft]](), [[turtle.equipRight]](), [[turtle.getFuelLimit]](), [[turtle.getSelectedSlot]]().
*New [[Peripheral (API)|peripheral API]] functions: [[peripheral.find]]( [type] ).
*New [[Rednet (API)|rednet API]] functions: [[rednet.host]]( protocol, hostname ), [[rednet.unhost]]( protocol ), [[rednet.lookup]]( protocol, [hostname] ).
*Improved [[Rednet (API)|rednet API]] functions: [[rednet.send]](), [[rednet.broadcast]]() and [[rednet.receive]]() now take optional protocol parameters.
*New [[fs (API)|fs API]] function: [[fs.find]]( wildcard ).
*New [[Shell (API)|shell API]] functions: [[shell.openTab]]( command ), [[shell.switchTab]]( number ).
*New event “[[Term_resize_(event)|term_resize]]” fired when the size of a terminal changes.
*[[turtle.craft]](0) and [[turtle.refuel]](0) now return true if there is a valid recipe or fuel item, but do not craft or refuel anything.
*[[turtle.suck]]( [limit] ) can now be used to limit the number of items picked up.
*Users of [[turtle.dig]]() and [[turtle.attack]]() can now specify which side of the turtle to look for a tool to use (by default, both will be considered).
*[[textutils.serialize]]() now produces human-readable output.
*Refactored most of the codebase and fixed many old bugs and instabilities, [[Turtle]]s should never ever lose their content now.
*Fixed the “[[turtle_inventory_(event)|turtle_inventory]]” event firing when it shouldn’t have.
*Added error messages to many more [[Turtle_(API)|turtle API]] functions after they return false.
*Documented all new programs and API changes in the “[[help]]” system.
|align=center|1.6.4
|-
|align=center|[http://www.computercraft.info/2013/12/09/computercraft-1-58/ ComputerCraft 1.58]
|
*Fixed a long standing bug where [[Turtle]]s could lose their identity.
*Fixed use of deprecated code, ensuring mod compatibility with the latest versions of Minecraft Forge and world compatibility with future versions of Minecraft.
|align=center|1.6.4
|-
|align=center|[http://www.computercraft.info/2013/10/14/new-versions/ ComputerCraft 1.57]
|
*Ported to Minecraft 1.6.4.
*Added two new [[Treasure Disks]]: Conway’s Game of Life by [http://www.computercraft.info/forums2/index.php?/user/1823-vilsol/ vilsol] and Protector by [http://www.computercraft.info/forums2/index.php?/user/6929-fredthead/ fredthead].
*Fixed a very nasty item duplication bug.
|align=center|1.6.4
|-
|align=center|[http://www.computercraft.info/2013/08/04/computercraft-1-56/ ComputerCraft 1.56]
|
*Added [[Treasure Disks]]: Rare [[Floppy Disk]]s found only in dungeons, which contain fun programs made by the community. Find them all!
*All [[Turtle_(API)|turtle API]] functions now return additional error messages when they fail.
*Resource Packs with Lua Programs can now be loaded when extracted to a folder, for easier editing.
|align=center|1.6.2
|-
|align=center|[http://www.computercraft.info/2013/07/11/computercraft-1-55/ Computercraft 1.55]
|
*Ported to Minecraft 1.6.2.
*Added [[Advanced Turtle]]s.
*Added [[turtle_inventory_(event)|“turtle_inventory”]] event. Fires when any change is made to the inventory of a [[Turtle]].
*Added missing [[IO_(API)|io API]] functions: io.close, io.flush, io.input, io.lines, io.output.
*Tweaked the screen colours used by [[Advanced Computer]]s, [[Advanced Monitor]]s and [[Advanced Turtle]]s.
*Added several new features for Peripheral authors.
*Lua programs can now be included in Resource Packs.
|align=center|1.6.2
|-
|align=center|[http://www.computercraft.info/2013/05/23/computercraft-1-53/ ComputerCraft 1.53]
|
*Ported to Minecraft 1.5.2.
*[[redstone.setBundledOutput]]() and [[redstone.getBundledOutput]]() now work with cables from Minefactory Reloaded, as well as RedPower.
*[[Monitor]]s and [[Advanced Monitor]]s can now be placed on floors and ceilings.
|align=center|1.5.2
|-
|align=center|[http://www.computercraft.info/2013/03/26/computercraft-1-52/ Computercraft 1.52]
|
*Ported to Minecraft 1.5.1.
|align=center|1.5.1
|-
|align=center|[http://www.computercraft.info/2013/03/15/computercraft-1-51/ Computercraft 1.51]
|
*Ported to Minecraft 1.5.
*Added [[Wired Modem]]s.
*Added [[Networking Cable]]s.
*Made [[Wireless Modem]]s more expensive to craft.
*New [[redstone_(API)|redstone API]] functions: [[redstone.getAnalogInput]](), [[redstone.setAnalogOutput]](), [[redstone.getAnalogOutput]]().
*Peripherals can now be controlled remotely over wired networks.
*New [[peripheral_(API)|peripheral API]] function: [[peripheral.getNames]]().
*New event: [[monitor_resize_(event)|“monitor_resize”]]is fired when the size of a monitor changes.
*Except for labelled [[Computer]]s and [[Turtle]]s, ComputerCraft blocks no longer drop items in creative mode.
*The pick block function works in creative mode now works for all ComputerCraft blocks.
*All blocks and items now use the IDs numbers assigned by FTB by default.
*Fixed [[Turtle]]s sometimes placing blocks with incorrect orientations.
*Fixed [[Wireless Modem]]s being able to send messages to themselves.
*Fixed [[turtle.attack]]() having a very short range.
*Various bugfixes.
|align=center|1.5
|-
|align=center|[http://www.computercraft.info/2013/02/11/computercraft-1-5/ Computercraft 1.5]
|
*Redesigned [[Wireless Modem]]s; they can now send and receive on multiple channels, independent of the computer ID. To use these features, interface with modem peripherals [[Modem_(API)|directly]]. The [[Rednet_(API)|rednet API]] still functions as before.
*[[Floppy Disk]]s can now be dyed with multiple dyes, just like armour.
*The [[Excavate|“excavate”]] program now retains fuel in it’s inventory, so can run unattended.
*[[turtle.place]]() now tries all possible block orientations before failing.
*[[turtle.refuel]](0) returns true if a fuel item is selected.
*[[turtle.craft]](0) returns true if the inventory is a valid recipe.
*The in-game help system now has documentation for all the peripherals and their methods, including the new [[Modem]] functionality.
*A romantic surprise.
|align=center|1.4.7
|-
|align=center|[http://www.computercraft.info/2012/12/27/computercraft-1-481-miscperipherals-fix/ Computercraft 1.481]
|
*Fixed compatibility bug with MiscPeripherals.
|align=center|1.4.6
|-
|align=center|[http://www.computercraft.info/2012/12/23/computercraft-1-48/ Computercraft 1.48]
|
*Ported to Minecraft 1.4.6.
*[[Advanced Monitor]]s can now be used as touchscreens.
*[[Advanced Monitor]]s are now easier to craft.
*[[Turtle]]s now get slightly less movement from fuel.
*[[Turtle]]s can now push items.
*[[Computer]]s can now [[Command_Block_(API)|control Command Blocks]], if enabled in the [[ComputerCraft.cfg|config]].
*New [[OS_(API)|os API]] function: [[os.day]]().
*A Christmas surprise.
|align=center|1.4.6
|-
|align=center|[http://www.computercraft.info/2012/11/15/computercraft-1-47-and-minecon-news/ ComputerCraft 1.47]
|
*Ported to Minecraft 1.4.4.
*Fixed label tooltips not showing up in SMP.
|align=center|1.4.4
|-
|align=center|[http://www.computercraft.info/2012/10/25/computercraft-1-46-minecraft-update/ ComputerCraft 1.46]
|
*Ported to Minecraft 1.4.2.
*ComputerCraft items now have their own tab in Creative Mode.
|align=center|1.4.2
|-
|align=center|[http://www.computercraft.info/2012/10/22/computercraft-1-45-now-with-colors/ ComputerCraft 1.45]
|
*Added [[Advanced Computer]]s.
*Added [[Advanced Monitor]]s.
*New program: [[paint]] (by [http://www.computercraft.info/forums2/index.php?/user/643-nitrogenfingers/ nitrogenfingers]).
*New API: [[paintutils_(API)|paintutils]].
*New term functions: [[term.setBackgroundColor]]( color ), [[term.setTextColor]]( color ), [[term.isColor]]().
*New [[Turtle|Turtle API]] function: [[turtle.transferTo]]().
|align=center|1.3.2
|-
|align=center|[http://www.computercraft.info/2012/10/04/computercraft-1-43-books/ ComputerCraft 1.43]
|
*Added [[Printed Page]]s (bind several [[Printed Page]] items into one with a string).
*Added [[Printed_book|Printed Books]] (add a leather cover to the above).
*Labelled [[Turtle]]s now keep their fuel when broken.
*Fixed incompatibility with Forge 275 and above.
|align=center|1.3.2
|-
|align=center|[http://www.computercraft.info/2012/09/22/computercraft-1-42-is-released/ ComputerCraft 1.42]
|
*Ported to Minecraft 1.3.2 and the Forge mod system.
*Added [[Printer]]s.
*[[Floppy Disk]]s can now be dyed different colours.
*[[Turtle|Wireless Crafty Turtles]] can now be crafted.
*All new textures.
*New Forge [[ComputerCraft.cfg|config file]].
*Various tweaks and bug fixes.
|align=center|1.3.2
|-
|align=center|[http://www.computercraft.info/2012/07/29/computercraft-1-41-bugfix-update/ ComputerCraft 1.41]
|
*Fixed labelled [[Computer]]s not keeping their data when destroyed.
*Fixed the [[Excavate|“excavate”]] program outputting lots of spam.
*File system size limits now take into account empty files and directories.
*Some small changes to the Turtle Upgrade API ahead of it’s impending release. (Update: The API has now been released).
|align=center|1.2.5
|-
|align=center|[http://www.computercraft.info/2012/07/27/computercraft-1-4-is-released/ ComputerCraft 1.4]
|
*Ported to Forge Mod Loader: ComputerCraft can now be ran directly from the .zip without extraction.
*Added Farming [[Turtle]]s, Felling [[Turtle]]s, Digging [[Turtle]]s, Melee [[Turtle]]s and Crafty [[Turtle]]s.
*Added 14 new [[Turtle]] combinations accessible by combining the turtle upgrades above.
*Labelled [[Computer]]s and [[Turtle]]s can now be crafted into [[Turtle]]s or other [[Turtle]] types without losing their ID, label and data.
*Added a “[[Turtle]] Upgrade API” for mod developers to create their own tools and peripherals for [[Turtle]]s.
*[[Turtle]]s can now attack entities with [[turtle.attack]]() and collect their dropped items.
*[[Turtle]]s can now use [[turtle.place]]() with any item the player can and can interact with entities.
*[[Turtle]]s can now craft items with [[turtle.craft]]().
*[[Turtle]]s can now place items into inventories with [[turtle.drop]]().
*Changed the behaviour of [[turtle.place]]() and [[turtle.drop]]() to only consider the currently selected slot.
*[[Turtle]]s can now pick up items from the ground or from inventories with [[turtle.suck]]().
*[[Turtle]]s can now compare items in their inventories.
*[[Turtle]]s can place signs with text on them with [[turtle.place]]( [signText] ).
*[[Turtle]]s now optionally require fuel items to move, and can [[turtle.refuel|refuel]] themselves.
*The size of the the [[Turtle]] inventory has been increased to 16 slots.
*The size of the [[Turtle]] screen has been increased.
*New [[Turtle_(API)|turtle API]] functions: [[turtle.compareTo]]( [slotNum] ), [[turtle.craft]](), [[turtle.attack]](), [[turtle.attackUp]](), [[turtle.attackDown]](), [[turtle.dropUp]](), [[turtle.dropDown]](), [[turtle.getFuelLevel]](), [[turtle.refuel]]().
*New [[Disk_(API)|disk API]] function: [[disk.getID]]().
*New [[Turtle]] programs: [[craft]], [[refuel]].
*[[Excavate|“excavate”]] program is now much smarter: will return items to a chest when full, attack mobs, and refuel itself automatically.
*New API: [[Keys_(API)|keys]].
*Added optional [[Floppy Disk]] and Hard Drive space limits for [[Computer]]s and [[Turtle]]s.
*New [[Fs_(API)|fs API]] function: [[fs.getFreeSpace]]( path ). Also [[fs.getDrive]]() works again.
*The send and receive range of wireless modems now increases with altitude, allowing long range networking from high-altitude [[Computer]]s (great for GPS networks).
*[[http.request]]() now supports <code>https://</code> URLs.
*Right clicking a [[Disk Drive]] with a [[Floppy Disk]] or a Record when sneaking will insert the item into the [[Disk Drive]] automatically.
*The default size of the [[Computer]] screen has been increased.
*Several stability and security fixes: LuaJ can now no longer leave dangling threads when a [[Computer]] is unloaded, [[Turtle]]s can no longer be destroyed by tree leaves or walking off the edge of the loaded map. [[Computer]]s no longer crash when used with RedPower frames.
|align=center|1.2.5
|-
|align=center|[http://www.computercraft.info/2012/04/23/computercraft-updated-to-1-2-5/ ComputerCraft 1.33]
|
*Ported to Minecraft 1.2.5.
|align=center|1.2.5
|-
|align=center|[http://www.computercraft.info/2012/03/30/computercraft-1-32-out-now/ ComputerCraft 1.32]
|
*Ported to Minecraft 1.2.4.
*Fixed a big memory leak in LuaJ that caused extra threads to stay around forever when [[Computer]]s were shut down.
|align=center|1.2.4
|-
|align=center|[http://www.computercraft.info/2012/03/13/computercraft-1-31-is-released/ ComputerCraft 1.31]
|
*Ported to Minecraft 1.2.3.
*Added [[Monitor]]s (thanks to Cloudy). Build huge external displays for your [[Computer]]s!
*New positioning capabilities for [[Computer]]s and [[Turtle]]s. Build GPS networks and triangulate the positions of your [[Turtle]]'s position so they never get lost!
*New [[turtle.compare]]() function for [[Turtle]]s for more intelligent mining.
*New programs and APIs: [[Gps_(program)|gps]], [[Monitor_(program)|monitor]], [[Vector_(API)|vector API]].
*New program: [[Pastebin_(program)|pastebin]] (requires <code>enableAPI_HTTP=1</code> in [[ComputerCraft.cfg]]), upload and download programs made by other users ingame!
*Added a new top secret program designed for use with [[Monitor]]s, see if you can find it.
*Lots of additions to existing APIs and programs. Type "help whatsnew" in game for full details.
|align=center|1.2.3
|-
|align=center|[http://www.computercraft.info/2012/02/23/computercraft-1-3-trailer/ ComputerCraft 1.3]
|
*Ported to Minecraft Forge.
*Added [[Turtle]]s, Mining [[Turtle]]s, Wireless [[Turtle]]s and Wireless Mining [[Turtle]]s (Block ID 209).
*Added a Peripheral API to allow mod developers to create custom peripherals for ComputerCraft. Details on this will be posted in the next few days.
*Added [[Wireless Modem]]s. Use the [[Rednet_(API)|rednet API]] to send data wirelessly between [[Computer]]s and [[Turtle]]s!
*[[Computer]]s and [[Disk Drive]]s no longer get destroyed by water.
*[[Computer]]s and [[Turtle]]s can now be labelled, destroyed, and moved around, keeping their state.
*[[Computer]]s and [[Turtle]]s can connect to adjacent devices and turn them on or off.
*User programs now give line numbers in their error messages, for easier debugging.
*New APIs and programs for [[Turtle]]s: [[Turtle_(API)|turtle]], [[excavate]], [[tunnel]], [[go]], [[turn]] and [[dance]].
*Lots of additions to existing APIs and programs. Type "help whatsnew" in game for the full details.
|align=center|1.1
|-
|align=center|ComputerCraft 1.21
|
*Added shortcut key to shutdown the computer (CTRL + S).
*Added a [[Help_(API)|help API]] add-on pack.
*Various bug fixes.
|align=center|1.1
|-
|align=center|ComputerCraft 1.2
|
*Added [[Disk Drive]]s.
*Added shortcut keys to terminate the current program (CTRL + T) and reboot the computer (CTRL + R).
*Added [[os.loadAPI|a new system]] for user created APIs.
*Added [[Rednet_(API)|RedNet]].
*Added [[shell.setPath]]() and [[shell.setAlias]]().
*Added a new ROM startup script.
*Added [[os.clock]](), [[os.time]]() and [[os.setAlarm]]().
*Added game: [[Worm|"Worm!"]].
*Added programs: [[alias]], [[apis]], [[copy]], [[delete]], [[dj]], [[drive]], [[eject]], [[id]], [[label]], [[list]], [[move]], [[reboot]], [[redset]], [[rename]], [[time]].
*Added APIs: [[Bit_(API)|bit]], [[Colours_(API)|colours]], [[Disk_(API)|disk]], [[Help_(API)|help]], [[Rednet_(API)|rednet]], [[Parallel_(API)|parallel]], [[Textutils_(API)|textutils]].
*Text can be edited with left and right arrow keys.
*Many bug fixes.
|align=center|1.0
|-
|align=center|ComputerCraft 1.11
|
*Fixed bug where [[Computer]]s could not read input from RedPower cables which had a bend in the immediately adjacent square.
|align=center|1.0
|-
|align=center|ComputerCraft 1.1
|
*Changed the default block ID for the [[Computer]] to 207.
*Added multiplayer support.
*Added connectivity with RedPower bundled cables.
*Added [[HTTP_(API)|HTTP API]].
*Fixed support for HD textures on the front of [[Computer]]s.
*Added command history to the [[Computer]].
*Added [[ComputerCraft.cfg|config]] options to change the size of the [[Computer]] GUI and the text color.
*Programs with infinite loops that don't yield will no longer freeze Minecraft and will terminate after 10 seconds.
*Extended Help and fixed typos/small errors in various programs.
|align=center|1.0
|-
|align=center|ComputerCraft 1.02
|
*Fixed the MCPatcher HD textures incompatibility that was causing the computer texture to replace cobblestone blocks.
|align=center|1.0
|-
|align=center|ComputerCraft 1.01
|
*Added a ModLoader configuration file, so the computers block ID can be changed.
*Made the error message that displays when Lua files are not correctly installed much more clear, no more "Assertion failed."
|align=center|1.0
|-
|align=center|ComputerCraft 1.0
|
*First Release.
|align=center|1.0
|}

Modem message (event)

2015-12-27T10:54:26Z

Bomb Bloke:

{{lowercase}}
{{Event
|name=modem_message
|desc=Fired when any modem message arrives through an open modem channel. If the message arrived cross-dimensionally, then the distance argument is set to nil.
|return1=The side of the computer where the message was received.
|return2=The frequency that the message has been received on.
|return3=The frequency that the sender defined when sending the message.
|return4=The message received. It will remain the same type as was transmitted.
|return5=The distance (in blocks) between the two computers.
}}
{{Example
|desc=Prints details of the message received.
|code=
while true do
event, side, frequency, replyFrequency, message, distance = [[os.pullEvent]]("modem_message")
[[print]]("Message received from the open modem on the "..side.." side of this computer.")
[[print]]("Frequency: "..frequency..")
[[print]]("Requested reply frequency: "..replyFrequency..")
[[print]]("Distance: "..distance..")
[[print]]("Message is as follows: "..message)
end
|output=Will print out all details of the message received on the modem.
}}

Modem (API)

2015-12-27T10:52:30Z

Bomb Bloke:

:''This page is for the modem API. For the blocks, see [[Modem]].''

{{PeripheralAPI}}

Available to [[Wireless Modem|Wireless]], [[Ender Modem|Ender]], and [[Wired Modem|Wired]] Modems.

Modem channels are essentially networks which can be [[modem.open|opened]], [[modem.close|closed]] and [[modem_message_(event)|listened]] on by any [[Computer]] within range, without need of independant computer IDs. To interact with channels, one must [[peripheral.wrap|wrap]] or interact directly with the peripheral as opposed to the previous interaction with the [[Rednet_(API)|Rednet API]].

This is not an actual API called "modem". This is the API for [[peripheral.wrap|wrapped]] modem peripherals.

{{API table|Modem|image=Grid disk.png|2=

{{API table/row
|[[modem.isOpen|''modem''.isOpen]]({{type|number}} channel)
|{{type|boolean}} isChannelOpen
|Checks to see if ''channel'' is open.
|odd}}

{{API table/row
|[[modem.open|''modem''.open]]({{type|number}} channel)
|{{type|nil}}
|Opens ''channel'' to allow for listening. The channel specified must be larger than 0 and less than 65535.}}

{{API table/row
|[[modem.close|''modem''.close]]({{type|number}} channel)
|{{type|nil}}
|Closes an open channel to disallow listening.
|odd}}

{{API table/row
|[[modem.closeAll|''modem''.closeAll]]()
|{{type|nil}}
|Closes all open channels.}}

{{API table/row
|[[modem.transmit|''modem''.transmit]]({{type|number}} channel, {{type|number}} replyChannel, {{type|any}} message)
|{{type|nil}}
|Transmits a message on the specified channel.
|odd}}

{{API table/row
|[[modem.isWireless|''modem''.isWireless]]()
|{{type|boolean}} isWireless
|Returns if the modem is wireless or wired.}}

}}

{{Event
|name=modem_message
|return1={{type|string}} modemSide
|return2={{type|number}} senderChannel
|return3={{type|number}} replyChannel
|return4= message
|return5={{type|number}} distance
|desc=Fired when a modem message is received.}}

==Sending Messages==
Sending messages is simple and does not require that you open any channels. Simply use the transmit function like so:
local modem = [[peripheral.wrap]]("right") --Wraps the modem on the right side.

[[modem.transmit]](3, 1, "Hello world!")
[[peripheral.call]]("right", "transmit", 3, 1, "This will also work!")

What did that do? First I wrapped the peripheral in order to interact with it. Second, I used [[modem.transmit]](channel, replyChannel, message) in order to send my message. In case you were wondering, the reply channel is captured by the listening computer and suggests which channel they should reply on.

==Receiving Messages==
Receiving messages requires that you be familiar with events. As of this moment, there is no API which cuts out events from the process. Here is an example of how to receive messages:
local modem = [[peripheral.wrap]]("left")
[[modem.open]](3)--Open channel 3 so that we can listen on it
local event, modemSide, senderChannel,
replyChannel, message, senderDistance = [[os.pullEvent]]("modem_message")

print("I just received a message from: "..senderChannel)
print("I should apparently reply on: "..replyChannel)
print("The modem receiving this is located on the "..modemSide.." side")
print("The message was: "..message)
print("The sender is: "..senderDistance.." blocks away from me.")

So what did I do? Quite simply, I called [[os.pullEvent]]() with the string argument "modem_message", which blocks all other events from being returned. When the "modem_message" event is captured, it returns the arguments: event, modemSide, senderChannel, replyChannel, message, senderDistance. I captured these and then printed them out.

== Modem Limitations ==
* You can only open 128 channels at any given time.
* The maximum channel you can open is 65535.
* You can listen on more than one channel at a time. For example, if the modem has channel 3 and channel 5 open, and somebody sends a message on channel 5, the modem will receive it. If a message is sent on channel 3, the modem will also receive the message.
* Sending messages does not require you to open any channels prior to sending it.
* If you aren't receiving a message when you think you should, check to make sure that you have opened the channel first.
* Modems and channels are not secure - if you are sending a message using the Modem API, messages are still available to any computer listening on the sent channel.

[[Category:Peripheral APIs]]

Commands.getBlockInfo

2015-12-27T10:50:48Z

Bomb Bloke:

{{lowercase}}
{{Function
|name=commands.getBlockInfo
|args={{type|number}} x, {{type|number}} y, {{type|number}} z
|returns={{type|table}} block info
|api=commands
|addon=ComputerCraft
|desc=Available only to [[Command Computer]]s, returns a table containing information on the block at the specified world co-ordinate, formatted as follows:

{
state = {{type|table}} state information
name = {{type|string}} block's name,
metadata = {{type|number}} block's metadata
}

The block inspected will be in the same dimension as the computer. This function yields until the data is available to be returned. If the queried block exists in an ungenerated chunk, this function will cause that chunk to be generated.

The "state" sub-table is only present in Minecraft 1.8+, and contains the [http://minecraft.gamepedia.com/Block_states block state] info for the block being observed. For example, a log of wood's state table contains the keys "variant" (which may be set to eg "oak"), and "axis" (which may be set to eg "y", indicating an upright orientation).

See also: [[commands.getBlockInfos]](), [http://minecraft.gamepedia.com/Data_values Data Values @ Minecraft wiki]

|examples=
{{Example
|desc=Prints the [[Command Computer]]'s internal name and metadata value.
|code=local blockInfo = '''commands.getBlockInfo( [[commands.getBlockPosition]]() )'''

[[print]]( "Computer block's name: ", blockInfo.name )
[[print]]( "Computer block's metadata: ", blockInfo.metadata )
}}
{{Example
|desc=Under MC 1.8, prints the facing of the [[Command Computer]] running the script by inspecting its own block state info.
|code=local blockInfo = '''commands.getBlockInfo( [[commands.getBlockPosition]]() )'''

[[print]]( "My facing is " .. blockInfo.state.facing )
}}
{{Example
|desc=Under MC 1.7.10, prints the facing of the [[Command Computer]] running the script by inspecting its own metadata.
|code=local directions = {"unknown", "north", "south", "west", "east"}
local blockInfo = '''commands.getBlockInfo( [[commands.getBlockPosition]]() )'''

[[print]]( "My facing is ", directions[ blockInfo.metadata ], "." )
}}
}}

{{CommandsAPIFunctions}}

[[Category:API_Functions]]

Talk:Ender Modem

2015-12-27T10:37:46Z

Bomb Bloke:

Things I don't know, can't be bothered testing right now, but will need to go on the page:

* Is there a range limit on these things? ''(Yes, 2^31-1 blocks, or [http://www.computercraft.info/forums2/index.php?/topic/25318-computercraft-176-beta-information-minecraft-18-updated-december-24th/page__view__findpost__p__240074 so says SquidDev])'' They should be able to go between dimensions, but is there still a requirement for "similar" x/y/z co-ords for that to work? If so, does world height still matter? ''(Still dunno about these two points, but the range is so huge I doubt anyone'll ever find out let alone care)''
* Can Ender Modems detect transmissions from regular [[Wireless Modem]]s, and vice versa? If so, is there a range limit, and if there is, how does that work? ''(A wireless modem a couple of thousand blocks away and in another dimension can send to / receive from an ender modem just fine)''
* How well does this all work with the [[Repeat]] script? ''(Really well, as it turns out)''

- <span style="font-size:xx-small"> [[User:Bomb_Bloke|Bomb Bloke]] ([[User_talk:Bomb_Bloke|Talk]]/[[Special:Contributions/Bomb_Bloke|Contribs]])</span> 03:10, 26 December 2015 (UTC)

''Answered my own questions in italics. - <span style="font-size:xx-small"> [[User:Bomb_Bloke|Bomb Bloke]] ([[User_talk:Bomb_Bloke|Talk]]/[[Special:Contributions/Bomb_Bloke|Contribs]])</span> 10:37, 27 December 2015 (UTC)''

Ender Modem

2015-12-27T10:30:57Z

Bomb Bloke: More info

:''This page is for the Modem blocks. For the modem API, see [[Modem_(API)|Modem (API)]]''
{{Block
|name=Ender Modem
|image=EnderModem.png
|id=computercraft:advanced_modem
|damage-value=0
|is-peripheral=Yes
|peripheral-api=Modem (API)
}}
'''Ender Modems''' are advanced versions of the [[Wireless Modem]], introduced by ComputerCraft version 1.76 (for Minecraft 1.8). They use the same [[Modem_(API)|Modem API]], but are capable of cross-dimensional transmissions.

They have an extreme range, capable of transmitting across distances of up to 2,147,483,647 blocks (2^31-1), and are compatible with regular Wireless Modem signals. If the modems are not located with the same dimension, however, then the "distance" parameter will be excluded from the resulting [[modem_message (event)|modem_message events]].

Whether or not communications between two modems are possible depends only on the range of the stronger of the two. This means, for example, that a single system running the [[Repeat]] script through an Ender Modem effectively opens up [[Rednet (API)|Rednet]] communications between regular Wireless modems server-wide; while one Ender Modem-equipped [[Gps (API)|GPS cluster]] per dimension is sufficient to handle most all location requests.

See also: [[Wired Modem]], [[Wireless Modem]].

== Recipe ==
{{Crafting grid
|A1=Gold_Ingot |B1=Gold_Ingot |C1=Gold_Ingot
|A2=Gold_Ingot |B2=Eye_of_Ender |C2=Gold_Ingot
|A3=Gold_Ingot |B3=Gold_Ingot |C3=Gold_Ingot
|Output=Ender_Modem
}}

== Example (Modem API)==
* Place 2 computers and add modems to them by clicking the right mouse button while sneaking.
* Access them, and start Lua.
* Once Lua has started, wrap your modem using peripheral.wrap() (something like "modem = peripheral.wrap("<side of modem>")
* Type "[[modem_(API)|modem.open]] (<A modem port number, anything from 1 to 65535>)" on one computer.
* Check if there exists a connection: a dim, red light should be found on the modem.
* Now, type "[[modem_(API)|modem.transmit]] (<Same number as above>, <Also the same number>, 'Your message')" on the other computer. This should send your message to all computers connected.
* Opening the first computer should show the message written on the second computer.

==Modem as a Peripheral==
To use a Modem as a peripheral, you need to either call a method directly using [[peripheral.call]](), or, wrap the modem using the [[Peripheral_(API)|Peripheral API]]. Wrapped modems provide all functions listed in the [[Modem_(API)|Modem API]].

For this example, we have a Modem connected to the top of our [[Computer]], we are going to open channel 5:

''-- Immediately invoke a method without wrapping''
[[peripheral.call]]( "top", "open", 5 )

''-- You can also "wrap" the peripheral side to a variable:''
local modem = [[peripheral.wrap]]( "top" )
[[modem.open]]( 5 )

{{BlocksItemsList}}

Eye of Ender

2015-12-27T10:28:54Z

Bomb Bloke: Created page with "[http://www.minecraftwiki.net/wiki/Eye_of_Ender Eye of Ender at Minecraft Wiki] Category:Vanilla_Minecraft"

[http://www.minecraftwiki.net/wiki/Eye_of_Ender Eye of Ender at Minecraft Wiki]

[[Category:Vanilla_Minecraft]]

Template:CommandsAPIFunctions

2015-12-26T04:10:43Z

Bomb Bloke: commands.getBlockInfos()

<center>
{| class="wikitable"
! style="background: #D3FFC2; text-align: center" | [[File:Grid_disk.png|18px]] [[Commands (API)|Commands API]] Functions
|-
|[[commands.exec]] - [[commands.execAsync]] - [[commands.list]] - [[commands.getBlockPosition]] - [[commands.getBlockInfo]] - [[commands.getBlockInfos]]
|}
</center>

Commands.getBlockInfos

2015-12-26T04:10:31Z

Bomb Bloke: Created page with "{{lowercase}} {{Function |name=commands.getBlockInfos |args={{type|number}} x1, {{type|number}} y1, {{type|number}} z1, {{type|number}} x2, {{type|number}} y2, {{type|number}}..."

{{lowercase}}
{{Function
|name=commands.getBlockInfos
|args={{type|number}} x1, {{type|number}} y1, {{type|number}} z1, {{type|number}} x2, {{type|number}} y2, {{type|number}} z2
|returns={{type|table}} blocks info
|api=commands
|addon=ComputerCraft
|desc=Available only to [[Command Computer]]s as of ComputerCraft version 1.76, returns a numerically-indexed table containing information on the blocks within the specified world co-ordinates. Each sub-table is formatted per the output of [[commands.getBlockInfo]]():

{
state = {{type|table}} state information
name = {{type|string}} block's name,
metadata = {{type|number}} block's metadata
}

A maximum of 4096 (2^12) blocks may be inspected at a time (for example, a 16x16x16 cube); the function will error if the block count exceeds this.

The blocks are returned in the order of lowest x-co-ord to highest x-co-ord, then lowest z-co-ord to highest z-co-ord, then lowest y-co-ord to highest y-co-ord; that is to say, west to east, then north to south, then lowest altitude to highest altitude.

See also: [[commands.getBlockInfo]](), [http://minecraft.gamepedia.com/Data_values Data Values @ Minecraft wiki]

|examples=
{{Example
|desc=Reports on a 2x2x2 area, with the Command Computer being at the lowest north-west point.
|code=local x, y, z = commands.getBlockPosition()

local blocks = commands.getBlockInfos(x, y, z, x + 1, y + 1, z + 1)

print("North-west low block:"..blocks[1].name)
print("North-east low block:"..blocks[2].name)
print("South-west low block:"..blocks[3].name)
print("South-east low block:"..blocks[4].name)
print("North-west high block:"..blocks[5].name)
print("North-east high block:"..blocks[6].name)
print("South-west high block:"..blocks[7].name)
print("South-east high block:"..blocks[8].name)
}}
}}

{{CommandsAPIFunctions}}

[[Category:API_Functions]]

Commands.getBlockInfo

2015-12-26T03:40:32Z

Bomb Bloke: See also

{{lowercase}}
{{Function
|name=commands.getBlockInfo
|args={{type|number}} x, {{type|number}} y, {{type|number}} z
|returns={{type|table}} block info
|api=commands
|addon=ComputerCraft
|desc=Available only to [[Command Computer]]s, returns a table containing information on the block at the specified world co-ordinate, formatted as follows:

{
state = {{type|table}} state information
name = {{type|string}} block's name,
metadata = {{type|number}} block's metadata
}

The block inspected will be in the same dimension as the computer. This function yields until the data is available to be returned. If the queried block exists in an ungenerated chunk, this function will cause that chunk to be generated.

The "state" sub-table is only present in Minecraft 1.8+, and contains keys relevant to the block being observed. For example, a log of wood's state table contains the keys "variant" (which may be set to eg "oak"), and "axis" (which may be set to eg "y", indicating an upright orientation).

See also: [[commands.getBlockInfos]](), [http://minecraft.gamepedia.com/Data_values Data Values @ Minecraft wiki]

|examples=
{{Example
|desc=Prints the [[Command Computer]]'s internal name and metadata value.
|code=local blockInfo = '''commands.getBlockInfo( [[commands.getBlockPosition]]() )'''

[[print]]( "Computer block's name: ", blockInfo.name )
[[print]]( "Computer block's metadata: ", blockInfo.metadata )
}}
{{Example
|desc=Prints the facing of the [[Command Computer]] running the script by inspecting its own metadata.
|code=local directions = {"unknown", "north", "south", "west", "east"}
local blockInfo = '''commands.getBlockInfo( [[commands.getBlockPosition]]() )'''

[[print]]( "My facing is ", directions[ blockInfo.metadata ], "." )
}}
}}

{{CommandsAPIFunctions}}

[[Category:API_Functions]]

Commands (API)

2015-12-26T03:39:40Z

Bomb Bloke: commands.getBlockInfos()

Only available to the fabled [[Command Computer]] (itself only available to ops in creative mode, running CC 1.7 or later), the '''commands API''' allows your system to directly execute [http://minecraft.gamepedia.com/Commands Minecraft commands] and gather data from the results.

==API==
{{API table|commands|image=Grid_disk.png|2=

{{API table/row
|[[commands.exec]]({{type|string}} command)
|{{type|boolean}} success, {{type|table}} output
|Executes the specified command, yields until the result is determined, then returns it.
|odd}}

{{API table/row
|[[commands.execAsync]]({{type|string}} command)
|{{type|number}} taskID
|Executes the specified command, but doesn't yield. Queues a [[task_complete_(event)|"task_complete"]] event after the command is executed.
|}}

{{API table/row
|[[commands.list]]()
|{{type|table}} commands
|Returns a numerically indexed table filled with strings representing acceptable commands for [[commands.exec]]() / [[commands.execAsync]]().
|odd}}

{{API table/row
|[[commands.getBlockPosition]]()
|{{type|number}} x, {{type|number}} y, {{type|number}} z
|Returns the Minecraft world coordinates of the computer running the command.
|}}

{{API table/row
|[[commands.getBlockInfo]]({{type|number}} x, {{type|number}} y, {{type|number}} z)
|{{type|table}} block info
|Returns a table containing info about the block at the specified world location. Keys are "name" (a string) and "metadata" (a number).
|odd}}

{{API table/row
|[[commands.getBlockInfos]]({{type|number}} x1, {{type|number}} y1, {{type|number}} z1, {{type|number}} x2, {{type|number}} y2, {{type|number}} z2)
|{{type|table}} blocks info
|Returns a table containing sub-tables with info about the blocks within the specified world locations. ''Added by CC 1.76''
|}}

}}

__TOC__

==commands.<command>()/commands.async.<command>()==
Every command returned by [[commands.list]]() is available as commands.''command'' and commands.async.''command''. For example, instead of writing this:

[[commands.exec]]("say Hi")

...you can write:

commands.say("Hi")

Same with async:

[[commands.execAsync]]("say Hi")
''-- same as:''
commands.async.say("Hi")

On top of that you can pass to them multiple parameters including strings, numbers, booleans and tables. All those parameters are [[textutils.serializeJSON|serialized]] if necessary (such as tables) and concatenated into one string. All these functions will run the same command with the same parameters:

[[commands.exec]]("tellraw @p {text:'Hello!',bold:true}")

commands.tellraw("@p {text:'Hello!',bold:true}") ''-- one or more parameters may be put into one string''

commands.tellraw("@p", "{text:'Hello!',bold:true}") ''-- or you can separate them to different parameters''

commands.tellraw("@p", {text="Hello!", bold=true}) ''-- you can also pass a {{type|table}} directly to it''

The same applies for commands.async.<command>().

All the commands inside commands.<command>()/commands.async.<command>() are also case insensitive. Running commands.TellRAW( ... ) is the same as running commands.tellraw( ... ).

==Notes==
*ComputerCraft enforces a limit of 1000 commands per server tick on Command Computers. Consider [[os.pullEvent|yielding]] manually every so often (eg, sleeping for a second) when making large amounts of [[commands.execAsync]] calls.

[[Category:APIs]]

Rednet (API)

2015-12-26T03:16:57Z

Bomb Bloke: Ender Modem

''For a tutorial on how to use the API, visit [[Rednet Tutorial]].''

The Rednet API allows systems to communicate between each other without using redstone. It serves as a wrapper for the [[modem (API)|modem API]], offering ease of functionality (particularly in regards to [[Repeat|repeating signals]]) with some expense of fine control.

In order to send and receive data, a [[modem]] (either [[Wired Modem|wired]], [[Wireless Modem|wireless]], or [[Ender Modem|ender]]) is required. The data reaches any possible destinations immediately after sending it, but is [[#Range|range limited]].

==API==
{{API table|rednet|image=Grid_disk.png|2=

{{API table/row
|[[rednet.open]]({{type|string}} side)
|{{type|nil}}
|Tells the computer that the side can be used for networking.}}

{{API table/row
|[[rednet.close]]({{type|string}} side)
|{{type|nil}}
|Tells the computer that the side can no longer be used for networking.
|odd}}

{{API table/row
|[[rednet.send]]({{type|number}} receiverID, {{type|any}} message, [<nowiki/>{{type|string}} protocol])
|{{type|nil}}
|Sends a message "intended" for another system with a specific ID, using the currently opened sides. The <var>receiverID</var> is the ID {{type|number}} (note - '''not''' a {{type|string}}) of the computer you're sending the message to. The [[Variables|types]] that can be sent as the message vary depending on the version of ComputerCraft in use.}}

{{API table/row
|[[rednet.broadcast]]({{type|any}} message, [<nowiki/>{{type|string}} protocol])
|{{type|nil}}
|Sends the message to ''all'' connected and open computers.
|odd}}

{{API table/row
|[[rednet.receive]]([<nowiki/> [<nowiki/>{{type|string}} protocolFilter, ] {{type|number}} timeout])
|{{type|number}} senderID, {{type|any}} message, {{type|number}} distance / {{type|string}} protocol
|Waits until a rednet message of the specified protocol has been received, or until <var>timeout</var> seconds have passed. Leave all arguments empty to wait for any message indefinitely. If only a single, numerical argument is passed, will wait that many seconds for a message of any protocol. Versions of ComputerCraft prior to 1.6 may return the distance to the transmitting computer - 1.6 or later returns message protocols instead, though distance can still be obtained via direct use of the [[Modem (API)|Modem API]].}}

{{API table/row
|[[rednet.isOpen]]({{type|string}} side)
|{{type|boolean}} isOpen
|Returns [[Boolean_(type)|true]] if the wireless modem is open.
|odd}}

{{API table/row
|[[rednet.host]]({{type|string}} protocol, {{type|string}} hostname)
|{{type|nil}}
|Registers <var>hostname</var> against <var>protocol</var> for the purposes of [[rednet.lookup]](). '''Only available in ComputerCraft 1.6 and above.'''}}

{{API table/row
|[[rednet.unhost]]({{type|string}} protocol, {{type|string}} hostname)
|{{type|nil}}
|Unregisters <var>hostname</var> from <var>protocol</var>. '''Only available in ComputerCraft 1.6 and above.'''
|odd}}

{{API table/row
|[[rednet.lookup]]({{type|string}} protocol, {{type|string}} hostname)
|{{type|number}} ID1, {{type|number}} ID2, ...
|Searches the local network for systems registered with a matching <var>hostname</var> and/or <var>protocol</var>, and returns matching IDs found. '''Only available in ComputerCraft 1.6 and above.'''
}}

{{API table/row
|[[rednet.run]]()
|{{type|nil}}
|Internal use function - runs automatically and does not need to be called directly. Waits for [[Modem_message_(event)|modem_message]] events to appear within the event queue and generates corresponding [[Rednet_message_(event)|rednet_message]] events for use with this API. Also responds to [[rednet.lookup]]() requests.
|odd}}

}}

==Events==
{{Event|name=[[rednet_message_(event)|rednet_message]]
|desc=Fired when a rednet message is received (can be pulled via [[os.pullEvent|os.pullEvent()]] directly as an alternative to using [[rednet.receive|rednet.receive()]]).
|return1={{type|number}} senderId
|return2={{type|any}} message
|return3={{type|number}} distance / {{type|string}} protocol
}}

==Range==
The range of a wireless network transmission can be determined via the following formula:

minRange + (position.yCoord - 96.0) * ((maxRange - minRange) / ((world.getHeight() - 1) - 96.0))

Where, by default:

minRange = 64 (or 16 in a storm)
maxRange = 384 (or 96 in a storm)
world.getHeight() = 256

Catch is, that formula is quite capable of returning values that are well below 0... More research is required, it seems. Anyway, min/max range figures can be altered in [[ComputerCraft.cfg]], and the maximum range of a system located at world height will generally be equal to the maxRange for the current weather.

Even for the purposes of two-way communications, only the system with the best range is checked - a system located at the bottom of the world may hence send to and receive from a system at the top. Range is calculated in three dimensions, so the area a given system can reach wirelessly is represented by a sphere.

For wired networks, range between devices is 256 blocks of [[Networking_Cable|network cable]] (unconfigurable). Either method of communication works regardless as to whether the intervening chunks are loaded or not.

As of ComputerCraft 1.6, a [[Repeat|repeater script]] is available to all systems by default.

==Protocols==
Introduced by ComputerCraft 1.6, "protocols" are simple string names indicating what [[rednet.send|sent messages]] are about. [[rednet.receive|Receiving systems]] may filter messages according to their protocols, thereby automatically ignoring incoming messages which don't specify an identical string. It's also possible to [[rednet.lookup|lookup]] which systems in the area are interested in certain protocols, hence making it easier to determine where given messages should be sent in the first place.

==History==
Before the creation of the in-game wireless networking API, the term "Rednet" referred to a system created by a ComputerCraft user based on bundled cables from the popular Minecraft mod [http://www.eloraam.com RedPower]. That also allowed communication between computers, but the data was transferred slowly - every bit was converted to redstone signal (using the [[redstone (API)|redstone API]]) that lasted about 0.05 seconds (the length of a Minecraft "tick"). That system was rendered redundant by the release of ComputerCraft 1.3, as this heralded the arrival of [[Wireless Modem|wireless networking]] to the mod and allowed instant communications between computers.

Later, ComputerCraft 1.51 brought forward [[Wired Modem]]s, which could not only be used for regular network communications, but to interact with [[peripheral]]s remotely.

==Security==
In current versions of ComputerCraft (1.5 or later), Rednet is not to be considered a "secure" method of communication. The identity data indicating who sent a given message is set ''by the sender'', and hence cannot be trusted. Messages intended for a given system may be received and read by any other system in range.

This is because Rednet is simply a convenience wrapper for the [[modem (API)|modem API]], and while it typically sends/receives using channel numbers matching the IDs of systems you control, the latter offers ''complete control'' over channel usage. Another user can hence easily task the modem API directly to sniff and find out what messages a computer is receiving if he knows (or can even guess) its ID, or pretend to send from any ID he wishes.

When using Rednet for anything with security implications, be sure to implement your own methods of protection.

==Deprecated Functions==
{{Deprecated
|plural=yes
|type=These functions
}}

{{API table|Deprecated Rednet Functions|image=Grid disk.png|2=

{{API table/row
|[[rednet.announce]]()
|{{type|nil}}
|Broadcasts an empty rednet message. Removed from ComputerCraft by version ''1.5'' in favor of [[rednet.broadcast]]()
|odd}}

}}

[[Category:APIs]]

Modem

2015-12-26T03:15:43Z

Bomb Bloke: Ender Modem

Modems are a peripheral which allow computers to communicate with other computers.

==Wireless Modems==
[[Wireless Modem|Wireless modems]] allow communication wirelessly between computers through channels.
==Ender Modems==
[[Ender Modem|Ender modems]] act as long-distance wireless modems, and are capable of cross-dimensional communications.
==Wired Modems==
[[Wired Modem|Wired modems]] allow communication through Networking Cables to other computers, and also allow long-distance peripheral usage.

[[Category:Disambiguation_Pages]]

Talk:Ender Modem

2015-12-26T03:10:21Z

Bomb Bloke: Created page with "Things I don't know, can't be bothered testing right now, but will need to go on the page: * Is there a range limit on these things? They should be able to go between dimensi..."

Things I don't know, can't be bothered testing right now, but will need to go on the page:

* Is there a range limit on these things? They should be able to go between dimensions, but is there still a requirement for "similar" x/y/z co-ords for that to work? If so, does world height still matter?
* Can Ender Modems detect transmissions from regular [[Wireless Modem]]s, and vice versa? If so, is there a range limit, and if there is, how does that work?
* How well does this all work with the [[Repeat]] script?

- <span style="font-size:xx-small"> [[User:Bomb_Bloke|Bomb Bloke]] ([[User_talk:Bomb_Bloke|Talk]]/[[Special:Contributions/Bomb_Bloke|Contribs]])</span> 03:10, 26 December 2015 (UTC)

Ender Modem

2015-12-26T03:05:22Z

Bomb Bloke: Created page with "{{Stub}} :''This page is for the Modem blocks. For the modem API, see Modem (API)'' {{Block |name=Ender Modem |image=EnderModem.png |id=computercraft:advanced_..."

{{Stub}}
:''This page is for the Modem blocks. For the modem API, see [[Modem_(API)|Modem (API)]]''
{{Block
|name=Ender Modem
|image=EnderModem.png
|id=computercraft:advanced_modem
|damage-value=0
|is-peripheral=Yes
|peripheral-api=Modem (API)
}}
'''Ender Modems''' are advanced versions of the [[Wireless Modem]], introduced by ComputerCraft version 1.76 (for Minecraft 1.8). They use the same [[Modem_(API)|Modem API]], but are capable of cross-dimensional transmissions.

See also: [[Wired Modem]], [[Ender Modem]].

== Recipe ==
{{Crafting grid
|A1=Gold_Ingot |B1=Gold_Ingot |C1=Gold_Ingot
|A2=Gold_Ingot |B2=Eye_of_Ender |C2=Gold_Ingot
|A3=Gold_Ingot |B3=Gold_Ingot |C3=Gold_Ingot
|Output=Ender_Modem
}}

== Example (Modem API)==
* Place 2 computers and add modems to them by clicking the right mouse button while sneaking.
* Access them, and start Lua.
* Once Lua has started, wrap your modem using peripheral.wrap() (something like "modem = peripheral.wrap("<side of modem>")
* Type "[[modem_(API)|modem.open]] (<A modem port number, anything from 1 to 65535>)" on one computer.
* Check if there exists a connection: a dim, red light should be found on the modem.
* Now, type "[[modem_(API)|modem.transmit]] (<Same number as above>, <Also the same number>, 'Your message')" on the other computer. This should send your message to all computers connected.
* Opening the first computer should show the message written on the second computer.

==Modem as a Peripheral==
To use a Modem as a peripheral, you need to either call a method directly using [[peripheral.call]](), or, wrap the modem using the [[Peripheral_(API)|Peripheral API]]. Wrapped modems provide all functions listed in the [[Modem_(API)|Modem API]].

For this example, we have a Modem connected to the top of our [[Computer]], we are going to open channel 5:

''-- Immediately invoke a method without wrapping''
[[peripheral.call]]( "top", "open", 5 )

''-- You can also "wrap" the peripheral side to a variable:''
local modem = [[peripheral.wrap]]( "top" )
[[modem.open]]( 5 )

{{BlocksItemsList}}