Set: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Fixed list of unallowed types) |
||
| Line 10: | Line 10: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''settingName:''' The name of the setting you want to set. See [[settings system#names]] for information on settings names. | *'''settingName:''' The name of the setting you want to set. See [[settings system#names]] for information on settings names. | ||
*'''value:''' The value to set the setting to. This can be any data type, except for | *'''value:''' The value to set the setting to. This can be any Lua data type, except for functions, most userdata (only [[resources]] can be stored) and threads. | ||
===Returns=== | ===Returns=== | ||
Returns | Returns ''true'' if the setting has been set, ''false'' if you do not have access to the setting or invalid arguments were passed. | ||
==Example== | ==Example== | ||
Revision as of 18:14, 14 September 2007
This function is part of the settings system. It can be used to save arbitrary data for future use.
Syntax
bool set ( string settingName, var value )
Required Arguments
- settingName: The name of the setting you want to set. See settings system#names for information on settings names.
- value: The value to set the setting to. This can be any Lua data type, except for functions, most userdata (only resources can be stored) and threads.
Returns
Returns true if the setting has been set, false if you do not have access to the setting or invalid arguments were passed.
Example
This example sets a setting called respawnTime with a value of 1000. This is a local setting belonging to the resource that the code is run in.
set ( "respawnTime", 1000 )