element.setData: Difference between revisions

no edit summary
No edit summary
No edit summary
 
Line 1: Line 1:
{{ScriptItem
{{ScriptItem2
|endpoint = shared
|name = setData
|side = shared
|type = method
|type = method
|class = Element
|class = Element
|name = setData
|games = iii vc sa iv
|parametersSS = string dataName, var theData, bool syncWithClientsNow = true
|desc = set a value for an element, referenced by a key.<br>
|parametersCS = string dataName, var theData
|parameter1 = string dataName The string name of the data for the element.
|parameter2 = var theData The data for the element, which is referenced by dataName.
|parameter3 = bool syncWithClientsNow Whether the data is sent to clients immediately.<br>Note that all element data will be sent to a client when the element streams in.<br>This argument only applies when the method is used server-side.
|returnTypes = void
|returnInfo = void
|returnFail1 = void
|usage = set a value for an element, referenced by a key.<br>
The data will be sent to all clients when streaming in, so do not use element.setData() to store sensitive data like passwords.
The data will be sent to all clients when streaming in, so do not use element.setData() to store sensitive data like passwords.
|notes = The third arg (syncWithClients) is not available client side.
|arg1 = string dataName The string name of the data for the element.
|arg2 = var theData The data for the element, which is referenced by dataName.
|arg3 = bool syncWithClientsNow Whether the data is sent to clients immediately.<br>Note that all element data will be sent to a client when the element streams in.<br>This argument only applies when the method is used server-side.
|return = void void
|freturn = void
|note = The third arg (syncWithClients) is not available client side.
}}
}}
6,834

edits