element.setData: Difference between revisions

element.setData (view source)

90 bytes added , 19 November 2022

no edit summary

6,833

edits

@@ Line 1: / Line 1: @@
-{{ScriptItem
+{{ScriptItem2
-|endpoint = shared
+|name = setData
+|side = shared
 |type = method
 |class = Element
-|name = setData
+|games = iii vc sa iv
-|parametersSS = string dataName, var theData, bool syncWithClients = true
+|desc = set a value for an element, referenced by a key.<br>
-|parametersCS = string dataName, var theData
+The data will be sent to all clients when streaming in, so do not use element.setData() to store sensitive data like passwords.
-|parameter1 = string dataName The string name of the data for the element.
+|arg1 = string dataName The string name of the data for the element.
-|parameter2 = var theData The data for the element, which is referenced by dataName.
+|arg2 = 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.
+|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.
-|returnTypes = void
+|return = void void
-|returnInfo = void
+|freturn = void
-|returnFail1 = void
+|note = The third arg (syncWithClients) is not available client side.
-|usage = sets info, referenced by name
-|notes = The third arg (syncWithClients) is not available client side.
 }}