Class EffectsManager.ColoredGlyphEffectData

Represents a mapping of a single effect and associated cells.

Inheritance
object
EffectsManager.ColoredGlyphEffectData
Inherited Members
Namespace: SadConsole.Effects
Assembly: SadConsole.dll
Syntax
protected class EffectsManager.ColoredGlyphEffectData

Constructors

ColoredGlyphEffectData(ICellEffect)

Creates a new instance of the cell-effect mapping.

Declaration
public ColoredGlyphEffectData(ICellEffect effect)
Parameters
Type Name Description
ICellEffect effect

The effect.

Fields

CellsStates

The cells affected by the effect.

Declaration
public List<EffectsManager.ColoredGlyphWithState> CellsStates
Field Value
Type Description
List<EffectsManager.ColoredGlyphWithState>

Effect

The effect.

Declaration
public ICellEffect Effect
Field Value
Type Description
ICellEffect

Methods

ContainsCell(ColoredGlyphBase)

Returns true when the cell index is already associated with the effect; otherwise false.

Declaration
public bool ContainsCell(ColoredGlyphBase cell)
Parameters
Type Name Description
ColoredGlyphBase cell

The cell to check.
Returns
Type Description
bool

true to indicate the cell is associated with the effect; otherwise false.

RemoveCell(ColoredGlyphBase, bool)

Removes a cell by index from the effect data.

Declaration
public void RemoveCell(ColoredGlyphBase cell, bool restoreState)
Parameters
Type Name Description
ColoredGlyphBase cell

The cell.
bool restoreState

If true the cell will have its original state restored; otherwise false.

Extension Methods