class_physicsbody.rst 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_PhysicsBody:
  4. PhysicsBody
  5. ===========
  6. **Inherits:** :ref:`CollisionObject<class_collisionobject>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Inherited By:** :ref:`VehicleBody<class_vehiclebody>`, :ref:`KinematicBody<class_kinematicbody>`, :ref:`StaticBody<class_staticbody>`, :ref:`RigidBody<class_rigidbody>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Base class for different types of Physics bodies.
  12. Member Functions
  13. ----------------
  14. +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`set_layer_mask<class_PhysicsBody_set_layer_mask>` **(** :ref:`int<class_int>` mask **)** |
  16. +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_layer_mask<class_PhysicsBody_get_layer_mask>` **(** **)** const |
  18. +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | void | :ref:`add_collision_exception_with<class_PhysicsBody_add_collision_exception_with>` **(** :ref:`PhysicsBody<class_physicsbody>` body **)** |
  20. +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`remove_collision_exception_with<class_PhysicsBody_remove_collision_exception_with>` **(** :ref:`PhysicsBody<class_physicsbody>` body **)** |
  22. +------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
  23. Description
  24. -----------
  25. PhysicsBody is an abstract base class for implementing a physics body. All PhysicsBody types inherit from it.
  26. Member Function Description
  27. ---------------------------
  28. .. _class_PhysicsBody_set_layer_mask:
  29. - void **set_layer_mask** **(** :ref:`int<class_int>` mask **)**
  30. .. _class_PhysicsBody_get_layer_mask:
  31. - :ref:`int<class_int>` **get_layer_mask** **(** **)** const
  32. .. _class_PhysicsBody_add_collision_exception_with:
  33. - void **add_collision_exception_with** **(** :ref:`PhysicsBody<class_physicsbody>` body **)**
  34. .. _class_PhysicsBody_remove_collision_exception_with:
  35. - void **remove_collision_exception_with** **(** :ref:`PhysicsBody<class_physicsbody>` body **)**