ProtoFlux:Clear Dynamic Variables: Difference between revisions

From Resonite Wiki
Created a page for the Clear Dynamic Variables node.
 
your -> you're
 
Line 18: Line 18:
The <code>Clear Dynamic Variables</code> node takes in a [[Slot|slot]] hierarchy and a [[Type:string|string]] literal path of the [[Component:DynamicVariableSpace|dynamic space]] name. For more information, see [[Dynamic Variables]].
The <code>Clear Dynamic Variables</code> node takes in a [[Slot|slot]] hierarchy and a [[Type:string|string]] literal path of the [[Component:DynamicVariableSpace|dynamic space]] name. For more information, see [[Dynamic Variables]].


{{Note|Keep in mind that the top most output is '''OnNotFound'''. This can be confusing (especially if your not paying attention when connecting nodes) when the code fires and nothing happens.|warning}}
{{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 ==

Latest revision as of 20:39, 19 May 2024

Clear Dynamic Variables
*
OnNotFound
Target
OnCleared
SpaceName
ClearedCount
Dynamic

The Clear Dynamic Variables node takes in a slot hierarchy and a string literal path of the dynamic space name. For more information, see Dynamic Variables.

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)

Calls an impulse to clear all dynamic variables from a given dynamic space.

Target (Slot)

The slot hierarchy for this node to look through.

SpaceName (string)

The dynamic space name to find and clear out the dynamic variables from.

Outputs

OnNotFound (Continuation)

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

OnCleared (Continuation)

Fires when the dynamic space name is found and all dynamic variables under that name is removed.

ClearedCount (int)

Returns the number of dynamic variables that have been removed by this node.