ProtoFlux:Indirect Write: Difference between revisions

From Resonite Wiki
add extra images
m fix types
Line 6: Line 6:
[
[
{"Name":"*", "Type":"Impulse"},
{"Name":"*", "Type":"Impulse"},
{"Name":"Variable", "Type":"Variable"},
{"Name":"Variable", "Type":"IVariable`2"},
{"Name":"Value", "Type":"Dummy"}
{"Name":"Value", "Type":"Dummy"}
]
]
Line 17: Line 17:


Indirect writes can be commonly found in legacy content that has been migrated from other platforms.
Indirect writes can be commonly found in legacy content that has been migrated from other platforms.
Indirect writes take Variable ([[Type:Variable|Variable]]) as an input, and the type that Variable wraps will determine what Value (Generic) will take as a value. The node will then write Value (Generic) to the field Variable ([[Type:Variable|Variable]]) wraps.
Indirect writes take Variable ([[Type:IVariable`2|Variable]]) as an input, and the type that Variable wraps will determine what Value (Generic) will take as a value. The node will then write Value (Generic) to the field Variable ([[Type:IVariable`2|Variable]]) wraps.


{{Template:Basic Writes Info|Indirect Writes}}
{{Template:Basic Writes Info|Indirect Writes}}
Line 33: Line 33:
[[:Category:Type|Value]] to write to the value being wrapped by Variable [[Type:Variable|Variable]]
[[:Category:Type|Value]] to write to the value being wrapped by Variable [[Type:Variable|Variable]]


=== Variable ([[Type:Variable|Variable]] Generic)===
=== Variable ([[Type:IVariable`2|Variable]] Generic)===


The [[Type:Variable|Variable]] to write to.
The [[Type:IVariable`2|Variable]] to write to.


== Outputs ==
== Outputs ==
Line 45: Line 45:
=== OnFail ([[Impulses|Continuation]]) ===
=== OnFail ([[Impulses|Continuation]]) ===


sends an impulse after * ([[Impulses|Call]]) has been impulsed and the value wasn't able to be written due to a missing target or the variable not wrapping a valid [[Type:IField`1|IField`1]]
sends an impulse after * ([[Impulses|Call]]) has been impulsed and the value wasn't able to be written due to a missing target or the variable not wrapping a valid [[Type:IValue`1|IValue`1]]


== Examples ==
== Examples ==

Revision as of 18:37, 9 February 2024

Indirect Write
*
OnWritten
Variable
OnFail
Value
Indirect

Indirect writes can be commonly found in legacy content that has been migrated from other platforms. Indirect writes take Variable (Variable) as an input, and the type that Variable wraps will determine what Value (Generic) will take as a value. The node will then write Value (Generic) to the field Variable (Variable) wraps.

Indirect Writes are a way to change a specified value without driving it. Instead you can use Indirect Writes to change a value in a similar fashion to changing the value through the inspector. Using Indirect Writes helps with performance too, since the values provided to the node only evaluate for one game tick while the node is being impulsed vs a driver which evaluates every game tick. This can also be used to reduce the amount of times code is evaluated. If you have to search the entire root for your code to find a slot and then do an operation, using Indirect Writes with your operations will help with performance since you're only searching once and not every single game tick.

Variables for Indirect Writes can be made using a Field As Variable which can wrap any type (Generic). Variables can also be made by dragging a source of the same wrapped type (ex:Source<String> -> Variable<String>) into any variable input and it will make a special converter to connect them. This can be multiplexed using Multiplexing for using multiple variables into the same input on Indirect Writes. Multiplexing the inputs on Indirect Writes can be useful in modifying a list of variables during a For or While loop.

Inputs

* (Call)

Call this to write the value.

Value (Generic)

Value to write to the value being wrapped by Variable Variable

Variable (Variable Generic)

The Variable to write to.

Outputs

OnWritten (Continuation)

sends an impulse after * (Call) has been impulsed and the value has been written.

OnFail (Continuation)

sends an impulse after * (Call) has been impulsed and the value wasn't able to be written due to a missing target or the variable not wrapping a valid IValue`1

Examples