Class Entity.SingleCell

An entity that is a single cell.

Inheritance
object
Entity.SingleCell
Inherited Members
Namespace: SadConsole.Entities
Assembly: SadConsole.dll
Syntax
[DataContract]
public class Entity.SingleCell

Constructors

SingleCell(ColoredGlyphBase)

Creates a new entity, references the provided glyph as the appearance.

Declaration
public SingleCell(ColoredGlyphBase appearance)
Parameters
Type Name Description
ColoredGlyphBase appearance

The appearance of the entity.

SingleCell(Color, Color, int)

Creates a new entity with the specified foreground, background, and glyph.

Declaration
public SingleCell(Color foreground, Color background, int glyph)
Parameters
Type Name Description
Color foreground

The foreground color of the entity.
Color background

The background color of the entity.
int glyph

The glyph color of the entity.

Properties

Appearance

Represents what the entity looks like.

Declaration
public ColoredGlyphBase Appearance { get; protected set; }
Property Value
Type Description
ColoredGlyphBase

Effect

An effect that can be applied to the Appearance.

Declaration
public ICellEffect? Effect { get; set; }
Property Value
Type Description
ICellEffect

IsDirty

When true, indicates that this cell is dirty and needs to be redrawn.

Declaration
public bool IsDirty { get; set; }
Property Value
Type Description
bool

Methods

Update(TimeSpan)

If an effect is applied to the cell, updates the effect.

Declaration
public void Update(TimeSpan delta)
Parameters
Type Name Description
TimeSpan delta

Extension Methods