added link to impulses |
added broken image link |
||
Line 52: | Line 52: | ||
== Examples == | == Examples == | ||
<gallery widths=480px heights=480px> | |||
File:Protoflux_example_write.webp|Example of a write node set up to write text to a data model store variable | |||
</gallery> | |||
[[Category:ProtoFlux:Actions]] | [[Category:ProtoFlux:Actions]] |
Revision as of 18:35, 8 February 2024
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.
When it comes to the global Variable (Variable), pulling a protoflux wire from a Source Node or a Reference Source Node and dropping it onto the global field will mark the value that the source points to as the value that should be modified by this node upon impulse.
Writes are a way to change a specified value without driving it. Instead you can use Writes to change a value in a similar fashion to changing the value through the inspector. Using 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 Writes with your operations will help with performance since you're only searching once and not every single game tick.
Inputs
* (Call)
Call this to write the value.
Value (Generic)
Value to write to the value pointed to by Variable (Variable)
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 a missing Variable (Variable) value
Globals
Variable (Variable Generic)
The Variable to write to.
Examples
-
Example of a write node set up to write text to a data model store variable