Class FilledBox

constructor

• new FilledBox(opts): FilledBox

• Build a FilledBox

  Parameters

  • opts: {
        fillColor: string;
        height: number;
        lineColor?: string;
        lineWidth?: number;
        offset?: {
            dx: number;
            dy: 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

    • width: number

      Width of the box

    • Optional z?: ZIndex

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

  Returns FilledBox

Optional actor

fillColor

Readonly graphics

height

Optional lineColor

Optional lineWidth

offset

width

z

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 FilledBox

  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