m Change Category |
Fixed visual. Fixed the arrangement of the output descriptions. Fixed link to async. |
||
| (9 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{#Invoke:ProtoFlux|GenerateUI | |||
|Name=Write Cloud Variable | |||
{{#Invoke: | |Category=Cloud | ||
Name=Write Cloud Variable | |||
|Inputs= | |Inputs= | ||
[ | [ | ||
{"Name":"*", "Type":" | {"Name":"*", "Type":"AsyncCall"}, | ||
{"Name":"Path", "Type":"String"}, | {"Name":"Path", "Type":"String"}, | ||
{"Name":"VariableOwnerId", "Type":"String"}, | {"Name":"VariableOwnerId", "Type":"String"}, | ||
| Line 12: | Line 11: | ||
|Outputs= | |Outputs= | ||
[ | [ | ||
{"Name":"OnRequest", "Type":" | {"Name":"OnRequest", "Type":"SyncResumption"}, | ||
{"Name":"OnDone", "Type":" | {"Name":"OnDone", "Type":"Continuation"}, | ||
{"Name":"OnFail", "Type":" | {"Name":"OnFail", "Type":"Continuation"} | ||
] | ] | ||
|}} | |}} | ||
Write Cloud Variable is a node that is able to write to cloud variables that are already defined. For more information on how to define the permissions/security of cloud variables, and how to create them, see [[Cloud Variables]] | |||
== Inputs == <!--T:3--> | == Inputs == <!--T:3--> | ||
=== * ( | === * ([[Impulses#ASync|AsyncCall]]) === | ||
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. | ||
=== Path (String) === | === Path ([[Type:String|String]]) === | ||
The definition owner + "." + The variable name. | The definition owner + "." + The variable name. | ||
<br>Examples: "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool" | <br>Examples: "G-Resonite.UserSettings.Color.Primary", "U-ProbablePrime.testing.bool" | ||
=== VariableOwnerId (String) === | === VariableOwnerId ([[Type:String|String]]) === | ||
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. | ||
<br>Examples: "U-Frooxius", "U-Nexulan" | <br>Examples: "U-Frooxius", "U-Nexulan" | ||
=== Value ( | === Value (Pseudo-generic) === | ||
The value you want to write to this cloud variable. | The value you want to write to this cloud variable. | ||
<br>Examples: | <br>Examples: [[Type:ColorX|ColorX]], [[Type:Float3|float3]], [[Type:String|String]], [[Type:DateTime|DateTime]]. | ||
== Outputs == <!--T:3--> | == Outputs == <!--T:3--> | ||
=== OnDone ( | === OnRequest ([[Impulses#Async|SyncResumption]]) === | ||
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. | |||
=== OnDone ([[Impulses|Call]]) === | |||
The impulse during which Value will have written the data. | The impulse during which Value will have written the data. | ||
=== OnFail ( | === OnFail ([[Impulses|Call]]) === | ||
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. | 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. | ||
[[Category:ProtoFlux:Variables:Cloud]] | |||
Latest revision as of 19:20, 19 May 2024
Write Cloud Variable is a node that is able to write to cloud variables that are already defined. For more information on how to define the permissions/security of cloud variables, and how to create them, see Cloud Variables
Inputs
* (AsyncCall)
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 (Pseudo-generic)
The value you want to write to this cloud variable.
Examples: ColorX, float3, String, DateTime.
Outputs
OnRequest (SyncResumption)
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.
OnDone (Call)
The impulse during which Value will have written the data.
OnFail (Call)
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.