StackedTile

interface StackedTile : Tile

This tile implementation contains a stack of Tiles. This can be used to create compositions of Tiles that will be rendered on top of each other (form bottom to top) without having to use Layers.

A StackedTile must have at least oneTile in its stack (tiles) therefore any implementation of this interface must ensure this property.

Since

2020.2.0-RELEASE

See also

Types

Companion
Link copied to clipboard
common
object Companion

Functions

asCharacterTile
Link copied to clipboard
common
abstract fun asCharacterTile(): Maybe<CharacterTile>
Returns this Tile as a CharacterTile if possible.
asGraphicTile
Link copied to clipboard
common
abstract fun asGraphicTile(): Maybe<GraphicalTile>
Returns this Tile as a GraphicalTile if possible.
asImageTile
Link copied to clipboard
common
abstract fun asImageTile(): Maybe<ImageTile>
Returns this Tile as an ImageTile if possible.
createCopy
Link copied to clipboard
common
abstract override fun createCopy(): Tile
Creates a deep copy of this object.
equals
Link copied to clipboard
common
open operator fun equals(other: Any?): Boolean
fetchBorderData
Link copied to clipboard
common
abstract fun fetchBorderData(): Set<Border>
hashCode
Link copied to clipboard
common
open fun hashCode(): Int
toBuilder
Link copied to clipboard
common
abstract fun toBuilder(): TileBuilder
Creates a new TileBuilder preconfigured with the contents of this Tile.
toString
Link copied to clipboard
common
open fun toString(): String
withAddedModifiers
Link copied to clipboard
common
abstract override fun withAddedModifiers(vararg modifiers: Modifier): Tile
Creates a copy of this StyleSet with the given modifiers added.
abstract override fun withAddedModifiers(modifiers: Set<Modifier>): Tile
Creates a copy of this StyleSet with the given modifiers added.
withBackgroundColor
Link copied to clipboard
common
abstract override fun withBackgroundColor(backgroundColor: TileColor): Tile
Creates a copy of this StyleSet with the given background color.
withBaseTile
Link copied to clipboard
common
abstract fun withBaseTile(tile: Tile): StackedTile
Returns a new StackedTile that has its baseTile replaced by the given tile.
withForegroundColor
Link copied to clipboard
common
abstract override fun withForegroundColor(foregroundColor: TileColor): Tile
Creates a copy of this StyleSet with the given foreground color.
withModifiers
Link copied to clipboard
common
abstract override fun withModifiers(vararg modifiers: Modifier): Tile
Creates a copy of this StyleSet with the given modifiers.
abstract override fun withModifiers(modifiers: Set<Modifier>): Tile
Creates a copy of this StyleSet with the given modifiers.
withNoModifiers
Link copied to clipboard
common
abstract override fun withNoModifiers(): Tile
Creates a copy of this StyleSet with no modifiers.
withPushedTile
Link copied to clipboard
common
abstract fun withPushedTile(tile: Tile): StackedTile
Returns a new StackedTile that's the copy of this one, with the given tile pushed on top of the stack.
withRemovedModifiers
Link copied to clipboard
common
abstract override fun withRemovedModifiers(vararg modifiers: Modifier): Tile
Creates a copy of this StyleSet with the given modifiers removed.
abstract override fun withRemovedModifiers(modifiers: Set<Modifier>): Tile
Creates a copy of this StyleSet with the given modifiers removed.
withRemovedTile
Link copied to clipboard
common
abstract fun withRemovedTile(tile: Tile): StackedTile
Returns a new StackedTile that's the copy of this one, with the given tile removed.
withStyle
Link copied to clipboard
common
abstract fun withStyle(style: StyleSet): Tile
Returns a copy of this Tile with the specified style.

Properties

backgroundColor
Link copied to clipboard
common
abstract val backgroundColor: TileColor
baseTile
Link copied to clipboard
common
abstract val baseTile: Tile
The Tile that's the base of this StackedTile.
cacheKey
Link copied to clipboard
common
abstract val cacheKey: String
A unique and immutable cache key for this object.
foregroundColor
Link copied to clipboard
common
abstract val foregroundColor: TileColor
hasBorder
Link copied to clipboard
common
abstract val hasBorder: Boolean
isBlinking
Link copied to clipboard
common
abstract val isBlinking: Boolean
isCrossedOut
Link copied to clipboard
common
abstract val isCrossedOut: Boolean
isEmpty
Link copied to clipboard
common
abstract val isEmpty: Boolean
Tells whether this Tileis an empty Tile (it is the Tile.empty instance).
isHorizontalFlipped
Link copied to clipboard
common
abstract val isHorizontalFlipped: Boolean
isNotEmpty
Link copied to clipboard
common
abstract val isNotEmpty: Boolean
Tells whether this Tileis not an empty Tile (it is not the Tile.empty instance).
isOpaque
Link copied to clipboard
common
abstract val isOpaque: Boolean
isUnderlined
Link copied to clipboard
common
abstract val isUnderlined: Boolean
isVerticalFlipped
Link copied to clipboard
common
abstract val isVerticalFlipped: Boolean
modifiers
Link copied to clipboard
common
abstract val modifiers: Set<Modifier>
styleSet
Link copied to clipboard
common
abstract val styleSet: StyleSet
tiles
Link copied to clipboard
common
abstract val tiles: List<Tile>
Contains all the tiles in this StackedTile from top to bottom.
tileType
Link copied to clipboard
common
abstract val tileType: TileType
top
Link copied to clipboard
common
abstract val top: Tile
The Tile on top of this stack.

Inheritors

DefaultStackedTile
Link copied to clipboard
FastStackedTile
Link copied to clipboard

Sources

(source)
Link copied to clipboard