| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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>`
- Base class for all objects affected by physics in 2D space.
- Description
- -----------
- PhysicsBody2D is an abstract base class for implementing a physics body. All \*Body2D types inherit from it.
- Tutorials
- ---------
- - :doc:`../tutorials/physics/physics_introduction`
- Properties
- ----------
- +-------------------------+----------------------------------------------------+-------------------------------+
- | :ref:`bool<class_bool>` | input_pickable | ``false`` *(parent override)* |
- +-------------------------+----------------------------------------------------+-------------------------------+
- | :ref:`int<class_int>` | :ref:`layers<class_PhysicsBody2D_property_layers>` | |
- +-------------------------+----------------------------------------------------+-------------------------------+
- Methods
- -------
- +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_collision_exception_with<class_PhysicsBody2D_method_add_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
- +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_collision_exceptions<class_PhysicsBody2D_method_get_collision_exceptions>` **(** **)** |
- +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_collision_exception_with<class_PhysicsBody2D_method_remove_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
- +---------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_PhysicsBody2D_property_layers:
- - :ref:`int<class_int>` **layers**
- Both collision_layer and collision_mask. Returns collision_layer when accessed. Updates collision_layer and collision_mask when modified.
- Method Descriptions
- -------------------
- .. _class_PhysicsBody2D_method_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_method_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_method_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.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
