Blinker Class
Definition
Section titled “Definition”Blinks the foreground and background colors of a cell with the specified colors.
[DataContract]public class Blinker : CellEffectBase, ICellEffectInheritance object → CellEffectBase
Implements ICellEffect
Constructors
Section titled “Constructors”Blinker()
Section titled “Blinker()”Creates a new instance of the blink effect.
public Blinker()Properties
Section titled “Properties”BlinkSpeed
Section titled “BlinkSpeed”How long it takes to transition from blinking in and out.
[DataMember]public TimeSpan BlinkSpeed { get; set; }BlinkOutForegroundColor
Section titled “BlinkOutForegroundColor”The color the foreground blinks to.
[DataMember]public Color BlinkOutForegroundColor { get; set; }BlinkOutBackgroundColor
Section titled “BlinkOutBackgroundColor”The color the background blinks to.
[DataMember]public Color BlinkOutBackgroundColor { get; set; }SwapColorsFromCell
Section titled “SwapColorsFromCell”When true, ignores the BlinkOutBackgroundColor and BlinkOutForegroundColor colors and instead swaps the glyph’s foreground and background colors.
[DataMember]public bool SwapColorsFromCell { get; set; }BlinkCount
Section titled “BlinkCount”How many times to blink. The value of -1 represents forever.
[DataMember]public int BlinkCount { get; set; }Duration
Section titled “Duration”The total duraction this effect will run for, before being flagged as finished. MaxValue represents forever.
[DataMember]public TimeSpan Duration { get; set; }Methods
Section titled “Methods”ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)
Section titled “ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)”Applies the state of the effect to a cell.
public override bool ApplyToCell(ColoredGlyphBase cell, ColoredGlyphBase originalState)Parameters
Section titled “Parameters”cell ColoredGlyphBase
The surface cell using this effect.
originalState ColoredGlyphBase
The state of the cell prior to the effect being applied.
Returns
Section titled “Returns”bool
true when this method modified the cell; otherwise false.
Update(TimeSpan)
Section titled “Update(TimeSpan)”Updates the state of the effect.
public override void Update(TimeSpan delta)Parameters
Section titled “Parameters”delta TimeSpan
Time since the last call to this effect.
Restart()
Section titled “Restart()”Restarts the cell effect but does not reset it.
public override void Restart()Clone()
Section titled “Clone()”Returns a duplicate of this effect.
public override ICellEffect Clone()Returns
Section titled “Returns”ICellEffect
A new copy of this effect.
ToString()
Section titled “ToString()”public override string ToString()