API Reference

Class List

CollisionComponent

Extends: Component

A collision volume. Use this in conjunction with a RigidBodyComponent to make a collision volume that can be simulated using the physics engine.

If the Entity does not have a RigidBodyComponent then this collision volume will act as a trigger volume. When an entity with a dynamic or kinematic body enters or leaves an entity with a trigger volume, both entities will receive trigger events.

The following table shows all the events that can be fired between two Entities:

Rigid Body (Static) Rigid Body (Dynamic or Kinematic) Trigger Volume
Rigid Body (Static)
  • contact
  • collisionstart
  • collisionend
Rigid Body (Dynamic or Kinematic)
  • contact
  • collisionstart
  • collisionend
  • contact
  • collisionstart
  • collisionend
  • triggerenter
  • triggerleave
Trigger Volume
  • triggerenter
  • triggerleave

Summary

Properties

asset

The asset for the model of the mesh collision volume - can also be an asset id.

axis

The local space axis with which the capsule, cylinder or cone-shaped collision volume's length is aligned.

halfExtents

The half-extents of the box-shaped collision volume in the x, y and z axes.

height

The total height of the capsule, cylinder or cone-shaped collision volume from tip to tip.

model

The model that is added to the scene graph for the mesh collision volume.

radius

The radius of the sphere, capsule, cylinder or cone-shaped collision volumes.

renderAsset

The render asset of the mesh collision volume - can also be an asset id.

type

The type of the collision volume.

Events

collisionend

The 'collisionend' event is fired two rigid-bodies stop touching.

collisionstart

The 'collisionstart' event is fired when two rigid bodies start touching.

contact

The 'contact' event is fired when a contact occurs between two rigid bodies.

triggerenter

The 'triggerenter' event is fired when a rigid body enters a trigger volume.

triggerleave

The 'triggerleave' event is fired when a rigid body exits a trigger volume.

Inherited

Properties

system

The ComponentSystem used to create this Component.

entity

The Entity that this Component is attached to.

enabled

Enables or disables the component.

Details

Constructor

CollisionComponent(system, entity)

Create a new CollisionComponent.

Parameters

systemCollisionComponentSystem

The ComponentSystem that created this Component.

entityEntity

The Entity that this Component is attached to.

Properties

Asset, numberasset

The asset for the model of the mesh collision volume - can also be an asset id. Defaults to null.

numberaxis

The local space axis with which the capsule, cylinder or cone-shaped collision volume's length is aligned. 0 for X, 1 for Y and 2 for Z. Defaults to 1 (Y-axis).

Vec3halfExtents

The half-extents of the box-shaped collision volume in the x, y and z axes. Defaults to [0.5, 0.5, 0.5].

numberheight

The total height of the capsule, cylinder or cone-shaped collision volume from tip to tip. Defaults to 2.

Modelmodel

The model that is added to the scene graph for the mesh collision volume.

numberradius

The radius of the sphere, capsule, cylinder or cone-shaped collision volumes. Defaults to 0.5.

Asset, numberrenderAsset

The render asset of the mesh collision volume - can also be an asset id. Defaults to null. If not set then the asset property will be checked instead.

stringtype

The type of the collision volume. Can be:

  • "box": A box-shaped collision volume.
  • "capsule": A capsule-shaped collision volume.
  • "compound": A compound shape. Any descendant entities with a collision component of type box, capsule, cone, cylinder or sphere will be combined into a single, rigid shape.
  • "cone": A cone-shaped collision volume.
  • "cylinder": A cylinder-shaped collision volume.
  • "mesh": A collision volume that uses a model asset as its shape.
  • "sphere": A sphere-shaped collision volume.

Defaults to "box".

Events

collisionend

The 'collisionend' event is fired two rigid-bodies stop touching.

Parameters

otherEntity

The Entity that stopped touching this collision volume.

collisionstart

The 'collisionstart' event is fired when two rigid bodies start touching.

Parameters

resultContactResult

Details of the contact between the two Entities.

contact

The 'contact' event is fired when a contact occurs between two rigid bodies.

Parameters

resultContactResult

Details of the contact between the two rigid bodies.

triggerenter

The 'triggerenter' event is fired when a rigid body enters a trigger volume. a RigidBodyComponent attached.

Parameters

otherEntity

The Entity that entered this collision volume.

triggerleave

The 'triggerleave' event is fired when a rigid body exits a trigger volume. a RigidBodyComponent attached.

Parameters

otherEntity

The Entity that exited this collision volume.

Inherited

Properties

ComponentSystemsystem

The ComponentSystem used to create this Component.

Entityentity

The Entity that this Component is attached to.

booleanenabled

Enables or disables the component.