Revision as of 05:57, 13 January 2024

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

Inputs

* (AsyncImpulse)

Will read from 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 you want to read the value for the variable definition specified in Path.
Examples: "U-Frooxius", "U-Nexulan"

Value (Generic)

The value you read for the user in VariableOwnerID in the variable definition defined in Path. This only exists during the OnDone Impulse. Write the output to a DataModelStore`1 to keep it for longer than the impulse.
Examples: colorX, float3, String, DateTime.

Outputs

OnDone (Impulse)

The impulse during which Value will have the read 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, UserID has not made a definition for the variable definition in Path.

OnRequest (AsyncImpulse)

Sent when the node has sent the request for the value to be read. This can be used to chain more asynchronous calls together to happen in parallel like more reading from other variable definitions.

@@ Line 1: / Line 1: @@
 [[Category:NodeMenu]]
-=== Reading from a variable using the "Read Cloud Variable" === <!--T:3-->
-{| class="wikitable"
+{{#Invoke:Test|ProtoFlux|
-|-
+Name=Read Cloud Variable`1
-! Connector
+|Inputs=
-! Description
+[
-! Examples
+{"Name":"*", "Type":"AsyncImpulse"},
-|-
+{"Name":"Path", "Type":"String"},
-| Impulse (INPUT)
+{"Name":"VariableOwnerId", "Type":"String"}
-| Will read from 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"},
-|-
+{"Name":"Value", "Type":"Dummy"}
-| VariableOwnerID (INPUT)
+]
-| The id of the person you want to read the value for the variable definition specified in Path.
+|}}
-| "U-Frooxius", "U-Nexulan"
-|-
+= Inputs = <!--T:3-->
-| Value (OUTPUT)
-| The value you read for the user in VariableOwnerID in the variable definition defined in Path. This only exists during the OnDone Impulse. Write the output to a DataModelStore`1 to keep it for longer than the impulse.
+== * (AsyncImpulse) ==
-| colorX, float3, String, DateTime.
+Will read from the cloud variable upon impulse. Is restricted by cloud variable rate limits.
-|-
-| OnDone (OUTPUT)
+== Path (String) ==
-| The impulse during which Value will have the read data.
+The definition owner + "." + The variable name.
-| Synchronous output
+<br>Examples: "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool"
-|-
-| OnFail (OUTPUT)
+== VariableOwnerId (String) ==
-| 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, UserID has not made a definition for the variable definition in Path.
+The id of the person you want to read the value for the variable definition specified in Path.
-| Synchronous output
+<br>Examples: "U-Frooxius", "U-Nexulan"
-|-
-| OnRequest (OUTPUT)
+== Value (Generic) ==
-| An async impulse sent when the node has sent the request for the value to be read. This can be used to chain more asynchronous calls together to happen in parallel like more reading from other variable definitions.
+The value you read for the user in VariableOwnerID in the variable definition defined in Path. This only exists during the OnDone Impulse. Write the output to a DataModelStore`1 to keep it for longer than the impulse.
-| ASynchronous output
+<br>Examples: colorX, float3, String, DateTime.
-|}
+= Outputs = <!--T:3-->
+== OnDone (Impulse) ==
+The impulse during which Value will have the read 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, UserID has not made a definition for the variable definition in Path.
+== OnRequest (AsyncImpulse) ==
+Sent when the node has sent the request for the value to be read. This can be used to chain more asynchronous calls together to happen in parallel like more reading from other variable definitions.