Difference between revisions of "Timer (LogiX node)"

From Neos Wiki
Jump to navigation Jump to search
m (Zyzyl moved page LogiX: Timer to Timer (LogiX node): Changing name to match standard form)
 
(8 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<noinclude>[[Category:LogiX|Timer]]
+
<languages></languages>
[[Category:LogiX: Flow|Timer]]
+
<translate>
</noinclude>
+
<!--T:1-->
 +
{{Infobox Logix Node
 +
| Name = Timer
 +
| Image =[[File: TimerNodeNode.png | noframe | 128px | 'Timer' LogiX node ]]
 +
| Input0Type = Float | Input0Name = Interval
 +
| Input1Type = User | Input1Name = UpdatingUser
 +
| Output0Type = Impulse | Output0Name = Pulse
 +
}}
  
{|class=wikitable
+
<!--T:2-->
| Inputs
+
The '''Timer''' node fires impulses from <code>Pulse</code> separated by the number of seconds specified by the <code>Interval</code> input.
| style="width: 100px;" |
 
| Outputs
 
|-
 
| style="background-color:#3effff" | Float: Interval
 
|
 
| style="background-color:#ffffff" |
 
|-
 
| style="background-color:#ffffff" |
 
|
 
| style="background-color:#ffffff" | Impuse: Pulse
 
|-
 
| style="background-color:#87798d;color:white" | User: UpdatingUser
 
|
 
| style="background-color:#ffffff" |
 
|}
 
  
* Inputs
+
== Usage == <!--T:3-->
** Interval     - How often to fire a pulse in seconds
+
Each frame update, this node checks whether a number of seconds greater than or equal to the <code>Interval</code> input have elapsed. If they have, an impulse is fired owned by the <code>UpdatingUser</code>. If no <code>UpdatingUser</code> is provided, the default owner is the world host. If a null </code>UpdatingUser</code> is provided, the node will not fire at all.
** UpdatingUser - Which user should be the source of impulses
 
* Outputs
 
** Pulse        - Pulse which fires each interval
 
  
==Description==  
+
=== User Handling === <!--T:6-->
Timer is used to create a repeating source of impulses. The output fires once every x seconds, where x is defined by the Float input.
+
It is '''NOT''' recommended to use '''[[Local_User_(LogiX_node)|Local User]]''' with this node. When [[Local_User_(LogiX_node)|Local User]] is used, it will fire impulses for all users in the session. This is similar to the guidance for [[Fire_On_True_(LogiX_node)| Fire On True]] etc.
  
<hr>{{:NodeMenu-Flow}}<hr>
+
== Examples == <!--T:4-->
 +
 
 +
== Node Menu == <!--T:5-->
 +
</translate>
 +
 
 +
[[Category:LogiX{{#translation:}}|Timer]]
 +
[[Category:LogiX:Flow{{#translation:}}|Timer]]
 +
{{:NodeMenu-Flow}}

Latest revision as of 14:30, 19 February 2022

Other languages:
English • ‎日本語
Timer
'Timer' LogiX node
Inputs
  Float Interval
  User UpdatingUser
Outputs
  Impulse Pulse

The Timer node fires impulses from Pulse separated by the number of seconds specified by the Interval input.

Usage

Each frame update, this node checks whether a number of seconds greater than or equal to the Interval input have elapsed. If they have, an impulse is fired owned by the UpdatingUser. If no UpdatingUser is provided, the default owner is the world host. If a null UpdatingUser is provided, the node will not fire at all.

User Handling

It is NOT recommended to use Local User with this node. When Local User is used, it will fire impulses for all users in the session. This is similar to the guidance for Fire On True etc.

Examples

Node Menu

Flow
Back Events Boolean Latch Delay Delay With Value Dynamic Impulse Receiver Dynamic Impulse Receiver With Value`1
Dynamic Impulse Trigger Dynamic Impulse Trigger With Value`1 Fire On Change Fire On False Fire On True Fire While True For
If Impulse Demultiplexer Impulse Multiplexer Local Fire On Change`1 Local Fire On False Local Fire On True Local Impulse Timeout
Local Leaky Impulse Bucket One Per Frame Pulse Random Sequence Timer Update Updates Delay
Updates Delay With Value While