C# Class SadConsole.Effects.EffectsManager

Effects manager for a text surface.
Exibir arquivo Open project: Thraka/SadConsole Class Usage Examples

Protected Properties

Property Type Description
_effectCells CellEffectData>.Dictionary
_effects CellEffectData>.Dictionary
backingSurface ITextSurface

Public Methods

Method Description
EffectsManager ( ITextSurface surface ) : System

Creates a new effects manager associated with a text surface.

GetEffect ( Cell cell ) : Effects.ICellEffect

Gets the effect of the specified cell.

GetEffects ( ) : IEnumerable
Load ( string file, ITextSurfaceRendered backingSurface ) : EffectsManager

Loads effects from a file.

Remove ( ICellEffect effect ) : void

Removes an effect and associated cells from the manager.

RemoveAll ( ) : void

Removes all effects and associated cells.

Save ( string file ) : void

Saves the effects and the associated cell indexes from the backing surface.

SetEffect ( Cell cell, ICellEffect effect ) : void

Changes the effect of a specific cell.

SetEffect ( IEnumerable cells, ICellEffect effect ) : void

Changes the effect of the cells provided.

UpdateEffects ( double timeElapsed ) : void

Updates all known effects and applies them to their associated cells.

Protected Methods

Method Description
ClearCellEffect ( Cell cell ) : void
GetKnownEffect ( ICellEffect effect, CellEffectData &effectData ) : bool

Method Details

ClearCellEffect() protected method

protected ClearCellEffect ( Cell cell ) : void
cell Cell
return void

EffectsManager() public method

Creates a new effects manager associated with a text surface.
public EffectsManager ( ITextSurface surface ) : System
surface ITextSurface Text surface to manage.
return System

GetEffect() public method

Gets the effect of the specified cell.
public GetEffect ( Cell cell ) : Effects.ICellEffect
cell Cell
return Effects.ICellEffect

GetEffects() public method

public GetEffects ( ) : IEnumerable
return IEnumerable

GetKnownEffect() protected method

protected GetKnownEffect ( ICellEffect effect, CellEffectData &effectData ) : bool
effect ICellEffect
effectData CellEffectData
return bool

Load() public static method

Loads effects from a file.
public static Load ( string file, ITextSurfaceRendered backingSurface ) : EffectsManager
file string The file to load from.
backingSurface ITextSurfaceRendered The surface the effects were originally (or will be) associated with.
return EffectsManager

Remove() public method

Removes an effect and associated cells from the manager.
public Remove ( ICellEffect effect ) : void
effect ICellEffect Effect to remove.
return void

RemoveAll() public method

Removes all effects and associated cells.
public RemoveAll ( ) : void
return void

Save() public method

Saves the effects and the associated cell indexes from the backing surface.
public Save ( string file ) : void
file string The file to save the effects to.
return void

SetEffect() public method

Changes the effect of a specific cell.
public SetEffect ( Cell cell, ICellEffect effect ) : void
cell Cell Cells to change the effect on.
effect ICellEffect The effect to associate with the cell.
return void

SetEffect() public method

Changes the effect of the cells provided.
public SetEffect ( IEnumerable cells, ICellEffect effect ) : void
cells IEnumerable Cells to change the effect on.
effect ICellEffect The effect to associate with the cell.
return void

UpdateEffects() public method

Updates all known effects and applies them to their associated cells.
public UpdateEffects ( double timeElapsed ) : void
timeElapsed double The time elapased since the last update.
return void

Property Details

_effectCells protected_oe property

protected Dictionary _effectCells
return CellEffectData>.Dictionary

_effects protected_oe property

protected Dictionary _effects
return CellEffectData>.Dictionary

backingSurface protected_oe property

protected ITextSurface backingSurface
return ITextSurface