Skip to content
TerminalBy DarkEffekt

Class SignalCue

A signal condition played over a screen’s steady signal for a while: its level rises over the attack, falls over the decay to the sustain, holds there, and falls to nothing over the release, with a wobble from the modulation on top. The cue ends on its own after the release, or when DarkEffekt.Terminal.Unity.TerminalScreenBase.Stop(DarkEffekt.Terminal.Unity.SignalCue) is called, which starts the release at once. The steady signal underneath is never written.

Assembly: DarkEffekt.Terminal
Section titled “Assembly: DarkEffekt.Terminal”
Declaration
[Serializable]
public sealed class SignalCue

Properties

Section titled “Properties”

IsPlaying

Section titled “IsPlaying”

True while the cue plays, from Play until its release has ended.

Declaration
public bool IsPlaying { get; }

Fields

Section titled “Fields”

condition

Section titled “condition”
Declaration
[Tooltip("The condition the cue plays, at its full level.")]
public SignalCondition condition

blend

Section titled “blend”
Declaration
[Tooltip("How the cue combines with the signal under it.")]
public SignalBlend blend

attack

Section titled “attack”
Declaration
[Header("Envelope")]
[Tooltip("Seconds the level takes to rise to 1.")]
[Min(0)]
public float attack

decay

Section titled “decay”
Declaration
[Tooltip("Seconds the level then takes to fall to the sustain.")]
[Min(0)]
public float decay

sustain

Section titled “sustain”
Declaration
[Tooltip("The level the cue holds, from 0 to 1.")]
[Range(0, 1)]
public float sustain

hold

Section titled “hold”
Declaration
[Tooltip("Seconds the cue holds at the sustain. Infinity holds until the cue is stopped.")]
[Min(0)]
public float hold

release

Section titled “release”
Declaration
[Tooltip("Seconds the level takes to fall to nothing at the end.")]
[Min(0)]
public float release

modulation

Section titled “modulation”
Declaration
[Header("Modulation")]
public SignalModulation modulation

Methods

Section titled “Methods”

Hold(SignalCondition, float, SignalBlend)

Section titled “Hold(SignalCondition, float, SignalBlend)”

A cue of one condition, held for a number of seconds, with a short attack and release.

Declaration
public static SignalCue Hold(SignalCondition condition, float seconds, SignalBlend blend = SignalBlend.Max)
Returns
Section titled “Returns”

DarkEffekt.Terminal.Unity.SignalCue

Parameters
Section titled “Parameters”
Type Name
DarkEffekt.Terminal.Unity.SignalCondition condition
System.Single seconds
DarkEffekt.Terminal.Unity.SignalBlend blend

Level(double, double?)

Section titled “Level(double, double?)”

The level at a time since the cue started, from 0 to 1, or below 0 once the cue is over. releasedAt is when the release began, in seconds since the start, if it has.

Declaration
public float Level(double since, double? releasedAt)
Returns
Section titled “Returns”

System.Single

Parameters
Section titled “Parameters”
Type Name
System.Double since
System.Nullable<System.Double> releasedAt

Events

Section titled “Events”

Ended

Section titled “Ended”

Raised when the cue has ended, on the main thread.

Declaration
public event Action Ended
Event Type
Section titled “Event Type”

System.Action