class_physicsbody.rst 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the PhysicsBody.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_PhysicsBody:
  6. PhysicsBody
  7. ===========
  8. **Inherits:** :ref:`CollisionObject<class_CollisionObject>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`KinematicBody<class_KinematicBody>`, :ref:`PhysicalBone<class_PhysicalBone>`, :ref:`RigidBody<class_RigidBody>`, :ref:`StaticBody<class_StaticBody>`
  10. Base class for all objects affected by physics in 3D space.
  11. Description
  12. -----------
  13. PhysicsBody is an abstract base class for implementing a physics body. All \*Body types inherit from it.
  14. Tutorials
  15. ---------
  16. - :doc:`../tutorials/physics/physics_introduction`
  17. Methods
  18. -------
  19. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`add_collision_exception_with<class_PhysicsBody_method_add_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
  21. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`Array<class_Array>` | :ref:`get_collision_exceptions<class_PhysicsBody_method_get_collision_exceptions>` **(** **)** |
  23. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  24. | void | :ref:`remove_collision_exception_with<class_PhysicsBody_method_remove_collision_exception_with>` **(** :ref:`Node<class_Node>` body **)** |
  25. +---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+
  26. Method Descriptions
  27. -------------------
  28. .. _class_PhysicsBody_method_add_collision_exception_with:
  29. - void **add_collision_exception_with** **(** :ref:`Node<class_Node>` body **)**
  30. Adds a body to the list of bodies that this body can't collide with.
  31. ----
  32. .. _class_PhysicsBody_method_get_collision_exceptions:
  33. - :ref:`Array<class_Array>` **get_collision_exceptions** **(** **)**
  34. Returns an array of nodes that were added as collision exceptions for this body.
  35. ----
  36. .. _class_PhysicsBody_method_remove_collision_exception_with:
  37. - void **remove_collision_exception_with** **(** :ref:`Node<class_Node>` body **)**
  38. Removes a body from the list of bodies that this body can't collide with.
  39. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  40. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  41. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`