ICellEffect Interface
Definition
Section titled “Definition”The interface describing a cell effect
public interface ICellEffectProperties
Section titled “Properties”IsFinished
Section titled “IsFinished”True when the effect is finished.
bool IsFinished { get; }CloneOnAdd
Section titled “CloneOnAdd”Flags this effect to be cloned when assigned to a cell instead of reused.
bool CloneOnAdd { get; set; }StartDelay
Section titled “StartDelay”A delay applied to the effect only when it first runs or is restarted.
TimeSpan StartDelay { get; set; }RemoveOnFinished
Section titled “RemoveOnFinished”When true, the effect should be disassociated with cells when it has finished processing.
bool RemoveOnFinished { get; set; }RestoreCellOnRemoved
Section titled “RestoreCellOnRemoved”When true, indicates the EffectsManager should restore the cell to its original state.
bool RestoreCellOnRemoved { get; set; }RunEffectOnApply
Section titled “RunEffectOnApply”When true, indicates that the EffectsManager should run one update frame on this effect when it’s first added to the manager.
bool RunEffectOnApply { get; set; }Methods
Section titled “Methods”ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)
Section titled “ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)”Applies the state of the effect to a cell.
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.
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.
void Restart()Clone()
Section titled “Clone()”Returns a duplicate of this effect.
ICellEffect Clone()Returns
Section titled “Returns”ICellEffect
A new copy of this effect.