Blink Class
Definition
Section titled “Definition”Switches between the normal foreground of a cell and a specified color for an amount of time, and then repeats.
[DataContract]public class Blink : CellEffectBase, ICellEffectInheritance object → CellEffectBase
Implements ICellEffect
Constructors
Section titled “Constructors”Blink()
Section titled “Blink()”Creates a new instance of the blink effect.
public Blink()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; }UseCellBackgroundColor
Section titled “UseCellBackgroundColor”When true, uses the current cells background color for fading instead of the value of BlinkOutColor.
[DataMember]public bool UseCellBackgroundColor { get; set; }BlinkOutColor
Section titled “BlinkOutColor”The color the foreground blinks to.
[DataMember]public Color BlinkOutColor { 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 duration 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()