User Manual

Rigid Body

The Rigid Body component enables an entity to participate in the scene's physics simulation. This allows the movement of an entity to be simulated realistically. The component interface dynamically displays different attributes based on the 'Type' attribute.

The Rigid Body component can be enabled or disabled using the toggle in the top right of the component panel. If enabled and if the component has a sibling collision component, the rigid body will participate in the physics simulation.

Static

Rigid Body component (Static)

Dynamic (and Kinematic)

Rigid Body component (Dynamic)

Kinematic

Rigid Body component (Kinematic)

Note that you must add a collision component to the same entity in order to define the shape of the rigid body. Otherwise, the rigidbody component has no effect and will not participate in the physics simulation.

Properties

PropertyDescription
TypeThe type of the body:
  • Static
  • Dynamic
  • Kinematic
MassThe mass of the body. If world units in your scene are meters, the unit for mass is kilograms.
Linear DampingSpecifies the proportion of linear velocity that is lost by the body every second.
Angular DampingSpecifies the proportion of angular velocity that is lost by the body every second.
Linear FactorMultiplier for a body's linear movement in each world axis. If set to 0 for any axis no movement will occur in this axis - useful for the creation of 2D games or 1D/2D movement.
Angular FactorMultiplier for a body's angular (rotational) movement about each world axis. If set to 0 for any axis, no rotation will occur around this axis.
FrictionControls how quickly a body loses velocity when in contact with other bodies.
RestitutionA measure of the bounciness of a body between 0 and 1. Warning: setting to 1 means a moving body will never come to a stop (unless colliding with other bodies with restitutions below 1, or unless a stop is scripted).

Scripting Interface

You can control a Rigid Body component's properties using a script component. The Rigid Body component's scripting interface is here.