Class TextSprite

TextSprite describes any text object that can be drawn to the screen. The text that is displayed can be controlled by a callback, so that it can change over time.

Constructors

constructor

Properties

actor? center color face height offset producer size strokeColor? strokeWidth? text width z

Methods

dims prerender render resize

Constructors

constructor

  • new TextSprite(opts, producer): TextSprite

  • Build some text that can be rendered

    Parameters

    • opts: {
          center: boolean;
          color: string;
          face: string;
          offset?: {
              dx: number;
              dy: number;
          };
          size: number;
          strokeColor?: string;
          strokeWidth?: number;
          z?: ZIndex;
      }
      • center: boolean

        Should the text be centered at the rigid body's (cx,cy) (true) or is the rigid body's (cx,cy) top-left (false)?

      • color: string

        Color for the text (should be an RGB string code, like #aa4433)

      • face: string

        Name of the font to use

      • Optional offset?: {
            dx: number;
            dy: number;
        }

        An offset between the component's center and its RigidBody's center (optional)

        • dx: number
        • dy: number
      • size: number

        Font size

      • Optional strokeColor?: string

        The color of the text outline (optional)

      • Optional strokeWidth?: number

        The width of the text outline (optional)

      • Optional z?: ZIndex

        An optional z index in the range [-2,2]

    • producer: string | (() => string)

      A function that creates the text to display, or a String

    Returns TextSprite

Properties

Optional actor

actor?: Actor

The Actor to which this TextSprite is attached

center

center: boolean

Should the text be centered at X,Y (true) or is (X,Y) top-left (false)

color

color: string

Color for the text

face

face: string

Font to use

height

height: number = 0

Height of the text (computed)

offset

offset: {
    dx: number;
    dy: number;
}

An offset between the TextSprite's center and the RigidBody's center

Type declaration

  • dx: number
  • dy: number

producer

producer: string | (() => string)

A function that creates the text to display, or a String

Type declaration

    • (): string

    • Returns string

size

size: number

Font size

Optional strokeColor

strokeColor?: string

Stroke color

Optional strokeWidth

strokeWidth?: number

Stroke width

Readonly text

text: Text

The low-level text object that we pass to the Renderer

width

width: number = 0

Width of the text (computed)

z

z: ZIndex

Z index of the image

Methods

dims

  • dims(camera, sampleText): {
        height: number;
        width: number;
    }

  • Return the width and height of the text

    Parameters

    • camera: CameraService

      The camera of the scene where the text is being drawn

    • sampleText: string

      Some text whose size we're computing, since the object's real text might not be available yet

    Returns {
        height: number;
        width: number;
    }

    • height: number
    • width: number

prerender

  • prerender(_elapsedMs): void

  • Perform any custom updates to the text before displaying it

    Parameters

    • _elapsedMs: number

    Returns void

render

  • render(camera, _elapsedMs, location): void

  • Render the text

    Parameters

    • camera: CameraService

      The camera that defines the bounds for the Scene where this image should be drawn

    • _elapsedMs: number

      The time since the last render

    • location: SpriteLocation

      Where should this be drawn (WORLD/OVERLAY/HUD)

    Returns void

resize

  • resize(scale): void

  • Change the size of the text. You shouldn't call this directly. It gets called by Actor.resize().

    Parameters

    • scale: number

      The amount to scale the size by. 1 means "no change", >1 means "grow", fraction means "shrink".

    Returns void

Settings

Member Visibility

Theme

On This Page