Class FilledRoundedBox

FilledRoundedBox describes any object whose visual representation is a filled box with rounded corners. These are particularly useful as the background for text messages.

Constructors

constructor

Properties

actor? fillColor graphics height lineColor? lineWidth? offset radius width z

Methods

prerender render resize

Constructors

constructor

  • new FilledRoundedBox(opts): FilledRoundedBox

  • Build a FilledRoundedBox

    Parameters

    • opts: {
          fillColor: string;
          height: number;
          lineColor?: string;
          lineWidth?: number;
          offset?: {
              dx: number;
              dy: number;
          };
          radius: number;
          width: number;
          z?: ZIndex;
      }
      • fillColor: string

        Color to fill the box

      • height: number

        Height of the box

      • Optional lineColor?: string

        Optional color for the border

      • Optional lineWidth?: number

        Optional width of the border

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

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

        • dx: number
        • dy: number
      • radius: number

        Radius of the corners

      • width: number

        Width of the box

      • Optional z?: ZIndex

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

    Returns FilledRoundedBox

Properties

Optional actor

actor?: Actor

The Actor to which this FilledSprite is attached

fillColor

fillColor: string

Fill color

Readonly graphics

graphics: Graphics = ...

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

height

height: number

Height of the box

Optional lineColor

lineColor?: string

Line color

Optional lineWidth

lineWidth?: number

Line width

offset

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

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

Type declaration

  • dx: number
  • dy: number

radius

radius: number

Radius of the corners

width

width: number

Width of the box

z

z: ZIndex

Z index of the box

Methods

prerender

  • prerender(_elapsedMs): void

  • Perform any custom updates to the box before displaying it

    Parameters

    • _elapsedMs: number

    Returns void

render

  • render(camera, _elapsedMs, location): void

  • Render the FilledRoundedBox

    Parameters

    • camera: CameraService

      The camera for the current stage

    • _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 box. 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