element.setData: Difference between revisions

no edit summary
No edit summary
No edit summary
Line 4: Line 4:
|class = Element
|class = Element
|name = setData
|name = setData
|parametersSS = string dataName, var theData, bool syncWithClients = true
|parametersSS = string dataName, var theData, bool syncWithClientsNow = true
|parametersCS = string dataName, var theData
|parametersCS = string dataName, var theData
|parameter1 = string dataName The string name of the data for the element.
|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.
|parameter2 = var theData The data for the element, which is referenced by dataName.
|parameter3 = bool syncWithClients Whether '''dataName''' and '''theData''' are sent to all clients. This only applies when the method is used server-side.
|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
|returnTypes = void
|returnInfo = void
|returnInfo = void
|returnFail1 = void
|returnFail1 = void
|usage = sets info, referenced by name
|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.
|notes = The third arg (syncWithClients) is not available client side.
|notes = The third arg (syncWithClients) is not available client side.
}}
}}
6,833

edits