Interface PathFollower

path

rotateToPath

isFollowing

• isFollowing(): boolean

  Is this PathFollower actively following a Path or not?

  To be considered as isFollowing it must be currently moving on a Path, and not paused.

  Returns boolean

pathUpdate

• pathUpdate(): void

  Internal update handler that advances this PathFollower along the path.

  Called automatically by the Scene step, should not typically be called directly.

  Returns void

pauseFollow

• pauseFollow(): this

  Pauses this PathFollower. It will still continue to render, but it will remain motionless at the point on the Path at which you paused it.

  Returns this

resumeFollow

• resumeFollow(): this

  Resumes a previously paused PathFollower.

  If the PathFollower was not paused this has no effect.

  Returns this

setPath

• setPath(
      path: Path,
      config?: number | PathConfig | NumberTweenBuilderConfig,
  ): this

  Set the Path that this PathFollower should follow.

  Optionally accepts Phaser.Types.GameObjects.PathFollower.PathConfig settings.

  Parameters

  • path: Path

    The Path this PathFollower is following. It can only follow one Path at a time.
  • Optionalconfig: number | PathConfig | NumberTweenBuilderConfig

    Settings for the PathFollower.

  Returns this

setRotateToPath

• setRotateToPath(value: boolean, offset?: number): this

  Set whether the PathFollower should automatically rotate to point in the direction of the Path.

  Parameters

  • value: boolean

    Whether the PathFollower should automatically rotate to point in the direction of the Path.
  • Optionaloffset: number

    Rotation offset in degrees. Default 0.

  Returns this

startFollow

• startFollow(
      config?: number | PathConfig | NumberTweenBuilderConfig,
      startAt?: number,
  ): this

  Starts this PathFollower following its given Path.

  Parameters

  • Optionalconfig: number | PathConfig | NumberTweenBuilderConfig

    The duration of the follow, or a PathFollower config object. Default {}.
  • OptionalstartAt: number

    Optional start position of the follow, between 0 and 1. Default 0.

  Returns this

stopFollow

• stopFollow(): this

  Stops this PathFollower from following the path any longer.

  This will invoke any 'stop' conditions that may exist on the Path, or for the follower.

  Returns this