Physics

• Physics Material
  Entity Component

  Physics Material physics_material

  Physics material which represents a set of physical surface properties.

  Schema

  contactVelocity

  Vector3

  Default: [0,0,0]

  The velocity applied to the contact between this physics body and another body. Only applies if modifyContact is true.

  dynamicFriction

  Float

  Default: 0.5

  The friction coefficient applied between this surface and another surface if they are moving relative to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. If set to greater than staticFriction, the effective value of staticFriction will be increased to match. Resulting dynamic friction of a physics body colliding with another is determined by the average of both bodies' dynamic friction coefficient.

  isTrigger

  Boolean

  Default: false

  Whether to consider the geometry associated to this physics material as a trigger or not.

  modifyContact

  Boolean

  Default: false

  Whether to modify the contact when this physics body collides with another body.

  restitution

  Float

  Default: 0

  Restitution coefficient, or bounciness of surface. A coefficient of 0 indicates as little bounce as possible, higher values up to 1.0 result in more bounce. Should be in the range [0,1]. Resulting bounciness of a physics body colliding with another is determined by the average of both bodies' restitution.

  staticFriction

  Float

  Default: 0.5

  The friction coefficient applied between this surface and another surface if they are not moving lateral to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. Resulting static friction of a physics body colliding with another is determined by the average of both bodies' static friction coefficient.

  View in reference
  , ( *_geometry ||
  Collision Geometry Reference
  Entity Component

  Collision Geometry Reference collision_geometry_ref

  Reference to a collision geometry.

  Schema

  collisionGeometryRef

  Asset UUID

  UUID of the referenced collision geometry.

  View in reference
  ): creates a static physics body
  • isTrigger=true: creates a static trigger physics body

  • modifyContact=true : makes other physics dynamic bodies that contact this geometry be affected by the contactVelocity.

• Physics Material
  Entity Component

  Physics Material physics_material

  Physics material which represents a set of physical surface properties.

  Schema

  contactVelocity

  Vector3

  Default: [0,0,0]

  The velocity applied to the contact between this physics body and another body. Only applies if modifyContact is true.

  dynamicFriction

  Float

  Default: 0.5

  The friction coefficient applied between this surface and another surface if they are moving relative to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. If set to greater than staticFriction, the effective value of staticFriction will be increased to match. Resulting dynamic friction of a physics body colliding with another is determined by the average of both bodies' dynamic friction coefficient.

  isTrigger

  Boolean

  Default: false

  Whether to consider the geometry associated to this physics material as a trigger or not.

  modifyContact

  Boolean

  Default: false

  Whether to modify the contact when this physics body collides with another body.

  restitution

  Float

  Default: 0

  Restitution coefficient, or bounciness of surface. A coefficient of 0 indicates as little bounce as possible, higher values up to 1.0 result in more bounce. Should be in the range [0,1]. Resulting bounciness of a physics body colliding with another is determined by the average of both bodies' restitution.

  staticFriction

  Float

  Default: 0.5

  The friction coefficient applied between this surface and another surface if they are not moving lateral to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. Resulting static friction of a physics body colliding with another is determined by the average of both bodies' static friction coefficient.

  View in reference
  , (*_geometry, ||
  Collision Geometry Reference
  Entity Component

  Collision Geometry Reference collision_geometry_ref

  Reference to a collision geometry.

  Schema

  collisionGeometryRef

  Asset UUID

  UUID of the referenced collision geometry.

  View in reference
  with convex geometry),
  Rigid Body
  Entity Component

  Rigid Body rigid_body

  Rigid body parameters.

  Schema

  angularDamping

  Float

  Default: 0.05

  Angular damping coefficient. Used to slow down the rigid body's angular velocity, i.e. how much it rotates. Zero represents no damping. Must be non-negative.

  centerOfMass

  Vector3

  Default: [0,0,0]

  Center of mass. Relative to the entity's transform.

  collisionDetection

  Unsigned Byte

  Default: [0] Discrete

  [0] Discrete [1] LinearContinuous [2] AngularContinuous [3] Continuous

  The type of collision detection to use for this rigid body.

  isKinematic

  Boolean

  Default: false

  Specifies if rigid body is kinematic. Kinematic rigid bodies are not affected by forces such as gravity.

  linearDamping

  Float

  Default: 0

  Linear damping coefficient. Used to slow down the rigid body's linear velocity. Zero represents no damping. Must be non-negative.

  lockedAxis

  Unsigned Byte

  Default: 0

  [1] Linear X [2] Linear Y [4] Linear Z [8] Angular X [16] Angular Y [32] Angular Z

  Lock motion along/around the specified axis.

  mass

  Float

  Default: 1

  Mass of the rigid body. A value of 0 is interpreted as infinite mass.

  maxAngularVelocity

  Float

  Default: 100

  The maximum angular velocity permitted for this body in rad/s. Must be non-negative.

  maxLinearVelocity

  Float

  Default: 10000000000000000

  The maximum linear velocity permitted for this body in m/s. Must be non-negative.

  useGravity

  Boolean

  Default: true

  Controls whether rigid body is affected by gravity.

  View in reference
  : creates a dynamic physics body
  • isKinematic=true: creates a kinematic physics body

• Physics Material
  Entity Component

  Physics Material physics_material

  Physics material which represents a set of physical surface properties.

  Schema

  contactVelocity

  Vector3

  Default: [0,0,0]

  The velocity applied to the contact between this physics body and another body. Only applies if modifyContact is true.

  dynamicFriction

  Float

  Default: 0.5

  The friction coefficient applied between this surface and another surface if they are moving relative to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. If set to greater than staticFriction, the effective value of staticFriction will be increased to match. Resulting dynamic friction of a physics body colliding with another is determined by the average of both bodies' dynamic friction coefficient.

  isTrigger

  Boolean

  Default: false

  Whether to consider the geometry associated to this physics material as a trigger or not.

  modifyContact

  Boolean

  Default: false

  Whether to modify the contact when this physics body collides with another body.

  restitution

  Float

  Default: 0

  Restitution coefficient, or bounciness of surface. A coefficient of 0 indicates as little bounce as possible, higher values up to 1.0 result in more bounce. Should be in the range [0,1]. Resulting bounciness of a physics body colliding with another is determined by the average of both bodies' restitution.

  staticFriction

  Float

  Default: 0.5

  The friction coefficient applied between this surface and another surface if they are not moving lateral to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. Resulting static friction of a physics body colliding with another is determined by the average of both bodies' static friction coefficient.

  View in reference
  , (*_geometry ||
  Collision Geometry Reference
  Entity Component

  Collision Geometry Reference collision_geometry_ref

  Reference to a collision geometry.

  Schema

  collisionGeometryRef

  Asset UUID

  UUID of the referenced collision geometry.

  View in reference
  with convex geometry),
  Rigid Body
  Entity Component

  Rigid Body rigid_body

  Rigid body parameters.

  Schema

  angularDamping

  Float

  Default: 0.05

  Angular damping coefficient. Used to slow down the rigid body's angular velocity, i.e. how much it rotates. Zero represents no damping. Must be non-negative.

  centerOfMass

  Vector3

  Default: [0,0,0]

  Center of mass. Relative to the entity's transform.

  collisionDetection

  Unsigned Byte

  Default: [0] Discrete

  [0] Discrete [1] LinearContinuous [2] AngularContinuous [3] Continuous

  The type of collision detection to use for this rigid body.

  isKinematic

  Boolean

  Default: false

  Specifies if rigid body is kinematic. Kinematic rigid bodies are not affected by forces such as gravity.

  linearDamping

  Float

  Default: 0

  Linear damping coefficient. Used to slow down the rigid body's linear velocity. Zero represents no damping. Must be non-negative.

  lockedAxis

  Unsigned Byte

  Default: 0

  [1] Linear X [2] Linear Y [4] Linear Z [8] Angular X [16] Angular Y [32] Angular Z

  Lock motion along/around the specified axis.

  mass

  Float

  Default: 1

  Mass of the rigid body. A value of 0 is interpreted as infinite mass.

  maxAngularVelocity

  Float

  Default: 100

  The maximum angular velocity permitted for this body in rad/s. Must be non-negative.

  maxLinearVelocity

  Float

  Default: 10000000000000000

  The maximum linear velocity permitted for this body in m/s. Must be non-negative.

  useGravity

  Boolean

  Default: true

  Controls whether rigid body is affected by gravity.

  View in reference

  , rigid_body_actuator : creates a dynamic physics body that can be driven externally, and internals can be queried (e.g. angularVelocity, linearVelocity, etc)

• Joint
  Entity Component

  Joint joint

  Base component of all the other joint components (revolute_joint, etc.). By itself it will lock the orientations and distances of the constrainer and constrainee.

  Schema

  breakForce

  Float

  Default: 10

  The force that needs to be applied for this joint to break.

  breakTorque

  Float

  Default: 10

  The torque that needs to be applied for this joint to break.

  constrainee

  Entity Reference

  {linkage,originalEUID,}

  An entity that is a rigid body.

  constrainer

  Entity Reference

  {linkage,originalEUID,}

  An entity that is a rigid or static body, or simply null.

  enableCollision

  Boolean

  Default: false

  Whether to enable collision between constrainer and constrainee.

  View in reference
  : creates a breakable fixed joint

• Joint
  Entity Component

  Joint joint

  Base component of all the other joint components (revolute_joint, etc.). By itself it will lock the orientations and distances of the constrainer and constrainee.

  Schema

  breakForce

  Float

  Default: 10

  The force that needs to be applied for this joint to break.

  breakTorque

  Float

  Default: 10

  The torque that needs to be applied for this joint to break.

  constrainee

  Entity Reference

  {linkage,originalEUID,}

  An entity that is a rigid body.

  constrainer

  Entity Reference

  {linkage,originalEUID,}

  An entity that is a rigid or static body, or simply null.

  enableCollision

  Boolean

  Default: false

  Whether to enable collision between constrainer and constrainee.

  View in reference
  ,
  Constraint
  Entity Component

  Constraint constraint

  A physics constraint that can be configured along 6 degrees of freedom. In its default state it behaves as a fixed constraint - that is, it rigidly fixes the constraint frames of its two entities. However, individual degrees of freedom may be unlocked to permit any combination of rotation around the x-, y- and z- axes, and translation along these axes.

  Schema

  motionLimitSpringDamping

  Vector3

  Default: [0,0,0]

  If greater than zero, this is the damping of the limit spring.

  motionLimitSpringStiffness

  Vector3

  Default: [0,0,0]

  If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

  motionLowerLimit

  Vector3

  Default: [0,0,0]

  The lower distance of the limit.

  motionUpperLimit

  Vector3

  Default: [0,0,0]

  The upper distance of the limit.

  swingLimitAngle

  Vector2

  Default: [0,0]

  The limit angle from the Y-axis and the Z-axis of the constraint frame. The cone limit is used if either or both swing axes are limited. The extents are symmetrical and measured in the frame of the parent. If only one swing degree of freedom is limited, the corresponding value from the cone limit defines the limit range. An angle of 0° will not restrict the rotation around the axis. The maximum value for each angle is 180°.

  swingSpringDamping

  Float

  Default: 0

  If greater than zero, this is the damping of the limit spring.

  swingSpringStiffness

  Float

  Default: 0

  If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

  twistLimitAngle

  Vector2

  Default: [0,0]

  The twist limit controls the range of motion around the twist axis. The limit angle range is (-360, 360).

  twistSpringDamping

  Float

  Default: 0

  If greater than zero, this is the damping of the limit spring.

  twistSpringStiffness

  Float

  Default: 0

  If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

  unlockedMotion

  Unsigned Integer

  Default: 0

  [1] Along X [2] Along Y [4] Along Z [8] Around X [16] Around Y [32] Around Z

  Unlock motion along/around the specified axis.

  View in reference
  : creates a customizable joint (all degrees of freedom are customizable)

• Joint
  Entity Component

  Joint joint

  Base component of all the other joint components (revolute_joint, etc.). By itself it will lock the orientations and distances of the constrainer and constrainee.

  Schema

  breakForce

  Float

  Default: 10

  The force that needs to be applied for this joint to break.

  breakTorque

  Float

  Default: 10

  The torque that needs to be applied for this joint to break.

  constrainee

  Entity Reference

  {linkage,originalEUID,}

  An entity that is a rigid body.

  constrainer

  Entity Reference

  {linkage,originalEUID,}

  An entity that is a rigid or static body, or simply null.

  enableCollision

  Boolean

  Default: false

  Whether to enable collision between constrainer and constrainee.

  View in reference
  ,
  Constraint
  Entity Component

  Constraint constraint

  A physics constraint that can be configured along 6 degrees of freedom. In its default state it behaves as a fixed constraint - that is, it rigidly fixes the constraint frames of its two entities. However, individual degrees of freedom may be unlocked to permit any combination of rotation around the x-, y- and z- axes, and translation along these axes.

  Schema

  motionLimitSpringDamping

  Vector3

  Default: [0,0,0]

  If greater than zero, this is the damping of the limit spring.

  motionLimitSpringStiffness

  Vector3

  Default: [0,0,0]

  If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

  motionLowerLimit

  Vector3

  Default: [0,0,0]

  The lower distance of the limit.

  motionUpperLimit

  Vector3

  Default: [0,0,0]

  The upper distance of the limit.

  swingLimitAngle

  Vector2

  Default: [0,0]

  The limit angle from the Y-axis and the Z-axis of the constraint frame. The cone limit is used if either or both swing axes are limited. The extents are symmetrical and measured in the frame of the parent. If only one swing degree of freedom is limited, the corresponding value from the cone limit defines the limit range. An angle of 0° will not restrict the rotation around the axis. The maximum value for each angle is 180°.

  swingSpringDamping

  Float

  Default: 0

  If greater than zero, this is the damping of the limit spring.

  swingSpringStiffness

  Float

  Default: 0

  If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

  twistLimitAngle

  Vector2

  Default: [0,0]

  The twist limit controls the range of motion around the twist axis. The limit angle range is (-360, 360).

  twistSpringDamping

  Float

  Default: 0

  If greater than zero, this is the damping of the limit spring.

  twistSpringStiffness

  Float

  Default: 0

  If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

  unlockedMotion

  Unsigned Integer

  Default: 0

  [1] Along X [2] Along Y [4] Along Z [8] Around X [16] Around Y [32] Around Z

  Unlock motion along/around the specified axis.

  View in reference
  ,
  Constraint Actuator
  Entity Component

  Constraint Actuator constraint_actuator

  Schema

  angularDamping

  Vector3

  Default: [0,0,0]

  If greater than zero, this is the damping of the limit spring.

  angularForceLimit

  Vector3

  Default: [-1,-1,-1]

  The maximum impulse or force that can be exerted by the drive. -1 for no limit.

  angularStiffness

  Vector3

  Default: [0,0,0]

  If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

  angularVelocity

  Vector3

  Default: [0,0,0]

  The goal velocity for angular drive.

  goalOrientation

  Quaternion

  Default: [0,0,0,1]

  The goal orientation for angular drive.

  goalPosition

  Vector3

  Default: [0,0,0]

  The goal position for linear drive.

  linearDamping

  Vector3

  Default: [0,0,0]

  If greater than zero, this is the damping of the limit spring.

  linearForceLimit

  Vector3

  Default: [-1,-1,-1]

  The maximum impulse or force that can be exerted by the drive. -1 for no limit.

  linearStiffness

  Vector3

  Default: [0,0,0]

  If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.

  linearVelocity

  Vector3

  Default: [0,0,0]

  The goal velocity for linear drive.

  type

  Integer

  Default: [1] ACCELERATION

  [0] FORCE [1] ACCELERATION

  The drive type

  View in reference
  : creates a customizable joint that can be driven externally (by force, velocity, drive, etc)

• (

  Capsule Geometry
  Entity Component

  Capsule Geometry capsule_geometry

  Capsule geometry.

  Schema

  axis

  Integer

  Default: [1] Y-Axis

  [0] X-Axis [1] Y-Axis [2] Z-Axis

  Alignment axis. 0 for X, 1 for Y, 2 for Z.

  height

  Float

  Default: 1

  Height of the cylindrical part of the capsule.

  offset

  Vector3

  Default: [0,0,0]

  Geometry offset.

  radius

  Float

  Default: 0.5

  Radius of the spheres at each end of the capsule.

  View in reference
  ||
  Box Geometry
  Entity Component

  Box Geometry box_geometry

  Box geometry.

  Schema

  dimension

  Vector3

  Default: [1,1,1]

  Width, height and depth of the box.

  offset

  Vector3

  Default: [0,0,0]

  Geometry offset.

  View in reference
  ) &&
  Physics Material
  Entity Component

  Physics Material physics_material

  Physics material which represents a set of physical surface properties.

  Schema

  contactVelocity

  Vector3

  Default: [0,0,0]

  The velocity applied to the contact between this physics body and another body. Only applies if modifyContact is true.

  dynamicFriction

  Float

  Default: 0.5

  The friction coefficient applied between this surface and another surface if they are moving relative to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. If set to greater than staticFriction, the effective value of staticFriction will be increased to match. Resulting dynamic friction of a physics body colliding with another is determined by the average of both bodies' dynamic friction coefficient.

  isTrigger

  Boolean

  Default: false

  Whether to consider the geometry associated to this physics material as a trigger or not.

  modifyContact

  Boolean

  Default: false

  Whether to modify the contact when this physics body collides with another body.

  restitution

  Float

  Default: 0

  Restitution coefficient, or bounciness of surface. A coefficient of 0 indicates as little bounce as possible, higher values up to 1.0 result in more bounce. Should be in the range [0,1]. Resulting bounciness of a physics body colliding with another is determined by the average of both bodies' restitution.

  staticFriction

  Float

  Default: 0.5

  The friction coefficient applied between this surface and another surface if they are not moving lateral to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. Resulting static friction of a physics body colliding with another is determined by the average of both bodies' static friction coefficient.

  View in reference
  &&
  Character Controller
  Entity Component

  Character Controller character_controller

  Character controller used for movement constrained by collisions without having to deal with a rigid body. A character controller is kinematic, and so is not affected by forces. It uses its own tweaked collision algorithm to give a good feeling while controlling the character.

  Schema

  skinWidth

  Float

  Default: 0

  The character's collision skin width.

  slopeLimit

  Float

  Default: 45

  Slope limit in degrees. A slope steeper than the slopeLimit will not be walkable by the controller.

  stepOffset

  Float

  Default: 0

  Step offset. If the height of a step is greater than stepOffset, the controller cannot climb automatically and gets stuck.

  View in reference
  : creates a kinematic character controller