Class PathMovement

A rule for moving along a fixed path

Constructors

constructor

Accessors

rigidBody

Methods

prerender resetPath skip_to

Constructors

constructor

  • new PathMovement(path, velocity, loop, waypointCallback?): PathMovement

  • Create a policy for moving an actor along a fixed path

    Parameters

    • path: Path

      The path on which to move

    • velocity: number

      The speed at which the actor should move

    • loop: boolean

      Should the path repeat infinitely, or just run once?

    • Optional waypointCallback: ((which) => void)

      Code to run each time a waypoint of the path is reached. It will be given the index of the next waypoint.

        • (which): void

        • Parameters

          • which: number

          Returns void

    Returns PathMovement

Accessors

rigidBody

  • get rigidBody(): undefined | RigidBodyComponent

  • Returns undefined | RigidBodyComponent

  • set rigidBody(body): void

  • The Actor to which this movement is attached

    Parameters

    Returns void

Methods

prerender

  • prerender(_elapsedMs, _camera): void

  • Figure out where we need to go next when driving a path

    Parameters

    Returns void

resetPath

  • resetPath(path, velocity, loop): void

  • Assign a new path to an Actor

    Parameters

    • path: Path

      The new path to follow

    • velocity: number

      The velocity while traveling the path

    • loop: boolean

      Should it loop?

    Returns void

skip_to

  • skip_to(waypoint): void

  • Skip forward to one of the waypoints of the path. Fails silently if the given waypoint is out of bounds for the current path length.

    Parameters

    • waypoint: number

      The waypoint to skip to.

    Returns void

Settings

Member Visibility

Theme

On This Page