SetElementData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 6: Line 6:
<section name="Client" class="client" show="false">
<section name="Client" class="client" show="false">
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, [bool synchronize] var value )
bool setElementData ( element theElement, string key, [bool synchronize], var value )
</syntaxhighlight>  
</syntaxhighlight>  
</section>  
</section>  
Line 19: Line 19:
*'''key:''' The key you wish to store the data under.
*'''key:''' The key you wish to store the data under.
*'''value:''' The value you wish to store. See [[element data]] for a list of acceptable datatypes.
*'''value:''' The value you wish to store. See [[element data]] for a list of acceptable datatypes.
===Optional Arguments===
*'''synchronize:''' Determines whether or not the data will be synchronized with the server and remote clients.


===Returns===
===Returns===

Revision as of 17:31, 14 February 2008

This function stores element data under a certain key, attached to an element. Element data set using this is then synced with all clients or the server (depending if used client-side or not). As such you should avoid passing data that is not able to be synced into this function (i.e. xmlnodes, acls, aclgroups etc.) Server-created elements are able to be synced.

Syntax

Click to expand [+]
Client
Click to collapse [-]
Server
bool setElementData ( element theElement, string key, var value )

Required Arguments

  • theElement: The element you wish to attach the data to.
  • key: The key you wish to store the data under.
  • value: The value you wish to store. See element data for a list of acceptable datatypes.

Optional Arguments

  • synchronize: Determines whether or not the data will be synchronized with the server and remote clients.

Returns

Returns true if the data was set succesfully, false otherwise.

Example

Click to expand [+]
Server

See Also