Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_worldboundaryshape3d.rst

class_worldboundaryshape3d.rst 2.8 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/WorldBoundaryShape3D.xml.
    7. 

  7. 

  8. .. _class_WorldBoundaryShape3D:
    9. 

  9. 

  10. WorldBoundaryShape3D
    11. 

  11. ====================
    12. 

  12. 

  13. **Inherits:** :ref:`Shape3D<class_Shape3D>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. World boundary (infinite plane) shape resource for 3D physics.
    16. 

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

  20. 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.
    21. 

  21. 

  22. \ **Performance:** Being a primitive collision shape, ``WorldBoundaryShape3D`` is fast to check collisions against.
    23. 

  23. 

  24. Properties
    25. 

  25. ----------
    26. 

  26. 

  27. +---------------------------+---------------------------------------------------------+-----------------------+
    28. 

  28. | :ref:`Plane<class_Plane>` | :ref:`plane<class_WorldBoundaryShape3D_property_plane>` | ``Plane(0, 1, 0, 0)`` |
    29. 

  29. +---------------------------+---------------------------------------------------------+-----------------------+
    30. 

  30. 

  31. Property Descriptions
    32. 

  32. ---------------------
    33. 

  33. 

  34. .. _class_WorldBoundaryShape3D_property_plane:
    35. 

  35. 

  36. - :ref:`Plane<class_Plane>` **plane**
    37. 

  37. 

  38. +-----------+-----------------------+
    39. 

  39. | *Default* | ``Plane(0, 1, 0, 0)`` |
    40. 

  40. +-----------+-----------------------+
    41. 

  41. | *Setter*  | set_plane(value)      |
    42. 

  42. +-----------+-----------------------+
    43. 

  43. | *Getter*  | get_plane()           |
    44. 

  44. +-----------+-----------------------+
    45. 

  45. 

  46. The :ref:`Plane<class_Plane>` used by the ``WorldBoundaryShape3D`` for collision.
    47. 

  47. 

  48. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    49. 

  49. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    50. 

  50. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    51. 

  51. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    52. 

  52. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    53. 

  53. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    54.