Interface PBTextShape

Hierarchy

  • PBTextShape

Properties

font? fontAutoSize? fontSize? height? lineCount? lineSpacing? outlineColor? outlineWidth? paddingBottom? paddingLeft? paddingRight? paddingTop? shadowBlur? shadowColor? shadowOffsetX? shadowOffsetY? text textAlign? textColor? textWrapping? width?

Properties

Optional font

font?: Font

the font (default F_SANS_SERIF)

Optional fontAutoSize

fontAutoSize?: boolean

override font_size to automatically fit in width/height

Optional fontSize

fontSize?: number

the font size (default 10)

Optional height

height?: number

available vertical space (default 1)

Optional lineCount

lineCount?: number

maximum number of lines to display

Optional lineSpacing

lineSpacing?: number

extra distance between lines (default 0)

Optional outlineColor

outlineColor?: PBColor3

outline stroke color (default [1.0, 1.0, 1.0])

Optional outlineWidth

outlineWidth?: number

width of the stroke outlining each letter (default 0)

Optional paddingBottom

paddingBottom?: number

distance from text to bottom border (default 0)

Optional paddingLeft

paddingLeft?: number

distance from text to left border (default 0)

Optional paddingRight

paddingRight?: number

distance from text to right border (default 0)

Optional paddingTop

paddingTop?: number

distance from text to top border (default 0)

Optional shadowBlur

shadowBlur?: number

blurriness of the drop shadow (default 0)

Optional shadowColor

shadowColor?: PBColor3

drop shadow color (default [1.0, 1.0, 1.0])

Optional shadowOffsetX

shadowOffsetX?: number

horizontal length of the shadow (default 0)

Optional shadowOffsetY

shadowOffsetY?: number

vertical length of the shadow (default 0)

text

text: string

the content

Optional textAlign

textAlign?: TextAlignMode

X and Y alignment (default TAM_CENTER_CENTER)

Optional textColor

textColor?: PBColor4

text color (default [1.0, 1.0, 1.0])

Optional textWrapping

textWrapping?: boolean

wrap text when the border is reached (default false)

Optional width

width?: number

available horizontal space (default 1)

Settings

Member Visibility

Theme