Difference between revisions of "Settings.clear"

From ComputerCraft Wiki
Jump to: navigation, search
(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...")
 
m (Extra link.)
 
Line 5: Line 5:
 
|api=settings
 
|api=settings
 
|addon=ComputerCraft
 
|addon=ComputerCraft
|desc=Simply wipes all currently loaded settings.<br><br>
+
|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 settings cleared on boot, then settings.clear() must be called on startup.
+
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.
 
}}
 
}}
  

Latest revision as of 03:14, 10 June 2016


Grid Redstone.png  Function settings.clear
Simply wipes all currently loaded settings. Compare settings.unset(), which wipes one setting at a time.

Note that when the system reboots, first the 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.
Syntax settings.clear()
Returns nil
Part of ComputerCraft
API settings


Grid disk.png Settings API Functions
settings.set - settings.get - settings.unset - settings.clear - settings.getNames - settings.load - settings.save