FollowPathBehavior(path, nextWaypointDistance)

This steering behavior produces a force that moves a vehicle along a series of waypoints forming a path.

new FollowPathBehavior(path, nextWaypointDistance)

Constructs a new follow path behavior.

Parameters:
Name Type Default Description
path Path

The path to follow.

nextWaypointDistance Number 1

The distance the agent seeks for the next waypoint.

Author:

Extends

Members

active :Boolean

Whether this steering behavior is active or not.

Overrides:
Default Value:
  • true

nextWaypointDistance :Number

The distance the agent seeks for the next waypoint.

Default Value:
  • 1

path :Path

The path to follow.

weight :Number

Can be used to tweak the amount that a steering force contributes to the total steering force.

Overrides:
Default Value:
  • 1

Methods

calculate(vehicle, force, delta) → {Vector3}

Calculates the steering force for a single simulation step.

Parameters:
Name Type Description
vehicle Vehicle

The game entity the force is produced for.

force Vector3

The force/result vector.

delta Number

The time delta.

Returns:
Vector3 -

The force/result vector.

Overrides:

fromJSON(json) → {FollowPathBehavior}

Restores this instance from the given JSON object.

Parameters:
Name Type Description
json Object

The JSON object.

Returns:
FollowPathBehavior -

A reference to this behavior.

Overrides:

resolveReferences(entities) → {SteeringBehavior}

Restores UUIDs with references to GameEntity objects.

Parameters:
Name Type Description
entities Map.<String, GameEntity>

Maps game entities to UUIDs.

Returns:
SteeringBehavior -

A reference to this steering behavior.

Overrides:

toJSON() → {Object}

Transforms this instance into a JSON object.

Returns:
Object -

The JSON object.

Overrides: