Created page, simple table description |
m fixed a bracket |
||
| Line 2: | Line 2: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! | ! Connector | ||
! Description | ! Description | ||
! Examples | ! Examples | ||
|- | |- | ||
| Impulse | | Impulse (INPUT) | ||
| Will read from the cloud variable upon impulse. Is restricted by cloud variable rate limits. | | Will read from the cloud variable upon impulse. Is restricted by cloud variable rate limits. | ||
| Async Call input. | | Async Call input. | ||
|- | |- | ||
| Path | | Path (INPUT) | ||
| The definition owner + "." + The variable name. | | The definition owner + "." + The variable name. | ||
| "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool" | | "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool" | ||
|- | |- | ||
| VariableOwnerID | | VariableOwnerID (INPUT) | ||
| The id of the person you want to read the value for the variable definition specified in Path. | | The id of the person you want to read the value for the variable definition specified in Path. | ||
| "U-Frooxius", "U-Nexulan" | | "U-Frooxius", "U-Nexulan" | ||
| Line 22: | Line 22: | ||
| colorX, float3, String, DateTime. | | colorX, float3, String, DateTime. | ||
|- | |- | ||
| OnDone (OUTPUT) | |||
| The impulse during which Value will have the read data. | |||
| Synchronous output | |||
|- | |||
| OnFail (OUTPUT) | |||
| 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. | |||
| Synchronous output | |||
|- | |||
| OnRequest (OUTPUT) | |||
| 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. | |||
| ASynchronous output | |||
|} | |||
Revision as of 23:01, 12 January 2024
Reading from a variable using the "Read Cloud Variable"
| Connector | Description | Examples |
|---|---|---|
| Impulse (INPUT) | Will read from the cloud variable upon impulse. Is restricted by cloud variable rate limits. | Async Call input. |
| Path (INPUT) | The definition owner + "." + The variable name. | "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool" |
| VariableOwnerID (INPUT) | The id of the person you want to read the value for the variable definition specified in Path. | "U-Frooxius", "U-Nexulan" |
| 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. | colorX, float3, String, DateTime. |
| OnDone (OUTPUT) | The impulse during which Value will have the read data. | Synchronous output |
| OnFail (OUTPUT) | 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. | Synchronous output |
| OnRequest (OUTPUT) | 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. | ASynchronous output |