Struct PhysicsBody2D
Base class for all objects affected by physics in 2D space.
struct PhysicsBody2D
;
PhysicsBody2D is an abstract base class for implementing a physics body. All *Body2D types inherit from it.
Properties
| Name | Type | Description |
|---|---|---|
collisionLayer[get, set]
|
long | 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 collisionMask 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.
|
collisionMask[get, set]
|
long | The physics layers this area scans for collisions. |
layers[get, set]
|
long | Both collisionLayer and collisionMask. Returns collisionLayer when accessed. Updates collisionLayer and collisionMask when modified.
|
Methods
| Name | Description |
|---|---|
_getLayers
|
|
_setLayers
|
|
addCollisionExceptionWith
|
Adds a body to the list of bodies that this body can't collide with. |
getCollisionExceptions
|
Returns an array of nodes that were added as collision exceptions for this body. |
getCollisionLayer
|
|
getCollisionLayerBit
|
Returns an individual bit on the collisionLayer.
|
getCollisionMask
|
|
getCollisionMaskBit
|
Returns an individual bit on the collisionMask.
|
removeCollisionExceptionWith
|
Removes a body from the list of bodies that this body can't collide with. |
setCollisionLayer
|
|
setCollisionLayerBit
|
Sets individual bits on the collisionLayer bitmask. Use this if you only need to change one layer's value.
|
setCollisionMask
|
|
setCollisionMaskBit
|
Sets individual bits on the collisionMask bitmask. Use this if you only need to change one layer's value.
|