Vehicle()

This type of game entity implements a special type of locomotion, the so called Vehicle Model. The class uses basic physical metrics in order to implement a realistic movement.

new Vehicle()
steering/Vehicle.js, line 26

Constructs a new vehicle.

Author:

Extends

Members

active :Boolean
core/GameEntity.js, line 35

Whether this game entity is active or not.

Overrides:
Default Value:
  • true

boundingRadius :Number
core/GameEntity.js, line 110

The bounding radius of this game entity in world units.

Overrides:
Default Value:
  • 0

canActivateTrigger :Boolean
core/GameEntity.js, line 125

Whether the entity can activate a trigger or not.

Overrides:
Default Value:
  • true

children :Array.<GameEntity>
core/GameEntity.js, line 41

The child entities of this game entity.

Overrides:

forward :Vector3
core/GameEntity.js, line 96

The default forward vector of this game entity.

Overrides:
Default Value:
  • (0,0,1)

readonly manager :EntityManager
core/GameEntity.js, line 134

A reference to the entity manager of this game entity. Automatically set when added to an EntityManager.

Overrides:
Default Value:
  • null

mass :Number
steering/Vehicle.js, line 35

The mass of the vehicle in kilogram.

Default Value:
  • 1

maxForce :Number
steering/Vehicle.js, line 42

The maximum force this entity can produce to power itself.

Default Value:
  • 100

maxSpeed :Number
core/MovingEntity.js, line 33

The maximum speed at which this game entity may travel.

Overrides:
Default Value:
  • 1

maxTurnRate :Number
core/GameEntity.js, line 118

The maximum turn rate of this game entity in radians per seconds. The only method that uses this property right now is GameEntity#rotateTo.

Overrides:
Default Value:
  • π

name :String
core/GameEntity.js, line 28

The name of this game entity.

Overrides:

neighborhoodRadius :Number
core/GameEntity.js, line 64

Game entities within this radius are considered as neighbors of this entity.

Overrides:
Default Value:
  • 1

readonly neighbors :Array.<GameEntity>
core/GameEntity.js, line 57

A list of neighbors of this game entity.

Overrides:

readonly, nullable parent :GameEntity
core/GameEntity.js, line 50

A reference to the parent entity of this game entity. Automatically set when added to a GameEntity.

Overrides:
Default Value:
  • null

position :Vector3
core/GameEntity.js, line 77

The position of this game entity.

Overrides:

rotation :Quaternion
core/GameEntity.js, line 83

The rotation of this game entity.

Overrides:

scale :Vector3
core/GameEntity.js, line 89

The scaling of this game entity.

Overrides:

nullable smoother :Smoother
steering/Vehicle.js, line 55

An optional smoother to avoid shakiness due to conflicting steering behaviors.

Default Value:
  • null

steering :SteeringManager
steering/Vehicle.js, line 48

The steering manager of this vehicle.

up :Vector3
core/GameEntity.js, line 103

The default up vector of this game entity.

Overrides:
Default Value:
  • (0,1,0)

updateNeighborhood :Boolean
core/GameEntity.js, line 71

Whether the neighborhood of this game entity is updated or not.

Overrides:
Default Value:
  • false

updateOrientation :Boolean
core/MovingEntity.js, line 40

Whether the orientation of this game entity will be updated based on the velocity or not.

Overrides:
Default Value:
  • true

readonly uuid :String
core/GameEntity.js, line 191

Unique ID, primarily used in context of serialization/deserialization.

Overrides:

velocity :Vector3
core/MovingEntity.js, line 26

The velocity of this game entity.

Overrides:

readonly worldMatrix :Matrix4
core/GameEntity.js, line 178

A transformation matrix representing the world space of this game entity.

Overrides:

Methods

add(entity) → {GameEntity}
core/GameEntity.js, line 234

Adds a game entity as a child to this game entity.

Parameters:
Name Type Description
entity GameEntity

The game entity to add.
Returns:
GameEntity -

A reference to this game entity.

Overrides:

fromJSON(json) → {Vehicle}
steering/Vehicle.js, line 151

Restores this instance from the given JSON object.

Parameters:
Name Type Description
json Object

The JSON object.
Returns:
Vehicle -

A reference to this vehicle.

Overrides:

getDirection(result) → {Vector3}
core/GameEntity.js, line 273

Computes the current direction (forward) vector of this game entity and stores the result in the given vector.

Parameters:
Name Type Description
result Vector3

The direction vector of this game entity.
Returns:
Vector3 -

The direction vector of this game entity.

Overrides:

getSpeed() → {Number}
core/MovingEntity.js, line 90

Returns the current speed of this game entity.

Returns:
Number -

The current speed.

Overrides:

getSpeedSquared() → {Number}
core/MovingEntity.js, line 101

Returns the current speed in squared space of this game entity.

Returns:
Number -

The current speed in squared space.

Overrides:

getWorldDirection(result) → {Vector3}
core/GameEntity.js, line 358

Computes the current direction (forward) vector of this game entity in world space and stores the result in the given vector.

Parameters:
Name Type Description
result Vector3

The direction vector of this game entity in world space.
Returns:
Vector3 -

The direction vector of this game entity in world space.

Overrides:

getWorldPosition(result) → {Vector3}
core/GameEntity.js, line 373

Computes the current position of this game entity in world space and stores the result in the given vector.

Parameters:
Name Type Description
result Vector3

The position of this game entity in world space.
Returns:
Vector3 -

The position of this game entity in world space.

Overrides:

handleMessage(telegram) → {Boolean}
core/GameEntity.js, line 401

Holds the implementation for the message handling of this game entity.

Parameters:
Name Type Description
telegram Telegram

The telegram with the message data.
Returns:
Boolean -

Whether the message was processed or not.

Overrides:

lineOfSightTest(ray, intersectionPoint) → {Vector3}
core/GameEntity.js, line 417

Holds the implementation for the line of sight test of this game entity. This method is used by Vision#visible in order to determine whether this game entity blocks the given line of sight or not. Implement this method when your game entity acts as an obstacle.

Parameters:
Name Type Description
ray Ray

The ray that represents the line of sight.
intersectionPoint Vector3

The intersection point.
Returns:
Vector3 -

The intersection point.

Overrides:

lookAt(target) → {GameEntity}
core/GameEntity.js, line 285

Directly rotates the entity so it faces the given target position.

Parameters:
Name Type Description
target Vector3

The target position.
Returns:
GameEntity -

A reference to this game entity.

Overrides:

remove(entity) → {GameEntity}
core/GameEntity.js, line 255

Removes a game entity as a child from this game entity.

Parameters:
Name Type Description
entity GameEntity

The game entity to remove.
Returns:
GameEntity -

A reference to this game entity.

Overrides:

resolveReferences(entities) → {Vehicle}
steering/Vehicle.js, line 170

Restores UUIDs with references to GameEntity objects.

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

Maps game entities to UUIDs.
Returns:
Vehicle -

A reference to this vehicle.

Overrides:

rotateTo(target, delta, tolerance) → {Boolean}
core/GameEntity.js, line 323

Given a target position, this method rotates the entity by an amount not greater than GameEntity#maxTurnRate until it directly faces the target.

Parameters:
Name Type Default Description
target Vector3

The target position.
delta Number

The time delta.
tolerance Number 0.0001

A tolerance value in radians to tweak the result when a game entity is considered to face a target.
Returns:
Boolean -

Whether the entity is faced to the target or not.

Overrides:

sendMessage(receiver, message, delay, data) → {GameEntity}
core/GameEntity.js, line 432

Sends a message with the given data to the specified receiver.

Parameters:
Name Type Default Description
receiver GameEntity

The receiver.
message String

The actual message.
delay Number 0

A time value in millisecond used to delay the message dispatching.
data Object null

An object for custom data.
Returns:
GameEntity -

A reference to this game entity.

Overrides:

setRenderComponent(renderComponent, callback) → {GameEntity}
core/GameEntity.js, line 386

Sets a renderable component of a 3D engine with a sync callback for this game entity.

Parameters:
Name Type Description
renderComponent Object

A renderable component of a 3D engine.
callback function

A callback that can be used to sync this game entity with the renderable component.
Returns:
GameEntity -

A reference to this game entity.

Overrides:

start() → {GameEntity}
core/GameEntity.js, line 208

Executed when this game entity is updated for the first time by its EntityManager.

Returns:
GameEntity -

A reference to this game entity.

Overrides:

toJSON() → {Object}
steering/Vehicle.js, line 132

Transforms this instance into a JSON object.

Returns:
Object -

The JSON object.

Overrides:

update(delta) → {Vehicle}
steering/Vehicle.js, line 66

This method is responsible for updating the position based on the force produced by the internal steering manager.

Parameters:
Name Type Description
delta Number

The time delta.
Returns:
Vehicle -

A reference to this vehicle.

Overrides: