Settings (API) - Revision history

Bomb Bloke: Set script link

2016-06-11T03:40:26Z

Set script link

Bomb Bloke: .settings

2016-06-10T03:38:30Z

.settings

Dan200 at 19:41, 18 January 2016

2016-01-18T19:41:58Z

MKlegoman357: Created page with "{{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 se..."

2016-01-15T22:12:56Z

Created page with "{{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 se..."

New page

{{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.

{{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)

<pre>
{
[ "bios.use_multishell" ] = true,
[ "shell.autocomplete" ] = true,
[ "shell.allow_disk_startup" ] = false,
[ "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.

==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>

@@ Line 1: / Line 1: @@
 {{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.
+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.
 {{API table|settings|image=Grid_disk.png|2=
@@ Line 48: / Line 50: @@
 ==Notes==
-* Settings are '''not''' automatically saved to a file, you have to do this [[settings.save|manually]].
+* 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}}.

@@ Line 1: / Line 1: @@
 {{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.
+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=
@@ Line 53: / Line 53: @@
 ==Default Settings==
-These are the default settings of a computer (as seen in CC 1.77)
+These are the default settings of a computer (as seen in CC 1.77 and later):
 <pre>
@@ Line 59: / Line 59: @@
    [ "bios.use_multishell" ] = true,
    [ "shell.autocomplete" ] = true,
-   [ "shell.allow_disk_startup" ] = true (for all Computer types except Command Computers),
+   [ "shell.allow_disk_startup" ] = true  --# (for all Computer types except Command Computers),
    [ "shell.allow_startup" ] = true,
    [ "lua.autocomplete" ] = true,
@@ Line 74: / Line 74: @@
 *'''<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.
 ==ComputerCraft.cfg==