class_worldboundaryshape3d.rst 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/WorldBoundaryShape3D.xml.
  6. .. _class_WorldBoundaryShape3D:
  7. WorldBoundaryShape3D
  8. ====================
  9. **Inherits:** :ref:`Shape3D<class_Shape3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. World boundary (infinite plane) shape resource for 3D physics.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. 3D world boundary shape to be added as a *direct* child of a :ref:`PhysicsBody3D<class_PhysicsBody3D>` or :ref:`Area3D<class_Area3D>` using a :ref:`CollisionShape3D<class_CollisionShape3D>` node. **WorldBoundaryShape3D** works like an infinite plane and will not allow any physics body to go to the negative side. Note that the :ref:`Plane<class_Plane>`'s normal matters; anything "below" the plane will collide with it. If the **WorldBoundaryShape3D** is used in a :ref:`PhysicsBody3D<class_PhysicsBody3D>`, it will cause colliding objects placed "below" it to teleport "above" the plane.
  15. \ **Performance:** Being a primitive collision shape, **WorldBoundaryShape3D** is fast to check collisions against.
  16. .. rst-class:: classref-reftable-group
  17. Properties
  18. ----------
  19. .. table::
  20. :widths: auto
  21. +---------------------------+---------------------------------------------------------+-----------------------+
  22. | :ref:`Plane<class_Plane>` | :ref:`plane<class_WorldBoundaryShape3D_property_plane>` | ``Plane(0, 1, 0, 0)`` |
  23. +---------------------------+---------------------------------------------------------+-----------------------+
  24. .. rst-class:: classref-section-separator
  25. ----
  26. .. rst-class:: classref-descriptions-group
  27. Property Descriptions
  28. ---------------------
  29. .. _class_WorldBoundaryShape3D_property_plane:
  30. .. rst-class:: classref-property
  31. :ref:`Plane<class_Plane>` **plane** = ``Plane(0, 1, 0, 0)``
  32. .. rst-class:: classref-property-setget
  33. - void **set_plane** **(** :ref:`Plane<class_Plane>` value **)**
  34. - :ref:`Plane<class_Plane>` **get_plane** **(** **)**
  35. The :ref:`Plane<class_Plane>` used by the **WorldBoundaryShape3D** for collision.
  36. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  37. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  38. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  39. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  40. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  41. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`