ArriveBehavior(target, deceleration, tolerance)

This steering behavior produces a force that directs an agent toward a target position. Unlike SeekBehavior, it decelerates so the agent comes to a gentle halt at the target position.

new ArriveBehavior(target, deceleration, tolerance)

Constructs a new arrive behavior.

Parameters:
Name Type Default Description
target Vector3

The target vector.

deceleration Number 3

The amount of deceleration.

tolerance Number 0

A tolerance value in world units to prevent the vehicle from overshooting its target.

Author:

Extends

Members

active :Boolean

Whether this steering behavior is active or not.

Overrides:
Default Value:
  • true

deceleration :Number

The amount of deceleration.

Default Value:
  • 3

target :Vector3

The target vector.

tolerance :Number

A tolerance value in world units to prevent the vehicle from overshooting its target.

Default Value:
  • 0

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) → {ArriveBehavior}

Restores this instance from the given JSON object.

Parameters:
Name Type Description
json Object

The JSON object.

Returns:
ArriveBehavior -

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: