Class ParseCommandBase

Base class for a string processor behavior.

Inheritance
object
ParseCommandBase
BBCodeCommandBase
ParseCommandBlink
ParseCommandClearEffect
ParseCommandDecorator
ParseCommandGradient
ParseCommandMirror
ParseCommandRecolor
ParseCommandSetGlyph
ParseCommandUndo
Inherited Members
Namespace: SadConsole.StringParser
Assembly: SadConsole.dll
Syntax
public abstract class ParseCommandBase

Constructors

ParseCommandBase()

Declaration
protected ParseCommandBase()

Fields

CommandType

Type of command.

Declaration
public CommandTypes CommandType
Field Value
Type Description
CommandTypes

Methods

Build(ref ColoredGlyphAndEffect, ColoredGlyphAndEffect[], int, ICellSurface?, ref int, ReadOnlySpan<char>, ParseCommandStacks)

Builds a glyph.

Declaration
public abstract void Build(ref ColoredGlyphAndEffect glyphState, ColoredGlyphAndEffect[] glyphString, int surfaceIndex, ICellSurface? surface, ref int stringIndex, ReadOnlySpan<char> processedString, ParseCommandStacks commandStack)
Parameters
Type Name Description
ColoredGlyphAndEffect glyphState

The current glyph being built.
ColoredGlyphAndEffect[] glyphString

The current string of glyphs that has been processed until now.
int surfaceIndex

Where on the surface this glyph will appear.
ICellSurface surface

The surface associated with the glyph.
int stringIndex

Where in the original string this glyph is from.
ReadOnlySpan<char> processedString

The entire string being processed.
ParseCommandStacks commandStack

The state of commands.

Removed()

Called when the command is removed from its stack.

Declaration
public virtual void Removed()

Extension Methods