S2ENGINE HD  1.4.6
Official manual about S2Engine HD editor and programming
Rigid Body

Base Class: Entity

RigidBody.jpg

Overview

This object is a special kind of entity that represents a physical body. Every physical body as one or more collision shapes.
The basic shape is defined directly by setting the SceneObject basic params:

  • dims (vector3) used to define the extension of the collision shape.
  • offset (vector3) used to define the position of the collision shape respect the origin of the object.
  • coltype (enum) used to set the type of shape (box, cylinder, sphere,...).

The aditional shapes can be defined using a tool inside the editor.

See also
PrefabsInspector or ClassInspector

RigidBodies also has other params that are common to some other entities:

  • mass (float) mass of the body.
  • elasticity (float) restitution force, acting on the opposite direction of the body movement when it collides something.
  • staticFriction (float) static friction force, acting when object doesn't move.
  • dynamicFriction (float) dynamic friction force, acting when object moves.

For more informations about Physics objects see Physics and PrefabsInspector.

Parameters
ContactSound(sound filename) filename of the sound played by the body when collide something.
Kinematic(boolean) true if the body is kinematic. See Physics for more info.
SplashObject(Object list) name of the object, generally a particle system, simulating the water splash.
RipplesObject(Object list) name of the object ,generally a DecalObject, simulating the water ripples.

Receiving Messages

Name Description Content parameters
EnterWater Body receives this message for physics system when enter the water plane. When receives this message the vehicle activates the \b SplashObject and the \b RipplesObject. message#0: length of the entering velocity.
ContactNotify Body receives this message for physics system when collide something. When receives this message the body play the contact sound message#1: length of the force received during collision, it is used by the body to set the volume of the contact sound to play.

Sending Messages

none

See also
Messages