Show / Hide Table of Contents

Class Delay

An effect that doesn't do anything except run the StartDelay timer. Usually used with the EffectSet effect.

Inheritance
object
CellEffectBase
Delay
Implements
ICellEffect
Inherited Members
CellEffectBase._delayFinished
CellEffectBase._timeElapsed
CellEffectBase.Restart()
CellEffectBase.IsFinished
CellEffectBase.CloneOnAdd
CellEffectBase.StartDelay
CellEffectBase.RemoveOnFinished
CellEffectBase.RestoreCellOnRemoved
CellEffectBase.RunEffectOnApply
object.GetType()
object.MemberwiseClone()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: SadConsole.Effects
Assembly: SadConsole.dll
Syntax
[DataContract]
public class Delay : CellEffectBase, ICellEffect

Constructors

Delay()

Declaration
public Delay()

Methods

ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)

Applies the state of the effect to a cell.

Declaration
public override bool ApplyToCell(ColoredGlyphBase cell, ColoredGlyphBase state)
Parameters
Type Name Description
ColoredGlyphBase cell

The surface cell using this effect.

ColoredGlyphBase state
Returns
Type Description
bool

true when this method modified the cell; otherwise false.

Overrides
CellEffectBase.ApplyToCell(ColoredGlyphBase, ColoredGlyphBase)

Clone()

Returns a duplicate of this effect.

Declaration
public override ICellEffect Clone()
Returns
Type Description
ICellEffect

A new copy of this effect.

Overrides
CellEffectBase.Clone()

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides
object.ToString()

Update(TimeSpan)

Updates the state of the effect.

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

Time since the last call to this effect.

Overrides
CellEffectBase.Update(TimeSpan)

Implements

ICellEffect

Extension Methods

ExtensionsSystem.GetDebuggerDisplayValue(object)
In this article

Back to top

Back to top Generated by DocFX