pandemonium_engine_docs/classes/class_physicsbody.rst

68 lines
3.1 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/PhysicsBody.xml.
.. _class_PhysicsBody:
PhysicsBody
===========
**Inherits:** :ref:`CollisionObject<class_CollisionObject>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`KinematicBody<class_KinematicBody>`, :ref:`PhysicalBone<class_PhysicalBone>`, :ref:`RigidBody<class_RigidBody>`, :ref:`StaticBody<class_StaticBody>`
Base class for all objects affected by physics in 3D space.
Description
-----------
PhysicsBody is an abstract base class for implementing a physics body. All \*Body types inherit from it.
Tutorials
---------
- :doc:`../tutorials/physics/physics_introduction`
Methods
-------
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`add_collision_exception_with<class_PhysicsBody_method_add_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Array<class_Array>` | :ref:`get_collision_exceptions<class_PhysicsBody_method_get_collision_exceptions>` **(** **)** |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove_collision_exception_with<class_PhysicsBody_method_remove_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
.. _class_PhysicsBody_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_PhysicsBody_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_PhysicsBody_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.)`