Template:FireOn user information: Difference between revisions

Latest revision as of 08:23, 19 September 2025

For use on ProtoFlux:FireOnChange and similar nodes.

@@ Line 1: / Line 1: @@
-=== Determining the Owner of the Impulse ===
+<includeonly>
-When this node is used the user who fires the impulse is determined using the following steps:
+<onlyinclude>For best practice, this should never be left <code>null</code> or evaluated differently based on the user (e.g. via [[ProtoFlux:LocalUser|LocalUser]]). If this input is <code>null</code> and the node is parented under a user, then the impulse will be fired for said user. If this input is <code>null</code> and not parented under a user, or if this input evaluates differently for different users, then the impulse will <em>tend to</em> 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.</onlyinclude>
-# If the OnlyForUser ([[Type:User|User]]) property is set to [[ProtoFlux:Local User]], fire for all users in a session.
+</includeonly>
-# If the OnlyForUser ([[Type:User|User]]) property is not null only fire for this user.
+== Usage ==
-# If the Node is parented under a User, fire only for that user.
-# Otherwise fire for all users in a session.
+For use on [[ProtoFlux:FireOnChange]] and similar nodes.