ProtoFlux:Write Cloud Variable: Difference between revisions

From Resonite Wiki
Created page with "=== Writing to a variable using the "Write Cloud Variable" === <!--T:3--> {| class="wikitable" |- ! Input ! Description ! Examples |- | Impulse | Will Write the cloud variable upon impulse. Is restricted by cloud variable rate limits. | Async Call input. |- | Path | The definition owner + "." + The variable name. | "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool" |- | VariableOwnerID | The id of the person writing a value to the variable specified..."
 
Made page match read cloud variable
Line 2: Line 2:
{| class="wikitable"  
{| class="wikitable"  
|-
|-
! Input
! Connector
! Description
! Description
! Examples
! Examples
|-
|-
| Impulse
| Impulse (INPUT)
| Will Write the cloud variable upon impulse. Is restricted by cloud variable rate limits.
| Will Write 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 writing a value to the variable specified in Path.
| The id of the person writing a value to the variable specified in Path.
| "U-Frooxius", "U-Nexulan"
| "U-Frooxius", "U-Nexulan"
|-
|-
| Value
| Value (INPUT)
| The value you want to write to this cloud variable.
| The value you want to write to this cloud variable.
| colorX, float3, String, DateTime.
| colorX, float3, String, DateTime.
|-
| OnDone (OUTPUT)
| The impulse during which Value will have written the 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.
| Synchronous output
|-
| OnRequest (OUTPUT)
| 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.
| ASynchronous output
|}
|}

Revision as of 23:04, 12 January 2024

Writing to a variable using the "Write Cloud Variable"

Connector Description Examples
Impulse (INPUT) Will Write 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 writing a value to the variable specified in Path. "U-Frooxius", "U-Nexulan"
Value (INPUT) The value you want to write to this cloud variable. colorX, float3, String, DateTime.
OnDone (OUTPUT) The impulse during which Value will have written the 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. Synchronous output
OnRequest (OUTPUT) 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. ASynchronous output