EffectSet Class
Definition
Section titled “Definition”Chains one effect after another.
[DataContract]public class EffectSet : CellEffectBase, ICellEffect, IEnumerable<ICellEffect>, IEnumerableInheritance object → CellEffectBase
Implements ICellEffect, IEnumerable<ICellEffect>, IEnumerable
Constructors
Section titled “Constructors”EffectSet()
Section titled “EffectSet()”public EffectSet()Properties
Section titled “Properties”Effects
Section titled “Effects”The list of effects to process.
[DataMember]public LinkedList<ICellEffect> Effects { get; }Repeat
Section titled “Repeat”When true, instead of ending when finished, it will repeat. Otherwise, false.
[DataMember]public bool Repeat { get; set; }DelayBetweenEffects
Section titled “DelayBetweenEffects”An artificial delay between each effect.
[DataMember]public TimeSpan DelayBetweenEffects { 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()Returns
Section titled “Returns”GetEnumerator()
Section titled “GetEnumerator()”Gets an enumerator of all the effects.
public IEnumerator<ICellEffect> GetEnumerator()Returns
Section titled “Returns”IEnumerator<ICellEffect>
The enumerator.
Add(ICellEffect)
Section titled “Add(ICellEffect)”Adds an effect to the end of the Effects collection.
public void Add(ICellEffect effect)Parameters
Section titled “Parameters”effect ICellEffect
The effect to add.