PhysicsBody

Inherits: CollisionObject < Spatial < Node < Object

Inherited By: StaticBody, KinematicBody, RigidBody

Category: Core

Brief Description

Base class for all objects affected by physics in 3D space.

Member Functions

void add_collision_exception_with ( Node body )
bool get_collision_layer_bit ( int bit ) const
bool get_collision_mask_bit ( int bit ) const
void remove_collision_exception_with ( Node body )
void set_collision_layer_bit ( int bit, bool value )
void set_collision_mask_bit ( int bit, bool value )

Member Variables

  • int collision_layer - The physics layers this area is in.

Collidable objects can exist in any of 32 different layers. These layers work like a tagging system, and are not visual. A collidable can use these layers to select with which objects it can collide, using the collision_mask property.

A contact is detected if object A is in any of the layers that object B scans, or object B is in any layer scanned by object A.

  • int collision_mask - The physics layers this area can scan for collisions.

Description

PhysicsBody is an abstract base class for implementing a physics body. All *Body types inherit from it.

Member Function Description

  • void add_collision_exception_with ( Node body )

Adds a body to the list of bodies that this body can’t collide with.

  • bool get_collision_layer_bit ( int bit ) const
  • bool get_collision_mask_bit ( int bit ) const
  • void remove_collision_exception_with ( Node body )

Removes a body from the list of bodies that this body can’t collide with.

  • void set_collision_layer_bit ( int bit, bool value )
  • void set_collision_mask_bit ( int bit, bool value )