Class CellSurfaceEditor
Methods to interact with a ICellSurface.
Inherited Members
Namespace: SadConsole
Assembly: SadConsole.dll
Syntax
public static class CellSurfaceEditor
Methods
AddDecorator(ISurface, Point, params CellDecorator[])
Appends the decorators to one or more cells
Declaration
public static void AddDecorator(this ISurface obj, Point position, params CellDecorator[] decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Point | position | The x,y coordinate of the cell. |
CellDecorator[] | decorators | The decorators. |
AddDecorator(ISurface, int, params CellDecorator[]?)
Appends the decorators to one or more cells
Declaration
public static void AddDecorator(this ISurface obj, int index, params CellDecorator[]? decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | The index of the cell to start applying. |
CellDecorator[] | decorators | The decorators. |
AddDecorator(ISurface, int, int, params CellDecorator[])
Appends the decorators to one or more cells
Declaration
public static void AddDecorator(this ISurface obj, int index, int count, params CellDecorator[] decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | The index of the cell to start applying. |
int | count | The count of cells to use from the index (inclusive). |
CellDecorator[] | decorators | The decorators. |
AddDecorator(ISurface, int, int, int, params CellDecorator[])
Appends the decorators to one or more cells
Declaration
public static void AddDecorator(this ISurface obj, int x, int y, int count, params CellDecorator[] decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x coordinate of the cell. |
int | y | The y coordinate of the cell. |
int | count | The count of cells to use from the x,y coordinate (inclusive). |
CellDecorator[] | decorators | The decorators. |
Clear(ISurface)
Clears the console data. Characters are reset to 0, the foreground and background are set to default, and mirror set to none. Clears cell decorators.
Declaration
public static void Clear(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Clear(ISurface, Rectangle)
Clears an area of obj.Surface. Each cell is reset to its default state. Then, Glyph, foreground, and background, are reset to the surface's default values.
Declaration
public static void Clear(this ISurface obj, Rectangle area)
Parameters
Clear(ISurface, IEnumerable<Point>)
Clears an area of obj.Surface. Each cell is reset to its default state. Then, Glyph, foreground, and background, are reset to the surface's default values.
Declaration
public static void Clear(this ISurface obj, IEnumerable<Point> cellPositions)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
IEnumerable<Point> | cellPositions | The cells to clear. |
Clear(ISurface, int, int)
Clears a cell. Character is reset to 0, the foreground and background is set to default, and mirror is set to none. Clears cell decorators.
Declaration
public static void Clear(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Clear(ISurface, int, int, int)
Clears a segment of cells, starting from the left, extending to the right, and wrapping if needed. Character is reset to 0, the foreground and background is set to default, and mirror is set to none. Clears cell decorators.
Declaration
public static void Clear(this ISurface obj, int x, int y, int length)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x position of the left end of the segment. |
int | y | The y position of the segment. |
int | length | The length of the segment. If it extends beyond the line, it will wrap to the next line. If it extends beyond the console, then it automatically ends at the last valid cell. |
Remarks
This works similarly to printing a string of whitespace
ClearDecorators(ISurface, int, int)
Clears the decorators of the specified cells
Declaration
public static void ClearDecorators(this ISurface obj, int index, int count)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | The index of the cell to start applying. |
int | count | The count of cells to use from the index (inclusive). |
ClearDecorators(ISurface, int, int, int)
Clears the decorators of the specified cells.
Declaration
public static void ClearDecorators(this ISurface obj, int x, int y, int count)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x coordinate of the cell. |
int | y | The y coordinate of the cell. |
int | count | The count of cells to use from the x,y coordinate (inclusive). |
ClearShiftValues(ISurface)
Resets the shifted amounts to 0, as if the surface has never shifted.
Declaration
public static void ClearShiftValues(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ConnectLines(ISurface)
Connects all lines in a surface for both ConnectedLineThin and ConnectedLineThick styles.
Declaration
public static void ConnectLines(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ConnectLines(ISurface, int[])
Connects all lines in this based on the lineStyle
style provided.
Declaration
public static void ConnectLines(this ISurface obj, int[] lineStyle)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int[] | lineStyle | The array of line styles indexed by ICellSurface.ConnectedLineIndex. |
ConnectLines(ISurface, int[], Rectangle)
Connects all lines in this based on the lineStyle
style provided.
Declaration
public static void ConnectLines(this ISurface obj, int[] lineStyle, Rectangle area)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int[] | lineStyle | The array of line styles indexed by ICellSurface.ConnectedLineIndex. |
Rectangle | area | The area to process. |
Copy(ISurface, ICellSurface)
Copies the contents of the cell surface to the destination.
Declaration
public static void Copy(this ISurface obj, ICellSurface destination)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ICellSurface | destination | The destination obj.Surface. |
Remarks
If the sizes to not match, it will always start at 0,0 and work with what it can and move on to the next row when either surface runs out of columns being processed
Copy(ISurface, ICellSurface, int, int)
Copies the contents of the cell surface to the destination at the specified x,y.
Declaration
public static void Copy(this ISurface obj, ICellSurface destination, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ICellSurface | destination | The destination obj.Surface. |
int | x | The x coordinate of the destination. |
int | y | The y coordinate of the destination. |
Copy(ISurface, Rectangle, ICellSurface, int, int)
Copies an area of this cell surface to the destination surface.
Declaration
public static void Copy(this ISurface obj, Rectangle area, ICellSurface destination, int destinationX, int destinationY)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Rectangle | area | The area to copy. |
ICellSurface | destination | The destination obj.Surface. |
int | destinationX | The x coordinate to copy to. |
int | destinationY | The y coordinate to copy to. |
Copy(ISurface, int, int, int, int, ICellSurface, int, int)
Copies the contents of this cell surface at the specified x,y coordinates to the destination, only with the specified obj.Surface.BufferWidth and obj.Surface.BufferHeight, and copies it to the specified destinationX
and destinationY
position.
Declaration
public static void Copy(this ISurface obj, int x, int y, int width, int height, ICellSurface destination, int destinationX, int destinationY)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x coordinate to start from. |
int | y | The y coordinate to start from. |
int | width | The BufferWidth to copy from. |
int | height | The BufferHeight to copy from. |
ICellSurface | destination | The destination obj.Surface. |
int | destinationX | The x coordinate to copy to. |
int | destinationY | The y coordinate to copy to. |
DrawBox(ISurface, Rectangle, ShapeParameters)
Draws a box.
Declaration
public static void DrawBox(this ISurface obj, Rectangle area, ShapeParameters parameters)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Rectangle | area | The area of the box. |
ShapeParameters | parameters | Provides the options for drawing a border and filling the box. |
DrawCircle(ISurface, Rectangle, ShapeParameters)
Draws an ellipse.
Declaration
public static void DrawCircle(this ISurface obj, Rectangle area, ShapeParameters parameters)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Rectangle | area | The area the ellipse |
ShapeParameters | parameters | Provides the options for drawing a border and filling the circle. |
DrawLine(ISurface, Point, Point, int?, Color?, Color?, Mirror?)
Draws a line from start
to end
.
Declaration
public static IEnumerable<ColoredGlyphBase> DrawLine(this ISurface obj, Point start, Point end, int? glyph, Color? foreground = null, Color? background = null, Mirror? mirror = null)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Point | start | Starting point of the line. |
Point | end | Ending point of the line. |
int? | glyph | Glyph to set. If null, skipped. |
Color? | foreground | Foreground to set. If null, skipped. |
Color? | background | Background to set. If null, skipped. |
Mirror? | mirror | Mirror to set. If null, skipped. |
Returns
Type | Description |
---|---|
IEnumerable<ColoredGlyphBase> | A list of cells the line touched; ordered from first to last. |
Remarks
To simply return the list of cells that would be drawn to, use null for glyph
, foreground
, background
, and mirror
.
Erase(ISurface)
Erases all cells which clears the glyph, mirror, and decorators. Doesn't clear the effect.
Declaration
public static void Erase(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Remarks
All cells have Glyph set to DefaultGlyph, the Decorators array reset, and the Mirror set to None.
Erase(ISurface, int, int)
Clears the glyph, mirror, and decorators, for the specified cell. Doesn't clear the effect.
Declaration
public static void Erase(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x position. |
int | y | The y position. |
Remarks
The cell altered by this method has the Glyph set to DefaultGlyph, the Decorators array reset, and the Mirror set to None.
Erase(ISurface, int, int, int)
Starting at the specified coordinate, clears the glyph, mirror, and decorators, for the specified count of obj.Surface. Doesn't clear the effect, foreground, or background.
Declaration
public static ColoredGlyphBase[] Erase(this ISurface obj, int x, int y, int count)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x position. |
int | y | The y position. |
int | count | The count of glyphs to erase. |
Returns
Type | Description |
---|---|
ColoredGlyphBase[] | The cells processed by this method. |
Remarks
Cells altered by this method has the Glyph set to DefaultGlyph, the Decorators array reset, and the Mirror set to None.
Fill(ISurface, ColoredGlyphBase)
Fills the console. Clears cell decorators and effects.
Declaration
public static ColoredGlyphBase[] Fill(this ISurface obj, ColoredGlyphBase iconAppearance)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ColoredGlyphBase | iconAppearance | The appearance that is copied to every cell. |
Returns
Type | Description |
---|---|
ColoredGlyphBase[] | The array of all cells in this console, starting from the top left corner. |
Fill(ISurface, Rectangle, Color?, Color?, int?, Mirror?)
Fills the specified area. Clears cell decorators.
Declaration
public static ColoredGlyphBase[] Fill(this ISurface obj, Rectangle area, Color? foreground = null, Color? background = null, int? glyph = null, Mirror? mirror = null)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Rectangle | area | The area to fill. |
Color? | foreground | Foreground to apply. If null, skips. |
Color? | background | Background to apply. If null, skips. |
int? | glyph | Glyph to apply. If null, skips. |
Mirror? | mirror | Mirror to apply. If null, skips. |
Returns
Type | Description |
---|---|
ColoredGlyphBase[] | An array containing the affected cells, starting from the top left corner. If the area is out of bounds, nothing happens and an empty array is returned. |
Fill(ISurface, int, int, int, Color?, Color?, int?, Mirror?)
Fills a segment of cells, starting from the left, extending to the right, and wrapping if needed. Clears cell decorators.
Declaration
public static ColoredGlyphBase[] Fill(this ISurface obj, int x, int y, int length, Color? foreground = null, Color? background = null, int? glyph = null, Mirror? mirror = null)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x position of the left end of the segment. |
int | y | The y position of the segment. |
int | length | The length of the segment. If it extends beyond the line, it will wrap to the next line. If it extends beyond the console, then it automatically ends at the last valid cell. |
Color? | foreground | Foreground to apply. If null, skips. |
Color? | background | Background to apply. If null, skips. |
int? | glyph | Glyph to apply. If null, skips. |
Mirror? | mirror | Mirror to apply. If null, skips. |
Returns
Type | Description |
---|---|
ColoredGlyphBase[] | An array containing the affected cells, starting from the top left corner. If x or y are out of bounds, nothing happens and an empty array is returned |
Fill(ISurface, Color?, Color?, int?, Mirror?)
Fills the console. Clears cell decorators and effects.
Declaration
public static ColoredGlyphBase[] Fill(this ISurface obj, Color? foreground = null, Color? background = null, int? glyph = null, Mirror? mirror = null)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Color? | foreground | Foreground to apply. If null, skips. |
Color? | background | Foreground to apply. If null, skips. |
int? | glyph | Glyph to apply. If null, skips. |
Mirror? | mirror | Mirror to apply. If null, skips. |
Returns
Type | Description |
---|---|
ColoredGlyphBase[] | The array of all cells in this console, starting from the top left corner. |
FillWithRandomGarbage(ISurface, IFont)
Fills a console with random colors and glyphs.
Declaration
public static void FillWithRandomGarbage(this ISurface obj, IFont associatedFont)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
IFont | associatedFont | The font used in assigning glyphs randomly. |
FillWithRandomGarbage(ISurface, int)
Fills a console with random colors and glyphs.
Declaration
public static void FillWithRandomGarbage(this ISurface obj, int maxGlyphValue)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | maxGlyphValue | The maximum glyph value to use on the obj.Surface. |
FillWithRandomGarbage(ISurface, int, Rectangle)
Fills a console with random colors and glyphs.
Declaration
public static void FillWithRandomGarbage(this ISurface obj, int maxGlyphValue, Rectangle area)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | maxGlyphValue | The maximum glyph value to use on the obj.Surface. |
Rectangle | area | The area to fill with random garbage. |
GetBackground(ISurface, int, int)
Gets the background of a specified cell.
Declaration
public static Color GetBackground(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Returns
Type | Description |
---|---|
Color | The color. |
GetCellAppearance(ISurface, int, int)
Gets the appearance of a cell.
Declaration
public static ColoredGlyphBase GetCellAppearance(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Returns
Type | Description |
---|---|
ColoredGlyphBase | The appearance. |
GetCells(ISurface, Rectangle)
Gets an enumerable of cells over a specific area.
Declaration
public static IEnumerable<ColoredGlyphBase> GetCells(this ISurface obj, Rectangle area)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Rectangle | area | The area to get cells from. |
Returns
Type | Description |
---|---|
IEnumerable<ColoredGlyphBase> | A new array with references to each cell in the area. |
GetEffect(ISurface, int)
Gets the effect of the specified cell.
Declaration
public static ICellEffect? GetEffect(this ISurface obj, int index)
Parameters
Returns
Type | Description |
---|---|
ICellEffect | The effect. |
GetEffect(ISurface, int, int)
Gets the effect of the specified cell.
Declaration
public static ICellEffect? GetEffect(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Returns
Type | Description |
---|---|
ICellEffect | The effect. |
GetForeground(ISurface, int, int)
Gets the foreground of a specified cell.
Declaration
public static Color GetForeground(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Returns
Type | Description |
---|---|
Color | The color. |
GetGlyph(ISurface, int, int)
Gets the glyph of a specified cell.
Declaration
public static int GetGlyph(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Returns
Type | Description |
---|---|
int | The glyph index. |
GetMirror(ISurface, int, int)
Gets the mirror of a specified cell.
Declaration
public static Mirror GetMirror(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Returns
GetString(ISurface, int, int)
Builds a string from the cells.
Declaration
public static string GetString(this ISurface obj, int index, int length)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | Where to start getting characters from. |
int | length | How many characters to fill the string with. |
Returns
Type | Description |
---|---|
string | A string built from the text surface data. |
GetString(ISurface, int, int, int)
Builds a string from the text surface from the specified coordinates.
Declaration
public static string GetString(this ISurface obj, int x, int y, int length)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x position of the surface to start at. |
int | y | The y position of the surface to start at. |
int | length | How many characters to fill the string with. |
Returns
Type | Description |
---|---|
string | A string built from the text surface data. |
GetStringColored(ISurface, int, int)
Builds a string from the text surface.
Declaration
public static ColoredString GetStringColored(this ISurface obj, int index, int length)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | Where to start getting characters from. |
int | length | How many characters to fill the string with. |
Returns
Type | Description |
---|---|
ColoredString | A string built from the text surface data. |
GetStringColored(ISurface, int, int, int)
Builds a string from the text surface from the specified coordinates.
Declaration
public static ColoredString GetStringColored(this ISurface obj, int x, int y, int length)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x position of the surface to start at. |
int | y | The y position of the surface to start at. |
int | length | How many characters to fill the string with. |
Returns
Type | Description |
---|---|
ColoredString | A string built from the text surface data. |
GetSubSurface(ISurface)
Returns a new surface using the cells from the current surface.
Declaration
public static ICellSurface GetSubSurface(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface. |
Returns
Type | Description |
---|---|
ICellSurface | A new surface instance. |
GetSubSurface(ISurface, Rectangle)
Returns a new surface with reference to each cell inside of the view
.
Declaration
public static ICellSurface GetSubSurface(this ISurface obj, Rectangle view)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Rectangle | view | An area of the surface to create a view of. |
Returns
Type | Description |
---|---|
ICellSurface | A new surface |
IsValidCell(ISurface, int)
Tests if a cell is valid based on its index.
Declaration
public static bool IsValidCell(this ISurface obj, int index)
Parameters
Returns
Type | Description |
---|---|
bool | A true value indicating the cell index is in this cell obj.Surface. |
IsValidCell(ISurface, int, int)
Tests if a cell is valid based on its x,y position.
Declaration
public static bool IsValidCell(this ISurface obj, int x, int y)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x coordinate of the cell to test. |
int | y | The y coordinate of the cell to test. |
Returns
Type | Description |
---|---|
bool | A true value indicating the cell by x,y does exist in this cell obj.Surface. |
IsValidCell(ISurface, int, int, out int)
Tests if a cell is valid based on its x,y position.
Declaration
public static bool IsValidCell(this ISurface obj, int x, int y, out int index)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x coordinate of the cell to test. |
int | y | The y coordinate of the cell to test. |
int | index | If the cell is valid, the index of the cell when found. |
Returns
Type | Description |
---|---|
bool | A true value indicating the cell by x,y does exist in this cell obj.Surface. |
Print(ISurface, int, int, ColoredGlyphBase[])
Draws the string on the console at the specified location, wrapping if needed.
Declaration
public static void Print(this ISurface obj, int x, int y, ColoredGlyphBase[] glyphs)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
ColoredGlyphBase[] | glyphs | An array of glyphs to print at the specified position. |
Print(ISurface, int, int, ColoredString)
Draws the string on the console at the specified location, wrapping if needed.
Declaration
public static void Print(this ISurface obj, int x, int y, ColoredString text)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
ColoredString | text | The string to display. |
Print(ISurface, int, int, IEnumerable<ColoredGlyphBase>)
Draws the string on the console at the specified location, wrapping if needed.
Declaration
public static void Print(this ISurface obj, int x, int y, IEnumerable<ColoredGlyphBase> glyphs)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
IEnumerable<ColoredGlyphBase> | glyphs | An enumeration of glyphs to print at the specified position. |
Print(ISurface, int, int, string)
Draws the string on the console at the specified location, wrapping if needed.
Declaration
public static void Print(this ISurface obj, int x, int y, string text)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
string | text | The string to display. |
Print(ISurface, int, int, string, ColoredGlyphBase, ICellEffect?)
Draws the string on the console at the specified location, wrapping if needed.
Declaration
public static void Print(this ISurface obj, int x, int y, string text, ColoredGlyphBase appearance, ICellEffect? effect = null)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
string | text | The string to display. |
ColoredGlyphBase | appearance | The appearance of the cell |
ICellEffect | effect | An optional effect to apply to the printed obj.Surface. |
Print(ISurface, int, int, string, Mirror)
Draws the string on the console at the specified location with the specified settings.
Declaration
public static void Print(this ISurface obj, int x, int y, string text, Mirror mirror)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
string | text | The string to display. |
Mirror | mirror | The mirror to set on all characters in the text. |
Print(ISurface, int, int, string, Color)
Draws the string on the console at the specified location and color, wrapping if needed.
Declaration
public static void Print(this ISurface obj, int x, int y, string text, Color foreground)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
string | text | The string to display. |
Color | foreground | Sets the foreground of all characters in the text. |
Print(ISurface, int, int, string, Color, Color)
Draws the string on the console at the specified location with the specified foreground and background color, wrapping if needed.
Declaration
public static void Print(this ISurface obj, int x, int y, string text, Color foreground, Color background)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
string | text | The string to display. |
Color | foreground | Sets the foreground of all characters in the text. |
Color | background | Sets the background of all characters in the text. |
Print(ISurface, int, int, string, Color, Color, Mirror)
Draws the string on the console at the specified location with the specified settings.
Declaration
public static void Print(this ISurface obj, int x, int y, string text, Color foreground, Color background, Mirror mirror)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
string | text | The string to display. |
Color | foreground | Sets the foreground of all characters in the text. |
Color | background | Sets the background of all characters in the text. |
Mirror | mirror | The mirror to set on all characters in the text. |
Print(ISurface, int, int, string, Color, Color, Mirror, CellDecorator[])
Draws the string on the console at the specified location with the specified settings.
Declaration
public static void Print(this ISurface obj, int x, int y, string text, Color foreground, Color background, Mirror mirror, CellDecorator[] decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | X location of the text. |
int | y | Y location of the text. |
string | text | The string to display. |
Color | foreground | Sets the foreground of all characters in the text. |
Color | background | Sets the background of all characters in the text. |
Mirror | mirror | The mirror to set on all characters in the text. |
CellDecorator[] | decorators | An array of cell decorators to use on each glyph. A null value will clear the decorators. |
PrintTheDraw(ICellSurface, int, int, string, TheDrawFont)
Prints text using TheDrawFont.
Declaration
public static void PrintTheDraw(this ICellSurface cellSurface, int x, int y, string text, TheDrawFont drawFont)
Parameters
Type | Name | Description |
---|---|---|
ICellSurface | cellSurface | Class implementing ICellSurface. |
int | x | X coordinate of the obj.Surface. |
int | y | Y coordinate of the obj.Surface. |
string | text | Text to print. |
TheDrawFont | drawFont | Instance of the TheDrawFont to use. |
PrintTheDraw(ICellSurface, int, string, TheDrawFont, HorizontalAlignment, int)
Prints text using TheDrawFont and horizontal alignment specified. Calculates x coordinate. Truncates string to fit it in one line.
Declaration
public static void PrintTheDraw(this ICellSurface cellSurface, int y, string text, TheDrawFont drawFont, HorizontalAlignment alignment, int padding = 0)
Parameters
Type | Name | Description |
---|---|---|
ICellSurface | cellSurface | Class implementing ICellSurface. |
int | y | Y coordinate of the obj.Surface. |
string | text | Text to print. |
TheDrawFont | drawFont | Instance of the TheDrawFont to use. |
HorizontalAlignment | alignment | HorizontalAlignment to use. |
int | padding | Amount of regular font characters used as horizontal padding on both sides of the output. |
RemoveDecorator(ISurface, Point, params CellDecorator[])
Removes the decorators from a cell.
Declaration
public static void RemoveDecorator(this ISurface obj, Point position, params CellDecorator[] decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Point | position | The x,y coordinate of the cell. |
CellDecorator[] | decorators | The decorators. |
RemoveDecorator(ISurface, int, params CellDecorator[])
Removes the decorators from a cell.
Declaration
public static void RemoveDecorator(this ISurface obj, int index, params CellDecorator[] decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | The index of the cell to start applying. |
CellDecorator[] | decorators | The decorators. |
RemoveDecorator(ISurface, int, int, params CellDecorator[])
Removes the decorators from one or more cells.
Declaration
public static void RemoveDecorator(this ISurface obj, int index, int count, params CellDecorator[] decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | The index of the cell to start applying. |
int | count | The count of cells to use from the index (inclusive). |
CellDecorator[] | decorators | The decorators. |
RemoveDecorator(ISurface, int, int, int, params CellDecorator[])
Removes the decorators from one or more cells.
Declaration
public static void RemoveDecorator(this ISurface obj, int x, int y, int count, params CellDecorator[] decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x coordinate of the cell. |
int | y | The y coordinate of the cell. |
int | count | The count of cells to use from the x,y coordinate (inclusive). |
CellDecorator[] | decorators | The decorators. |
SetBackground(ISurface, int, int, Color)
Changes the background of a cell to the specified color.
Declaration
public static void SetBackground(this ISurface obj, int x, int y, Color color)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Color | color | The desired color of the cell. |
SetCellAppearance(ISurface, int, int, ColoredGlyphBase)
Changes the appearance of the cell. The appearance represents the look of a cell and will first be cloned, then applied to the cell.
Declaration
public static void SetCellAppearance(this ISurface obj, int x, int y, ColoredGlyphBase appearance)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
ColoredGlyphBase | appearance | The desired appearance of the cell. A null value cannot be passed. |
SetDecorator(ISurface, Point, params CellDecorator[]?)
Sets the decorators of a cell.
Declaration
public static void SetDecorator(this ISurface obj, Point position, params CellDecorator[]? decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Point | position | The coordinate of the cell. |
CellDecorator[] | decorators | The decorators. Use to clear.
|
SetDecorator(ISurface, int, params CellDecorator[]?)
Sets the decorators of a single cell.
Declaration
public static void SetDecorator(this ISurface obj, int index, params CellDecorator[]? decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | The index of the cell to start applying. |
CellDecorator[] | decorators | The decorators. Use to clear.
|
SetDecorator(ISurface, int, int, params CellDecorator[]?)
Sets the decorator of one or more cells.
Declaration
public static void SetDecorator(this ISurface obj, int index, int count, params CellDecorator[]? decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | The index of the cell to start applying. |
int | count | The count of cells to use from the index (inclusive). |
CellDecorator[] | decorators | The decorators. Use to clear.
|
SetDecorator(ISurface, int, int, int, params CellDecorator[]?)
Sets the decorator of one or more cells.
Declaration
public static void SetDecorator(this ISurface obj, int x, int y, int count, params CellDecorator[]? decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x coordinate of the cell. |
int | y | The y coordinate of the cell. |
int | count | The count of cells to use from the x,y coordinate (inclusive). |
CellDecorator[] | decorators | The decorators. Use to clear.
|
SetEffect(ISurface, ColoredGlyphBase, ICellEffect?)
Changes the effect of a cell to the specified effect.
Declaration
public static void SetEffect(this ISurface obj, ColoredGlyphBase cell, ICellEffect? effect)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ColoredGlyphBase | cell | The cells for the effect. |
ICellEffect | effect | The desired effect. |
SetEffect(ISurface, IEnumerable<ColoredGlyphBase>, ICellEffect?)
Changes the effect of a cell to the specified effect.
Declaration
public static void SetEffect(this ISurface obj, IEnumerable<ColoredGlyphBase> cells, ICellEffect? effect)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
IEnumerable<ColoredGlyphBase> | cells | The cells for the effect. |
ICellEffect | effect | The desired effect. |
SetEffect(ISurface, IEnumerable<Point>, ICellEffect?)
Changes the effect of a list of cells to the specified effect.
Declaration
public static void SetEffect(this ISurface obj, IEnumerable<Point> cells, ICellEffect? effect)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
IEnumerable<Point> | cells | The cells for the effect. |
ICellEffect | effect | The desired effect. |
SetEffect(ISurface, IEnumerable<int>, ICellEffect?)
Changes the effect of a list of cells to the specified effect.
Declaration
public static void SetEffect(this ISurface obj, IEnumerable<int> cells, ICellEffect? effect)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
IEnumerable<int> | cells | The cells for the effect. |
ICellEffect | effect | The desired effect. |
SetEffect(ISurface, int, ICellEffect?)
Changes the effect of a cell to the specified effect.
Declaration
public static void SetEffect(this ISurface obj, int index, ICellEffect? effect)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | index | Index of the cell. |
ICellEffect | effect | The desired effect. |
SetEffect(ISurface, int, int, ICellEffect?)
Changes the effect of a cell to the specified effect.
Declaration
public static void SetEffect(this ISurface obj, int x, int y, ICellEffect? effect)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
ICellEffect | effect | The desired effect. |
SetForeground(ISurface, int, int, Color)
Changes the foreground of a specified cell to a new color.
Declaration
public static void SetForeground(this ISurface obj, int x, int y, Color color)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Color | color | The desired color of the cell. |
SetGlyph(ISurface, int, int, int)
Changes the glyph of a specified cell to a new value.
Declaration
public static void SetGlyph(this ISurface obj, int x, int y, int glyph)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
int | glyph | The desired glyph of the cell. |
SetGlyph(ISurface, int, int, int, Color)
Changes the glyph and foreground of a cell.
Declaration
public static void SetGlyph(this ISurface obj, int x, int y, int glyph, Color foreground)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
int | glyph | The desired glyph. |
Color | foreground | The desired foreground. |
SetGlyph(ISurface, int, int, int, Color, Color)
Changes the glyph, foreground, and background of a cell.
Declaration
public static void SetGlyph(this ISurface obj, int x, int y, int glyph, Color foreground, Color background)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
int | glyph | The desired glyph. |
Color | foreground | The desired foreground. |
Color | background | The desired background. |
SetGlyph(ISurface, int, int, int, Color, Color, Mirror)
Changes the glyph, foreground, background, and mirror of a cell.
Declaration
public static void SetGlyph(this ISurface obj, int x, int y, int glyph, Color foreground, Color background, Mirror mirror)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
int | glyph | The desired glyph. |
Color | foreground | The desired foreground. |
Color | background | The desired background. |
Mirror | mirror | Sets how the glyph will be mirrored. |
SetGlyph(ISurface, int, int, int, Color, Color, Mirror, IEnumerable<CellDecorator>)
Changes the glyph, foreground, background, and mirror of a cell.
Declaration
public static void SetGlyph(this ISurface obj, int x, int y, int glyph, Color foreground, Color background, Mirror mirror, IEnumerable<CellDecorator> decorators)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
int | glyph | The desired glyph. |
Color | foreground | The desired foreground. |
Color | background | The desired background. |
Mirror | mirror | Sets how the glyph will be mirrored. |
IEnumerable<CellDecorator> | decorators | Decorators to set on the cell. Will clear existing decorators first. |
SetMirror(ISurface, int, int, Mirror)
Sets the mirror of a specified cell.
Declaration
public static void SetMirror(this ISurface obj, int x, int y, Mirror mirror)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | x | The x location of the cell. |
int | y | The y location of the cell. |
Mirror | mirror | The mirror of the cell. |
SetPixels(ISurface, Color[])
Sets each background of a cell to the array of colors. pixels
must be the same length as the amount of cells in the surface.
Declaration
public static void SetPixels(this ISurface obj, Color[] pixels)
Parameters
SetPixels(ISurface, Rectangle, Color[])
Sets each background of a cell to the array of colors.
Declaration
public static void SetPixels(this ISurface obj, Rectangle area, Color[] pixels)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
Rectangle | area | An area to fill with pixels. |
Color[] | pixels | Colors for each cell of the obj.Surface. |
ShiftColumn(ISurface, int, int, bool)
Shifts the entire column by the specified amount.
Declaration
public static void ShiftColumn(this ISurface obj, int col, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | col | The column to shift. |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
ShiftColumn(ISurface, int, int, int, int, bool)
Shifts the specified row from an X position, by the specified amount.
Declaration
public static void ShiftColumn(this ISurface obj, int col, int startingY, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | col | The column to shift. |
int | startingY | The starting row to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
Exceptions
Type | Condition |
---|---|
ArgumentOutOfRangeException | One of the parameters is outside of the surface height. |
ShiftColumnDown(ISurface, int, int, int, int, bool)
Shifts the specified row from n Y position, by the specified amount, down.
Declaration
public static void ShiftColumnDown(this ISurface obj, int col, int startingY, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | col | The column to shift. |
int | startingY | The starting row to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
Exceptions
Type | Condition |
---|---|
ArgumentOutOfRangeException | One of the parameters is outside of the surface height. |
ShiftColumnDownUnchecked(ISurface, int, int, int, int, bool)
Internal use. Doesn't do any checks on valid values. Shifts the specified row from a Y position, by the specified amount, down.
Declaration
public static void ShiftColumnDownUnchecked(this ISurface obj, int col, int startingY, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | col | The column to shift. |
int | startingY | The starting column to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
ShiftColumnUp(ISurface, int, int, int, int, bool)
Shifts the specified row from n Y position, by the specified amount, up.
Declaration
public static void ShiftColumnUp(this ISurface obj, int col, int startingY, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | col | The column to shift. |
int | startingY | The starting row to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
Exceptions
Type | Condition |
---|---|
ArgumentOutOfRangeException | One of the parameters is outside of the surface height. |
ShiftColumnUpUnchecked(ISurface, int, int, int, int, bool)
Internal use. Doesn't do any checks on valid values. Shifts the specified row from a Y position, by the specified amount, up.
Declaration
public static void ShiftColumnUpUnchecked(this ISurface obj, int col, int startingY, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | col | The column to shift. |
int | startingY | The starting column to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
ShiftDown(ISurface)
Scrolls all the console data down by one.
Declaration
public static void ShiftDown(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ShiftDown(ISurface, int, bool)
Scrolls all the console data down by the specified amount of rows.
Declaration
public static void ShiftDown(this ISurface obj, int amount, bool wrap = false)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | amount | How many rows to shift. |
bool | wrap | When false, a blank line appears at the top. When true, the bottom line appears at the top. |
ShiftLeft(ISurface)
Scrolls all the console data left by one.
Declaration
public static void ShiftLeft(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ShiftLeft(ISurface, int, bool)
Scrolls all the console data left by the specified amount.
Declaration
public static void ShiftLeft(this ISurface obj, int amount, bool wrap = false)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | amount | How much to scroll. |
bool | wrap | When false, a blank line appears at the right. When true, the left line appears at the right. |
ShiftRight(ISurface)
Scrolls all the console data right by one.
Declaration
public static void ShiftRight(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ShiftRight(ISurface, int, bool)
Scrolls all the console data right by the specified amount.
Declaration
public static void ShiftRight(this ISurface obj, int amount, bool wrap = false)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | amount | How much to scroll. |
bool | wrap | When false, a blank line appears at the left. When true, the right line appears at the left. |
ShiftRow(ISurface, int, int, bool)
Shifts the entire row by the specified amount.
Declaration
public static void ShiftRow(this ISurface obj, int row, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | row | The row to shift. |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
ShiftRow(ISurface, int, int, int, int, bool)
Shifts the specified row from an X position, by the specified amount.
Declaration
public static void ShiftRow(this ISurface obj, int row, int startingX, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | row | The row to shift. |
int | startingX | The starting column to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
Exceptions
Type | Condition |
---|---|
ArgumentOutOfRangeException | One of the parameters is outside of the surface width. |
ShiftRowLeft(ISurface, int, int, int, int, bool)
Shifts the specified row from an X position, by the specified amount, to the left.
Declaration
public static void ShiftRowLeft(this ISurface obj, int row, int startingX, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | row | The row to shift. |
int | startingX | The starting column to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
Exceptions
Type | Condition |
---|---|
ArgumentOutOfRangeException | One of the parameters is outside of the surface width. |
ShiftRowLeftUnchecked(ISurface, int, int, int, int, bool)
Internal use. Doesn't do any checks on valid values. Shifts the specified row from an X position, by the specified amount, to the left.
Declaration
public static void ShiftRowLeftUnchecked(this ISurface obj, int row, int startingX, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | row | The row to shift. |
int | startingX | The starting column to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
ShiftRowRight(ISurface, int, int, int, int, bool)
Shifts the specified row from an X position, by the specified amount, to the right.
Declaration
public static void ShiftRowRight(this ISurface obj, int row, int startingX, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | row | The row to shift. |
int | startingX | The starting column to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
Exceptions
Type | Condition |
---|---|
ArgumentOutOfRangeException | One of the parameters is outside of the surface width. |
ShiftRowRightUnchecked(ISurface, int, int, int, int, bool)
Internal use. Doesn't do any checks on valid values. Shifts the specified row from an X position, by the specified amount, to the right.
Declaration
public static void ShiftRowRightUnchecked(this ISurface obj, int row, int startingX, int count, int amount, bool wrap)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
int | row | The row to shift. |
int | startingX | The starting column to shift from. |
int | count | The number of cells to shift starting from |
int | amount | The amount to shift by. A negative value shifts left and a positive value shifts right. |
bool | wrap | When true, wraps the glyph data from one side to another, otherwise clears the glyphs left behind. |
ShiftUp(ISurface)
Scrolls all the console data up by one.
Declaration
public static void ShiftUp(this ISurface obj)
Parameters
Type | Name | Description |
---|---|---|
ISurface | obj | The surface being edited. |
ShiftUp(ISurface, int, bool)
Scrolls all the console data up by the specified amount of rows.
Declaration
public static void ShiftUp(this ISurface obj, int amount, bool wrap = false)