TR/setElementData: Difference between revisions
Jump to navigation
Jump to search
(→Syntax) |
|||
Line 1: | Line 1: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | |||
<syntaxhighlight lang="lua"> | bool setElementData ( element theElement, string key, var value [, bool synchronize = true ] ) | ||
{{OOP||[[ | </syntaxhighlight> | ||
{{OOP||[[element]]:setData||getElementData}} | |||
===Required Arguments=== | |||
*'''theElement:''' The [[element]] you wish to attach the data to. | |||
*'''key:''' The key you wish to store the data under. (Maximum 31 characters.) | |||
*'''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 (client-side variation) and remote clients (both variations). | |||
===Returns=== | |||
Returns ''true'' if the data was set succesfully, ''false'' otherwise. | |||
===Issues=== | |||
{{Issues| | |||
{{Issue|7389|[Fixed in 1.3.5-7389] Problem with floating numbers}} | |||
}} | |||
==Example== | ==Example== |
Revision as of 17:11, 21 May 2017
Syntax
bool setElementData ( element theElement, string key, var value [, bool synchronize = true ] )
OOP Syntax Help! I don't understand this!
- Method: element:setData(...)
- Counterpart: getElementData
Required Arguments
- theElement: The element you wish to attach the data to.
- key: The key you wish to store the data under. (Maximum 31 characters.)
- 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 (client-side variation) and remote clients (both variations).
Returns
Returns true if the data was set succesfully, false otherwise.
Issues
Issue ID | Description |
---|---|
#7389 | [Fixed in 1.3.5-7389] Problem with floating numbers |