Class FilledPolygon

FilledPolygon describes any object whose visual representation is a filled polygon.

Constructors

constructor

Properties

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

Methods

prerender render resize

Constructors

constructor

  • new FilledPolygon(opts): FilledPolygon

  • Build a FilledPolygon

    Parameters

    • opts: {
          fillColor?: string;
          lineColor?: string;
          lineWidth?: number;
          offset?: {
              dx: number;
              dy: number;
          };
          vertices: number[];
          z?: ZIndex;
      }
      • Optional fillColor?: string

        Color to fill the box

      • Optional lineColor?: string

        Color for the border

      • Optional lineWidth?: number

        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
      • vertices: number[]

        An array of vertex points. Even indices are x values, odd indices are y values. The points should be relative to the center.

      • Optional z?: ZIndex

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

    Returns FilledPolygon

Properties

Optional actor

actor?: Actor

The Actor to which this FilledPolygon is attached

Optional fillColor

fillColor?: string

Fill color

Readonly graphics

graphics: Graphics = ...

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

height

height: number

Height, to simplify some other code

Optional lineColor

lineColor?: string

Line color

Optional lineWidth

lineWidth?: number

Line width

offset

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

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

Type declaration

  • dx: number
  • dy: number

vertices

vertices: {
    x: number;
    y: number;
}[] = []

Vertices of the polygon

Type declaration

  • x: number
  • y: number

width

width: number

Width, to simplify some other code

z

z: ZIndex

Z index of the polygon: Must be in the range [-2, 2]

Methods

prerender

  • prerender(_elapsedMs): void

  • Perform any custom updates to the polygon before displaying it

    Parameters

    • _elapsedMs: number

    Returns void

render

  • render(camera, _elapsedMs, location): void

  • Render the FilledPolygon

    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 polygon. 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