PhysicsBody2D

    Inherited By: , RigidBody2D,

    Category: Core

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

    Properties

    Description

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

    Property Descriptions

    • collision_layer

    The physics layers this area is in.

    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.

    Default value: 1 (the first layer/bit is enabled).

    • int collision_mask

    The physics layers this area scans for collisions.

    Default value: 1 (the first layer/bit is enabled).

    • layers

    Both collision_layer and . Returns collision_layer when accessed. Updates and collision_mask when modified.

    • get_collision_exceptions ( )

    Returns an array of nodes that were added as collision exceptions for this body.

    • bool get_collision_layer_bit ( bit ) const

    Returns an individual bit on the collision_layer.

    • get_collision_mask_bit ( int bit ) const

    Returns an individual bit on the .

    • 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 ( bit, bool value )

    Sets individual bits on the bitmask. Use this if you only need to change one layer’s value.