Interface

TextComp

:

The text component.

group Component Types

draw

: Comp["draw"]

text

: string

The text to render.

textSize

: number

The text size.

font

: string | BitmapFontData

The font to use.

width

: number

Width of text.

height

: number

Height of text.

align

: TextAlign

Text alignment ("left", "center" or "right", default "left").

since v3000.0

lineSpacing

: number

The gap between each line.

since v2000.2

letterSpacing

: number

The gap between each character.

since v2000.2

textTransform

: CharTransform | CharTransformFunc

Transform the pos, scale, rotation or color for each character based on the index or char.

since v2000.1

textStyles

: Record<string, CharTransform | CharTransformFunc>

Stylesheet for styled chunks, in the syntax of "this is a [style]text[/style] word".

since v2000.2

renderArea

(): Rect

since v3000.0

formattedText

(): FormattedText

The text data object after formatting, that contains the renering info as well as the parse data of the formatting tags.

kaplay logo

Layer

Miscalenous