Modifiers

object Modifiers

This object contains factory methods for the Modifiers supported by Zircon.

Functions

blink
Link copied to clipboard
common
fun blink(): Modifier
border
Link copied to clipboard
common
fun border(): Border
Shorthand for the default border which is:
  • a simple border

  • on all sides (top, right, bottom, left)

crop
Link copied to clipboard
common
fun crop(x: Int, y: Int, width: Int, height: Int): Modifier
Crops the tile that contains this modifier.
crossedOut
Link copied to clipboard
common
fun crossedOut(): Modifier
delay
Link copied to clipboard
common
fun delay(timeMs: Long): Modifier
Keeps the tile that has this modifier hidden until timeMs milliseconds pass after adding the tile to a grid.
equals
Link copied to clipboard
common
open operator fun equals(other: Any?): Boolean
fadeIn
Link copied to clipboard
common
fun fadeIn(steps: Int = 20, timeMs: Long = 2000, glowOnFinalStep: Boolean = true): Modifier
Provides a fade in effect for the tile that has this modifier.
fadeInOut
Link copied to clipboard
common
fun fadeInOut(stepsFadeIn: Int = 20, timeMsFadeIn: Long = 2000, glowOnFinalFadeInStep: Boolean = false, timeMsBeforeFadingOut: Long = 5000, stepsFadeOut: Int = 20, timeMsFadeOut: Long = 2000): Modifier
fadeOut
Link copied to clipboard
common
fun fadeOut(steps: Int = 20, timeMs: Long = 2000): Modifier
Provides a fade out effect for the tile that has this modifier.
glow
Link copied to clipboard
common
fun glow(radius: Float = 5.0f): Modifier
Adds a glow effect to a tile.
hashCode
Link copied to clipboard
common
open fun hashCode(): Int
hidden
Link copied to clipboard
common
fun hidden(): Modifier
horizontalFlip
Link copied to clipboard
common
fun horizontalFlip(): Modifier
toString
Link copied to clipboard
common
open fun toString(): String
underline
Link copied to clipboard
common
fun underline(): Modifier
verticalFlip
Link copied to clipboard
common
fun verticalFlip(): Modifier

Sources

(source)
Link copied to clipboard