Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Text

Hierarchy

  • Text

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns Text

Properties

anchor

anchor: TextAnchorLocation = TextAnchorLocation.TopLeft

The position of the text anchor relative to the block of text

contents

contents: string = ""

The text string to be drawn

enabled

enabled: boolean = true

Whether or not to draw the text

font

font: TextFontFamily = TextFontFamily.SansSerif

The font family to use to draw the text

height

height: number = 1

The height in meters of a line of text

justify

justify: TextJustify = TextJustify.Left

The alignment of each text line relative to the others

pixelsPerLine

pixelsPerLine: number = 50

The vertical resolution of a single line of text

Accessors

color

  • get color(): object
  • set color(value: Partial<Color3>): void
  • The text's color

    Returns object

  • The text's color

    Parameters

    Returns void

Methods

copy

  • Parameters

    Returns this

toJSON

  • Returns TextLike