Extends

• SteeringBehavior

Members

active :Boolean

steering/SteeringBehavior.js, line 21

Whether this steering behavior is active or not.

Overrides:

• SteeringBehavior#active

Default Value:

• true

path :Path

steering/behaviors/OnPathBehavior.js, line 37

The path to stay close to.

predictionFactor :Number

steering/behaviors/OnPathBehavior.js, line 51

Determines how far the behavior predicts the movement of the vehicle.

Default Value:

• 1

radius :Number

steering/behaviors/OnPathBehavior.js, line 44

Defines the width of the path. With a smaller radius, the vehicle will have to follow the path more closely.

Default Value:

• 0.1

weight :Number

steering/SteeringBehavior.js, line 28

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

Overrides:

• SteeringBehavior#weight

Default Value:

• 1

Methods

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

steering/behaviors/OnPathBehavior.js, line 67

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:

• SteeringBehavior#calculate

fromJSON(json) → {OnPathBehavior}

steering/behaviors/OnPathBehavior.js, line 155

Restores this instance from the given JSON object.

Parameters:

Name	Type	Description
json	Object	The JSON object.

Returns:

OnPathBehavior -

A reference to this behavior.

Overrides:

• SteeringBehavior#fromJSON

resolveReferences(entities) → {SteeringBehavior}

steering/SteeringBehavior.js, line 78

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:

• SteeringBehavior#resolveReferences

toJSON() → {Object}

steering/behaviors/OnPathBehavior.js, line 137

Transforms this instance into a JSON object.

Returns:

Object -

The JSON object.

Overrides:

• SteeringBehavior#toJSON