ProtoFlux:Updates Timer: Difference between revisions

Revision as of 20:26, 24 December 2024

Updates Timer

Interval

OnUpdate

Updating User

null

∅

SkipIfNull

null

∅

Flow

The Updates Timer node sends a pulse from the UpdatingUser at the specified interval of engine updates from said user.

The interval of engine updates to send pulses at.

Sends a pulse at every Interval engine updates from the UpdatingUser.

The user that the OnUpdate pulse will be generated from and owned by.

If True, no pulses will be generated if UpdatingUser is null. Otherwise, impulses will be generated by the host user if UpdatingUser is null.

@@ Line 17: / Line 17: @@
 |}}
-{{Stub}}
+The '''Updates Timer''' node sends a pulse from the <code>UpdatingUser</code> at the specified interval of engine updates from said user.
+== Inputs ==
+=== Interval ([[Type:int|int]]) ===
+The interval of engine updates to send pulses at.
+== Outputs ==
+=== OnUpdate ([[Impulses|Call]]) ===
+Sends a pulse at every <code>Interval</code> engine updates from the <code>UpdatingUser</code>.
+== Globals ==
+=== UpdatingUser ([[Type:User|User]]) ===
+The user that the <code>OnUpdate</code> pulse will be generated from and owned by.
+=== SkipIfNull ([[Type:bool|bool]]) ===
+If <code>True</code>, no pulses will be generated if <code>UpdatingUser</code> is null. Otherwise, impulses will be generated by the [[ProtoFlux:Host User|host user]] if <code>UpdatingUser</code> is null.
+== See Also ==
+* [[ProtoFlux:Update]] to generate an impulse every engine update.
+* [[ProtoFlux:Seconds Timer]] to generate an impulse at a specified interval of seconds.
+* [[ProtoFlux:Local Update]] to generate an impulse from every user every local engine update.
 [[Category:ProtoFlux:Flow]]