Class ParseCommandSetGlyph

Prints a glyph.

Inheritance
object
ParseCommandBase
ParseCommandSetGlyph
Inherited Members
Namespace: SadConsole.StringParser
Assembly: SadConsole.dll
Syntax
public sealed class ParseCommandSetGlyph : ParseCommandBase

Constructors

ParseCommandSetGlyph(string)

Creates a new instance of this command.

Declaration
public ParseCommandSetGlyph(string parameters)
Parameters
Type Name Description
string parameters

The string to parse for parameters.

Properties

Glyph

The glyph to set.

Declaration
public char Glyph { get; set; }
Property Value
Type Description
char

RandomGlyph

Uses a random glyph.

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

RandomGlyphMax

The maximumglyph to use with the random glyph.

Declaration
public int RandomGlyphMax { get; set; }
Property Value
Type Description
int

RandomGlyphMin

The minimum glyph to use with the random glyph.

Declaration
public int RandomGlyphMin { get; set; }
Property Value
Type Description
int

Methods

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

Builds a glyph.

Declaration
public override 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.
Overrides

Extension Methods