ProtoFlux:Write Latch

Write Latch

Set

OnSet

Reset

OnReset

SetValue

OnFail

ResetValue

Variable

null

∅

Actions

Write latches take a Variable (Variable) as a global input, and the Variable will determine what SetValue (Generic) and ResetValue (Generic) will take as a value. The set and reset value inputs will never take different types from each other.

Write Latches are a way to change a specified value without driving it. Instead you can use Write Latches to change a value in a similar fashion to changing the value through the inspector. Using Write Latches 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 Write Latches with your operations will help with performance since you're only searching once and not every single game tick.

When it comes to Write Latches, you can drag any matching typed source onto the Variable field to set that as the variable target. When you want to write to a Local Variable Store, Data Model Variable Store, or a Store Variable Store, you can grab the Variable field on Write Latches nodes and then choose the one you want in your context menu. This can save considerable time spent trying to find the type you want in another node menu.

Inputs

Reset (Call)

Call this to set the value pointed to by Variable (Variable Generic) to the ResetValue (Generic) input.

Set (Call)

Call this to set the value pointed to by Variable (Variable Generic) to the SetValue (Generic) input.

SetValue (Generic)

Value to write to the value pointed to by Variable (Variable Generic) upon calling Set (Call)

ResetValue (Generic)

Value to write to the value pointed to by Variable (Variable Generic) upon calling Reset (Call)

Outputs

OnSet (Continuation)

sends an impulse after SetValue (Call) has been impulsed and the value pointed to by Variable (Variable Generic) has been set to SetValue (Generic).

OnReset (Continuation)

sends an impulse after ResetValue (Call) has been impulsed and the value pointed to by Variable (Variable Generic) has been set to ResetValue (Generic).

OnFail (Continuation)

sends an impulse after either ResetValue (Call) or SetValue (Call) has been impulsed and the value wasn't able to be written due to a missing Variable (Variable Generic) Value.

Globals

Variable (Variable Generic)

The value source/ref source to write to.

Examples

• Example of a write latch node set up to write text to a data model store variable, set will set the text to "hello" and reset sets it back to "goodbye".
  Example of a write latch node set up to write text to a data model store variable, set will set the text to "hello" and reset sets it back to "goodbye".