Difference between revisions of "Set"

From Multi Theft Auto: Wiki
m
(Adding a example Command)
Line 17: Line 17:
  
 
==Example==
 
==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.
+
This example sets a specified setting with a Value. This is a ''local'' setting belonging to the resource that the code is run in.
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
set ( "respawnTime", 1000 )
+
function setAclRights(playerElement, commandName, acl, value, type)
 +
  if not acl or not value then
 +
      return outputChatBox("Syntax: /setacl <acl> <value>")
 +
  end
 +
  set ( acl, value )
 +
  outputChatBox("Acl "..acl.." value set to "..value)
 +
  print(getPlayerName(playerElement).." has changed "..acl.." to "..value)
 +
end
 +
addCommandHandler("setacl", setAclRights)
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
 
==See Also==
 
==See Also==
 
{{Settings registry functions}}
 
{{Settings registry functions}}

Revision as of 11:58, 3 May 2010

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 specified setting with a Value. This is a local setting belonging to the resource that the code is run in.

function setAclRights(playerElement, commandName, acl, value, type)
   if not acl or not value then
      return outputChatBox("Syntax: /setacl <acl> <value>")
   end
   set ( acl, value )
   outputChatBox("Acl "..acl.." value set to "..value)
   print(getPlayerName(playerElement).." has changed "..acl.." to "..value)
end
addCommandHandler("setacl", setAclRights)


See Also