ProtoFlux:FireOnTrue: Difference between revisions

Latest revision as of 08:48, 19 September 2025

Fire On True

OnlyForUser

OnChanged

Condition

Flow

The FireOnTrue node will listen for changes on its input bool and fire an impulse for the specified user whenever the input turns from False to True across updates.

Inputs

OnlyForUser (User)

The user that will listen to the boolean and fire the impulse.

For best practice, this should never be left null or evaluated differently based on the user (e.g. via LocalUser). If this input is null and the node is parented under a user, then the impulse will be fired for said user. If this input is null and not parented under a user, or if this input evaluates differently for different users, then the impulse will tend to be fired for the first user that sees the change in value. This is usually the one who caused the change in the first place. This could cause inconsistent behavior unless carefully managed. If the desired behavior is for an impulse to fire by every user that detects a change for them locally, then use the local version of this node, which is linked at the bottom of the page.

Condition (bool)

The bool that should be listened to for changes.

Outputs

OnChanged (impulse)

Fires a single impulse from the specified user whenever the provided input turns from False to True across updates.

@@ Line 13: / Line 13: @@
 |}}
-{{Template:Note|DO NOT: Use this node with a [[ProtoFlux:Local User|Local User]] Node. Instead use a [[ProtoFlux:Local Fire On True|Local Fire On True]] node. It WILL cause networking issues and fighting across clients.|danger}}
+The '''FireOnTrue''' node will [[Type:IExecutionChangeListener`1|listen]] for changes on its input bool and fire an [[impulses|impulse]] for the specified [[user]] whenever the input turns from <code>False</code> to <code>True</code> across [[update|updates]].
-{{Template:Basic Fire On Information|Fire On True|turns <code>True</code>|the OnlyForUser ([[Type:User|User]]) provided}}
+== Inputs ==
+=== OnlyForUser ([[Type:User|User]]) ===
-== Inputs ==
+The user that will listen to the boolean and fire the impulse.
-=== OnlyForUser ([[Type:User|User]]) ===
+{{FireOn user information}}
-The [[Type:User|User]] that should monitor the provided Condition ([[Type:Bool|bool]]).
+=== Condition ([[Type:bool|bool]]) ===
-=== Condition ([[Type:Bool|bool]]) ===
+The bool that should be listened to for changes.
-The [[Type:Bool|bool]] that should be monitored by the provided OnlyForUser ([[Type:User|User]]).
+== Outputs ==
-== Outputs ==
+=== OnChanged ([[Impulses|impulse]]) ===
+Fires a single [[Impulses|impulse]] from the specified user whenever the provided input turns from <code>False</code> to <code>True</code> across updates.
-=== OnChanged ([[Impulses|Call]]) ===
+== See also ==
-Fires when the provided OnlyForUser ([[Type:User|User]]) sees the provided Condition ([[Type:Bool|bool]]) turn true.
+* [[ProtoFlux:FireOnLocalTrue]] will fire an impulse for <em>every</em> user that detects <code>True</code> rather than a specific user.
+* [[ProtoFlux:FireOnFalse]]
+* [[ProtoFlux:FireOnChange]]
 [[Category:ProtoFlux:Flow]]
+[[Category:Listener nodes]]