Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextComponentState

The state object describes the information to visualize for this component.

Hierarchy

Index

Constructors

constructor

Properties

ptr

ptr: number

Methods

center

  • center(): string
  • Accesses the centered text. If the text isn't centered, an empty string is returned instead.

    Returns string

dispose

  • dispose(): void
  • Disposes the object, allowing it to clean up all of its memory. You need to call this for every object that you don't use anymore and hasn't already been disposed.

    Returns void

isSplit

  • isSplit(): boolean
  • Returns whether the text is split up into a left and right part.

    Returns boolean

left

  • left(): string
  • Accesses the left part of the text. If the text isn't split up, an empty string is returned instead.

    Returns string

right

  • right(): string
  • Accesses the right part of the text. If the text isn't split up, an empty string is returned instead.

    Returns string

with

  • Allows for scoped usage of the object. The object is guaranteed to get disposed once this function returns. You are free to dispose the object early yourself anywhere within the scope. The scope's return value gets carried to the outside of this function.

    Type parameters

    • T

    Parameters

    Returns T

Generated using TypeDoc