Skip to content

Font ​

The Font class provides text measurement and drawing helpers for the renderer.


Methods ​

constructor(name: string, options?: LoadFontOptions)Font ​

Creates a new Font instance.

Returned:

  • Font - The result of the call.

GetTextSize(text: string)[number, number] ​

Retrieves the text size.

  • textstring - The text value.

Returned:

  • [number, number] - The requested text size.

GetAlignmentOffset(text: string, alignment?: Enum.ContentAlign)[number, number] ​

Retrieves the alignment offset.

Returned:

  • [number, number] - The requested alignment offset.

DrawText(x: number, y: number, text: string)void ​

Draws the text.

  • xnumber - The x coordinate.
  • ynumber - The y coordinate.
  • textstring - The text value.

DrawWorldText(vec: Vector, text: string, xOffset?: number, yOffset?: number)void ​

Draws the world text.

  • vecVector - The world position vector.
  • textstring - The text value.
  • xOffsetnumber (optional) - The x offset.
  • yOffsetnumber (optional) - The y offset.