Class BlinkGlyph
Switches between the glyph of a cell and a specified glyph for an amount of time, and then repeats.
Implements
Inherited Members
Namespace: SadConsole.Effects
Assembly: SadConsole.dll
Syntax
[DataContract]
public class BlinkGlyph : CellEffectBase, ICellEffect
Constructors
BlinkGlyph()
Creates an instance of the blink glyph effect.
Declaration
public BlinkGlyph()
Properties
BlinkCount
How many times to blink. The value of -1 represents forever.
Declaration
[DataMember]
public int BlinkCount { get; set; }
Property Value
Type | Description |
---|---|
int |
BlinkSpeed
In seconds, how fast the fade in and fade out each are
Declaration
[DataMember]
public TimeSpan BlinkSpeed { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
Duration
The total duraction this effect will run for, before being flagged as finished. MaxValue represents forever.
Declaration
[DataMember]
public TimeSpan Duration { get; set; }
Property Value
Type | Description |
---|---|
TimeSpan |
GlyphIndex
The glyph index to blink into.
Declaration
[DataMember]
public int GlyphIndex { get; set; }
Property Value
Type | Description |
---|---|
int |
Methods
ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)
Applies the state of the effect to a cell.
Declaration
public override bool ApplyToCell(ColoredGlyphBase cell, ColoredGlyphBase originalState)
Parameters
Type | Name | Description |
---|---|---|
ColoredGlyphBase | cell | The surface cell using this effect. |
ColoredGlyphBase | originalState | The state of the cell prior to the effect being applied. |
Returns
Overrides
Clone()
Returns a duplicate of this effect.
Declaration
public override ICellEffect Clone()
Returns
Type | Description |
---|---|
ICellEffect | A new copy of this effect. |
Overrides
Restart()
Restarts the cell effect but does not reset it.
Declaration
public override void Restart()
Overrides
ToString()
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
Update(TimeSpan)
Updates the state of the effect.
Declaration
public override void Update(TimeSpan delta)
Parameters
Type | Name | Description |
---|---|---|
TimeSpan | delta | Time since the last call to this effect. |