roguelike-starterkit
API
Generated with
roguelike-starterkit/roguelikestarterkit/roguelikestarterkit.terminal/Terminal

Terminal

roguelikestarterkit.terminal.Terminal
See theTerminal companion object
trait Terminal

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

def clear: Terminal

Remove all values from the terminal, behaviour varies by implementation.

Remove all values from the terminal, behaviour varies by implementation.

Attributes

def combine(otherConsole: Terminal): Terminal

Merge two terminals together

Merge two terminals together

Attributes

def delete(coords: Point): Terminal

Removes an entry from the terminal, implementations vary.

Removes an entry from the terminal, implementations vary.

Attributes

def fill(tile: Tile, foregroundColor: RGBA, backgroundColor: RGBA): Terminal

Fill the whole terminal with the supplied value

Fill the whole terminal with the supplied value

Attributes

def fill(mapTile: MapTile): Terminal

Fill the whole terminal with the supplied value

Fill the whole terminal with the supplied value

Attributes

def fillCircle(circle: Circle, mapTile: MapTile): Terminal
def fillCircle(circle: Circle, tile: Tile): Terminal
def fillCircle(circle: Circle, tile: Tile, foreground: RGBA): Terminal
def fillCircle(circle: Circle, tile: Tile, foreground: RGBA, background: RGBA): Terminal
def fillLine(line: LineSegment, mapTile: MapTile): Terminal
def fillLine(line: LineSegment, tile: Tile): Terminal
def fillLine(line: LineSegment, tile: Tile, foreground: RGBA): Terminal
def fillLine(line: LineSegment, tile: Tile, foreground: RGBA, background: RGBA): Terminal
def fillLine(from: Point, to: Point, mapTile: MapTile): Terminal
def fillLine(from: Point, to: Point, tile: Tile): Terminal
def fillLine(from: Point, to: Point, tile: Tile, foreground: RGBA): Terminal
def fillLine(from: Point, to: Point, tile: Tile, foreground: RGBA, background: RGBA): Terminal
def fillRectangle(region: Rectangle, mapTile: MapTile): Terminal
def fillRectangle(region: Rectangle, tile: Tile): Terminal
def fillRectangle(region: Rectangle, tile: Tile, foreground: RGBA): Terminal
def fillRectangle(region: Rectangle, tile: Tile, foreground: RGBA, background: RGBA): Terminal
def get(coords: Point): Option[MapTile]

Retrieves the MapTile at a given point, if one is present.

Retrieves the MapTile at a given point, if one is present.

Attributes

def inset(otherConsole: Terminal, offset: Point): Terminal

Inset one terminal inside another at some position offset.

Inset one terminal inside another at some position offset.

Attributes

def map(modifier: (Point, MapTile) => MapTile): Terminal
def mapCircle(circle: Circle)(modifier: (Point, MapTile) => MapTile): Terminal
def mapLine(from: Point, to: Point)(modifier: (Point, MapTile) => MapTile): Terminal
def mapLine(line: LineSegment)(modifier: (Point, MapTile) => MapTile): Terminal
def mapRectangle(region: Rectangle)(modifier: (Point, MapTile) => MapTile): Terminal
def modifyAt(position: Point)(modifier: MapTile => MapTile): Terminal
def put(coords: Point, tile: Tile, foregroundColor: RGBA, backgroundColor: RGBA): Terminal

Put the tile at the given point

Put the tile at the given point

Attributes

def put(coords: Point, tile: Tile, foregroundColor: RGBA): Terminal

Put the tile at the given point

Put the tile at the given point

Attributes

def put(coords: Point, tile: Tile): Terminal

Put the Tile at the given point

Put the Tile at the given point

Attributes

def put(tiles: Batch[(Point, MapTile)]): Terminal

Put a batch of tiles into the terminal at the positions specified

Put a batch of tiles into the terminal at the positions specified

Attributes

def put(tiles: Batch[(Point, MapTile)], offset: Point): Terminal

Put a batch of tiles into the terminal at the positions specified, with an offset.

Put a batch of tiles into the terminal at the positions specified, with an offset.

Attributes

def put(tiles: (Point, MapTile)*): Terminal

Put a batch of tiles into the terminal at the positions specified

Put a batch of tiles into the terminal at the positions specified

Attributes

def put(coords: Point, mapTile: MapTile): Terminal

Put the MapTile at the given point

Put the MapTile at the given point

Attributes

def putLine(startCoords: Point, text: String, foregroundColor: RGBA, backgroundColor: RGBA): Terminal

Adds a line of text to the terminal. No attempt is made to wrap text.

Adds a line of text to the terminal. No attempt is made to wrap text.

Attributes

def putLines(startCoords: Point, textLines: Batch[String], foregroundColor: RGBA, backgroundColor: RGBA): Terminal

Add many lines to the terminal

Add many lines to the terminal

Attributes

def size: Size
def toBatch: Batch[MapTile]

Export the terminal as a batch of MapTiles.

Export the terminal as a batch of MapTiles.

Attributes

def toBatch(region: Rectangle): Batch[MapTile]

Export the terminal as a batch of MapTiles for a given region.

Export the terminal as a batch of MapTiles for a given region.

Attributes

def toPositionedBatch: Batch[(Point, MapTile)]

Export the terminal as a batch of maptiles tupled with with their positions.

Export the terminal as a batch of maptiles tupled with with their positions.

Attributes

def toPositionedBatch(region: Rectangle): Batch[(Point, MapTile)]

Export the terminal as a batch of maptiles tupled with with their positions, in a given region.

Export the terminal as a batch of maptiles tupled with with their positions, in a given region.

Attributes

def toTileBatch: Batch[MapTile]

Export terminal as a complete grid of tiles, missing tiles will be given the Tile.Null values and RGBA.Zero colors.

Export terminal as a complete grid of tiles, missing tiles will be given the Tile.Null values and RGBA.Zero colors.

Attributes

def toTileBatch(region: Rectangle): Batch[MapTile]

Export terminal as a complete grid of tiles for a given region, missing tiles will be given the Tile.Null values and RGBA.Zero colors.

Export terminal as a complete grid of tiles for a given region, missing tiles will be given the Tile.Null values and RGBA.Zero colors.

Attributes

def |+|(otherConsole: Terminal): Terminal

Merge two terminals together

Merge two terminals together

Attributes

Concrete methods

def toCloneTiles(idPrefix: CloneId, position: Point, charCrops: Batch[(Int, Int, Int, Int)])(makeBlank: (RGBA, RGBA) => Cloneable): TerminalClones

Creates a TerminalClones instance of the given map.

Creates a TerminalClones instance of the given map.

Attributes

def toCloneTiles(idPrefix: CloneId, position: Point, charCrops: Batch[(Int, Int, Int, Int)], region: Rectangle)(makeBlank: (RGBA, RGBA) => Cloneable): TerminalClones

Creates a TerminalClones instance of a defined region of the given map.

Creates a TerminalClones instance of a defined region of the given map.

Attributes

def toCloneTiles(idPrefix: CloneId, position: Point, charCrops: Batch[(Int, Int, Int, Int)], modifier: (Point, MapTile) => (Point, Radians, Vector2))(makeBlank: (RGBA, RGBA) => Cloneable): TerminalClones

Export the terminal so that it can be rendered as CloneTiles, and supply a modifier funtion to alter the relative position, rotation, and scale of the tile.

Export the terminal so that it can be rendered as CloneTiles, and supply a modifier funtion to alter the relative position, rotation, and scale of the tile.

Attributes

def toCloneTiles(idPrefix: CloneId, position: Point, charCrops: Batch[(Int, Int, Int, Int)], region: Rectangle, modifier: (Point, MapTile) => (Point, Radians, Vector2))(makeBlank: (RGBA, RGBA) => Cloneable): TerminalClones

Export the terminal so that it can be rendered as CloneTiles for a defined region of the given map, and supply a modifier funtion to alter the relative position, rotation, and scale of the tile.

Export the terminal so that it can be rendered as CloneTiles for a defined region of the given map, and supply a modifier funtion to alter the relative position, rotation, and scale of the tile.

Attributes

Generated with