Set

	This article needs checking.
	Reason(s): get allows retrieval of multiple values if the setting has multiple values in the settings.xml (e.g. [ "hah1","hah2","hah3" ] retrieves "hah1","hah2","hah3"). set however does not allow for setting these multiple values, even though get can retrieve them. The only way to set multiple values to a setting is to modify the xml. Therefore unlimited params should be given to set.

This function is used to save arbitrary data under a certain name on the settings registry.

It's important to note that set always writes to the settings.xml file, even if get read the value from a resource's meta.xml. This means that the admin can specify settings in the settings.xml that override the resource's defaults, but that the defaults can still be retrieved if need be. As a general principle, resources should not be designed so that the admin is required to modify them, they should be 'black boxes'.

Syntax

bool set ( string settingName, var value )

Required Arguments

• settingName: The name of the setting you want to set. See setting 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't 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 )

See Also

• get
• set