Clarify Time value |
m Yosh moved page ProtoFlux:Stop Watch to ProtoFlux:Stopwatch: Stopwatch is one word and not camelcased inside frooxengine. it shouldn't be treated as two separate words here |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 18: | Line 18: | ||
}} | }} | ||
The '''Stopwatch''' node keeps track of time when running. Akin to a [https://en.wikipedia.org/wiki/Stopwatch real stopwatch], it allows one to start time, stop time, and reset time. | |||
== Inputs == | == Inputs == | ||
=== Start ([[Impulses|Call]]) === | === Start ([[Impulses|Call]]) === | ||
Starts the stopwatch, putting it in the running state. | |||
Call | === Stop ([[Impulses|Call]]) === | ||
Stops the stopwatch, putting it in the stopped state. | |||
=== | === Reset ([[Impulses|Call]]) === | ||
Resets the stopwatch time. Does not affect the state of the stopwatch. | |||
Does | |||
== Outputs == | == Outputs == | ||
=== OnStarted ([[Impulses|Continuation]]) === | === OnStarted ([[Impulses|Continuation]]) === | ||
Sends an impulse when <code>Start</code> is impulsed. Is not affected by the state of the stopwatch. | |||
Sends an impulse | |||
=== OnStopped ([[Impulses|Continuation]]) === | === OnStopped ([[Impulses|Continuation]]) === | ||
Sends an impulse when <code>Stop</code> is impulsed. Is not affected by the state of the stopwatch. | |||
Sends an impulse | |||
=== OnReset ([[Impulses|Continuation]]) === | === OnReset ([[Impulses|Continuation]]) === | ||
Sends an impulse when <code>Reset</code> is impulsed. Is not affected by the state of the stopwatch. | |||
Sends an impulse | |||
=== Time ([[Type:Float|Float]]) === | === Time ([[Type:Float|Float]]) === | ||
The time in seconds stored by the stopwatch. This value increments when in the running state and freezes when in the stopped state. If <code>Reset</code> is pulsed, this output is set to <code>0</code>, but continues the same behavior of the state the watch is in. | |||
Sometimes, it may be desirable to obtain a [[Type:TimeSpan|TimeSpan]] type from this value. To do so, use a [[ProtoFlux:TimeSpan From Seconds|TimeSpan From Seconds]] node. | |||
=== IsRunning ([[Type:Bool|Bool]]) === | === IsRunning ([[Type:Bool|Bool]]) === | ||
<code>True</code> if the stopwatch is in a running state, <code>False</code> otherwise. | |||
== Examples == | == Examples == | ||
[[Category:ProtoFlux:Time]] | [[Category:ProtoFlux:Time]] | ||
Latest revision as of 19:39, 4 July 2024
The Stopwatch node keeps track of time when running. Akin to a real stopwatch, it allows one to start time, stop time, and reset time.
Inputs
Start (Call)
Starts the stopwatch, putting it in the running state.
Stop (Call)
Stops the stopwatch, putting it in the stopped state.
Reset (Call)
Resets the stopwatch time. Does not affect the state of the stopwatch.
Outputs
OnStarted (Continuation)
Sends an impulse when Start is impulsed. Is not affected by the state of the stopwatch.
OnStopped (Continuation)
Sends an impulse when Stop is impulsed. Is not affected by the state of the stopwatch.
OnReset (Continuation)
Sends an impulse when Reset is impulsed. Is not affected by the state of the stopwatch.
Time (Float)
The time in seconds stored by the stopwatch. This value increments when in the running state and freezes when in the stopped state. If Reset is pulsed, this output is set to 0, but continues the same behavior of the state the watch is in.
Sometimes, it may be desirable to obtain a TimeSpan type from this value. To do so, use a TimeSpan From Seconds node.
IsRunning (Bool)
True if the stopwatch is in a running state, False otherwise.