Revision as of 05:50, 13 January 2024

Script error: The function "ProtoFlux" does not exist.

Inputs

* (AsyncImpulse)

Will Write the cloud variable upon impulse. Is restricted by cloud variable rate limits.

Path (String)

The definition owner + "." + The variable name.
Examples: "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool"

VariableOwnerId (String)

The id of the person writing a value to the variable specified in Path.
Examples: "U-Frooxius", "U-Nexulan"

Value (Generic)

The value you want to write to this cloud variable.
Examples: colorX, float3, String, DateTime.

Outputs

OnDone (Impulse)

The impulse during which Value will have written the data.

OnFail (Impulse)

The impulse caused if the variable hit an error. including but not limited to: Invalid Path, improper permissions for the variable definition in Path, Invalid userID.

OnRequest (AsyncImpulse)

An async impulse sent when the node has sent the request for the value to be written. This can be used to chain more asynchronous calls together to happen in parallel like more writing to other variable definitions.

@@ Line 1: / Line 1: @@
 [[Category:NodeMenu]]
-=== Writing to a variable using the "Write Cloud Variable" === <!--T:3-->
+{{#Invoke:Test|ProtoFlux|
-{| class="wikitable"
+Name=Write Cloud Variable`1
-|-
+|Inputs=
-! Connector
+[
-! Description
+{"Name":"*", "Type":"AsyncImpulse"},
-! Examples
+{"Name":"Path", "Type":"String"},
-|-
+{"Name":"VariableOwnerId", "Type":"String"},
-| Impulse (INPUT)
+{"Name":"Value", "Type":"Dummy"}
-| Will Write the cloud variable upon impulse. Is restricted by cloud variable rate limits.
+]
-| Async Call input.
+|Outputs=
-|-
+[
-| Path (INPUT)
+{"Name":"OnRequest", "Type":"AsyncImpulse"},
-| The definition owner + "." + The variable name.
+{"Name":"OnDone", "Type":"Impulse"},
-| "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool"
+{"Name":"OnFail", "Type":"Impulse"}
-|-
+]
-| VariableOwnerID (INPUT)
+|}}
-| The id of the person writing a value to the variable specified in Path.
-| "U-Frooxius", "U-Nexulan"
+= Inputs = <!--T:3-->
-|-
-| Value (INPUT)
+== * (AsyncImpulse) ==
-| The value you want to write to this cloud variable.
+Will Write the cloud variable upon impulse. Is restricted by cloud variable rate limits.
-| colorX, float3, String, DateTime.
-|-
+== Path (String) ==
-| OnDone (OUTPUT)
+The definition owner + "." + The variable name.
-| The impulse during which Value will have written the data.
+<br>Examples: "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool"
-| Synchronous output
-|-
+== VariableOwnerId (String) ==
-| OnFail (OUTPUT)
+The id of the person writing a value to the variable specified in Path.
-| The impulse caused if the variable hit an error. including but not limited to: Invalid Path, improper permissions for the variable definition in Path, Invalid userID.
+<br>Examples: "U-Frooxius", "U-Nexulan"
-| Synchronous output
-|-
+== Value (Generic) ==
-| OnRequest (OUTPUT)
+The value you want to write to this cloud variable.
-| An async impulse sent when the node has sent the request for the value to be written. This can be used to chain more asynchronous calls together to happen in parallel like more writing to other variable definitions.
+<br>Examples: colorX, float3, String, DateTime.
-| ASynchronous output
-|}
+= Outputs = <!--T:3-->
+== OnDone (Impulse) ==
+The impulse during which Value will have written the data.
+== OnFail (Impulse) ==
+The impulse caused if the variable hit an error. including but not limited to: Invalid Path, improper permissions for the variable definition in Path, Invalid userID.
+== OnRequest (AsyncImpulse) ==
+An async impulse sent when the node has sent the request for the value to be written. This can be used to chain more asynchronous calls together to happen in parallel like more writing to other variable definitions.