ProtoFlux:Write Dynamic Variable: Difference between revisions

From Resonite Wiki
Create Write Dynamic Variable Page
 
your -> you're
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{#Invoke:ProtoFlux|GenerateUI
{{#Invoke:ProtoFlux|GenerateUI
|Name=Write Dynamic Variable
|Name=Write Dynamic Variable
|Category=Dynamic Variables
|Category=Dynamic
|Inputs=
|Inputs=
[
[
Line 11: Line 11:
|Outputs=
|Outputs=
[
[
{"Name":"OnWritten", "Type":"Continuation"},
{"Name":"OnNotFound", "Type":"Continuation"},
{"Name":"OnSuccess", "Type":"Continuation"},
{"Name":"OnFailed", "Type":"Continuation"}
{"Name":"OnFailed", "Type":"Continuation"}
]
]
Line 17: Line 18:


Write Dynamic Variable is a ProtoFlux node that is able to write to previously created dynamic variables under a slot. For more info on Dynamic Variables, see [[Dynamic Variables]]. This node will only write to the variable if the path and type it's writing to is the same as a variable that exists. See [[Dynamic Variables]] on how equality is determined on paths, since 2 paths with different content can still make many different variables equal.
Write Dynamic Variable is a ProtoFlux node that is able to write to previously created dynamic variables under a slot. For more info on Dynamic Variables, see [[Dynamic Variables]]. This node will only write to the variable if the path and type it's writing to is the same as a variable that exists. See [[Dynamic Variables]] on how equality is determined on paths, since 2 paths with different content can still make many different variables equal.
{{Note|Keep in mind that the top most output is '''OnNotFound'''. This can be confusing (especially if you're not paying attention when connecting nodes) when the code fires and nothing happens.|warning}}


== Inputs ==
== Inputs ==
Line 26: Line 29:
=== Target ([[Type:Slot|Slot]]) ===
=== Target ([[Type:Slot|Slot]]) ===


The slot to search for a dynamic variable to write to.
The slot hierarchy to search for a dynamic variable to write to.


=== Path ([[Type:String|String]]) ===
=== Path ([[Type:String|String]]) ===


The path for the created dynamic variable. To see how this influences attaching see the paragraph at the beginning of this page.
The path for finding the available dynamic variable. To see how this influences attaching see the paragraph at the beginning of this page.


=== Value (Generic) ===
=== Value (Generic) ===
Line 38: Line 41:
== Outputs ==
== Outputs ==


=== OnWritten ([[Impulses|Continuation]]) ===
=== OnNotFound ([[Impulses|Continuation]]) ===
 
Fires when the path is incorrect or there is nothing to find in the given slot hierarchy.
 
=== OnSuccess ([[Impulses|Continuation]]) ===


Fires when <code>*</code> is fired and a variable already exists that can be written to through <code>Target</code>
Fires when <code>*</code> is fired and a variable already exists that can be written to through <code>Target</code>.


=== OnFailed ([[Impulses|Continuation]]) ===
=== OnFailed ([[Impulses|Continuation]]) ===


Fires when <code>*</code> is fired and the variable did not already exist at <code>Target</code>. The variable was not created when this impulses.
Fires when <code>*</code> is fired and the variable was found but cannot be written to. The variable was not created when this impulses.


[[Category:ProtoFlux:Variables:DynamicVariables]]
[[Category:ProtoFlux:Variables:DynamicVariables]]

Latest revision as of 20:42, 19 May 2024

Write Dynamic Variable
*
OnNotFound
Target
OnSuccess
Path
OnFailed
Value
Dynamic

Write Dynamic Variable is a ProtoFlux node that is able to write to previously created dynamic variables under a slot. For more info on Dynamic Variables, see Dynamic Variables. This node will only write to the variable if the path and type it's writing to is the same as a variable that exists. See Dynamic Variables on how equality is determined on paths, since 2 paths with different content can still make many different variables equal.

Keep in mind that the top most output is OnNotFound. This can be confusing (especially if you're not paying attention when connecting nodes) when the code fires and nothing happens.

Inputs

* (Call)

Call this to write the variable.

Target (Slot)

The slot hierarchy to search for a dynamic variable to write to.

Path (String)

The path for finding the available dynamic variable. To see how this influences attaching see the paragraph at the beginning of this page.

Value (Generic)

Any type of value, reference, or object that should be written to an existing variable.

Outputs

OnNotFound (Continuation)

Fires when the path is incorrect or there is nothing to find in the given slot hierarchy.

OnSuccess (Continuation)

Fires when * is fired and a variable already exists that can be written to through Target.

OnFailed (Continuation)

Fires when * is fired and the variable was found but cannot be written to. The variable was not created when this impulses.