| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the PhysicsBody2D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_PhysicsBody2D:
- PhysicsBody2D
- =============
- **Inherits:** :ref:`CollisionObject2D<class_CollisionObject2D>` **<** :ref:`Node2D<class_Node2D>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- **Inherited By:** :ref:`KinematicBody2D<class_KinematicBody2D>`, :ref:`RigidBody2D<class_RigidBody2D>`, :ref:`StaticBody2D<class_StaticBody2D>`
- **Category:** Core
- Brief Description
- -----------------
- Base class for all objects affected by physics in 2D space.
- Properties
- ----------
- +-----------------------+-------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`collision_layer<class_PhysicsBody2D_collision_layer>` |
- +-----------------------+-------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`collision_mask<class_PhysicsBody2D_collision_mask>` |
- +-----------------------+-------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`layers<class_PhysicsBody2D_layers>` |
- +-----------------------+-------------------------------------------------------------+
- Methods
- -------
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_collision_exception_with<class_PhysicsBody2D_add_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_collision_exceptions<class_PhysicsBody2D_get_collision_exceptions>` **(** **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_collision_layer_bit<class_PhysicsBody2D_get_collision_layer_bit>` **(** :ref:`int<class_int>` bit **)** const |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_collision_mask_bit<class_PhysicsBody2D_get_collision_mask_bit>` **(** :ref:`int<class_int>` bit **)** const |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_collision_exception_with<class_PhysicsBody2D_remove_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_collision_layer_bit<class_PhysicsBody2D_set_collision_layer_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_collision_mask_bit<class_PhysicsBody2D_set_collision_mask_bit>` **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)** |
- +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
- Description
- -----------
- PhysicsBody2D is an abstract base class for implementing a physics body. All \*Body2D types inherit from it.
- Tutorials
- ---------
- - :doc:`../tutorials/physics/physics_introduction`
- Property Descriptions
- ---------------------
- .. _class_PhysicsBody2D_collision_layer:
- - :ref:`int<class_int>` **collision_layer**
- +----------+----------------------------+
- | *Setter* | set_collision_layer(value) |
- +----------+----------------------------+
- | *Getter* | get_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.
- .. _class_PhysicsBody2D_collision_mask:
- - :ref:`int<class_int>` **collision_mask**
- +----------+---------------------------+
- | *Setter* | set_collision_mask(value) |
- +----------+---------------------------+
- | *Getter* | get_collision_mask() |
- +----------+---------------------------+
- The physics layers this area scans for collisions.
- .. _class_PhysicsBody2D_layers:
- - :ref:`int<class_int>` **layers**
- Both :ref:`collision_layer<class_PhysicsBody2D_collision_layer>` and :ref:`collision_mask<class_PhysicsBody2D_collision_mask>`. Returns :ref:`collision_layer<class_PhysicsBody2D_collision_layer>` when accessed. Updates :ref:`collision_layer<class_PhysicsBody2D_collision_layer>` and :ref:`collision_mask<class_PhysicsBody2D_collision_mask>` when modified.
- Method Descriptions
- -------------------
- .. _class_PhysicsBody2D_add_collision_exception_with:
- - void **add_collision_exception_with** **(** :ref:`Node<class_Node>` body **)**
- Adds a body to the list of bodies that this body can't collide with.
- .. _class_PhysicsBody2D_get_collision_exceptions:
- - :ref:`Array<class_Array>` **get_collision_exceptions** **(** **)**
- Returns an array of nodes that were added as collision exceptions for this body.
- .. _class_PhysicsBody2D_get_collision_layer_bit:
- - :ref:`bool<class_bool>` **get_collision_layer_bit** **(** :ref:`int<class_int>` bit **)** const
- Returns an individual bit on the collision mask.
- .. _class_PhysicsBody2D_get_collision_mask_bit:
- - :ref:`bool<class_bool>` **get_collision_mask_bit** **(** :ref:`int<class_int>` bit **)** const
- Returns an individual bit on the collision mask.
- .. _class_PhysicsBody2D_remove_collision_exception_with:
- - void **remove_collision_exception_with** **(** :ref:`Node<class_Node>` body **)**
- Removes a body from the list of bodies that this body can't collide with.
- .. _class_PhysicsBody2D_set_collision_layer_bit:
- - void **set_collision_layer_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
- Sets individual bits on the layer mask. Use this if you only need to change one layer's value.
- .. _class_PhysicsBody2D_set_collision_mask_bit:
- - void **set_collision_mask_bit** **(** :ref:`int<class_int>` bit, :ref:`bool<class_bool>` value **)**
- Sets individual bits on the collision mask. Use this if you only need to change one layer's value.
|
