C# Class SadConsole.ColoredString

Show file Open project: Thraka/SadConsole Class Usage Examples

Public Properties

Property Type Description
CustomProcessor Func

Public Methods

Method Description
Parse ( string value, int surfaceIndex = -1, Consoles surface = null, SurfaceEditor editor = null, ParseCommandStacks initialBehaviors = null ) : ColoredString

Creates a colored string by parsing commands embedded in the string.

Method Details

Parse() public static method

Creates a colored string by parsing commands embedded in the string.
public static Parse ( string value, int surfaceIndex = -1, Consoles surface = null, SurfaceEditor editor = null, ParseCommandStacks initialBehaviors = null ) : ColoredString
value string The string to parse.
surfaceIndex int Index of where this string will be printed.
surface Consoles The surface the string will be printed to.
editor SadConsole.Consoles.SurfaceEditor A surface editor associated with the text surface.
initialBehaviors SadConsole.StringParser.ParseCommandStacks Any initial defaults.
return ColoredString

Property Details

CustomProcessor public static property

Custom processor called if any built in command is not triggerd. Signature is ("command", "sub command", existing glyphs, text surface, associated editor, command stacks).
public static Func CustomProcessor
return Func