class_worldmarginshape.rst 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the WorldMarginShape.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_WorldMarginShape:
  6. WorldMarginShape
  7. ================
  8. **Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. Infinite plane shape for 3D collisions.
  10. Description
  11. -----------
  12. An infinite plane shape for 3D collisions. Note that the :ref:`Plane<class_Plane>`'s normal matters; anything "below" the plane will collide with it. If the ``WorldMarginShape`` is used in a :ref:`PhysicsBody<class_PhysicsBody>`, it will cause colliding objects placed "below" it to teleport "above" the plane.
  13. Properties
  14. ----------
  15. +---------------------------+-----------------------------------------------------+-------------------------+
  16. | :ref:`Plane<class_Plane>` | :ref:`plane<class_WorldMarginShape_property_plane>` | ``Plane( 0, 1, 0, 0 )`` |
  17. +---------------------------+-----------------------------------------------------+-------------------------+
  18. Property Descriptions
  19. ---------------------
  20. .. _class_WorldMarginShape_property_plane:
  21. - :ref:`Plane<class_Plane>` **plane**
  22. +-----------+-------------------------+
  23. | *Default* | ``Plane( 0, 1, 0, 0 )`` |
  24. +-----------+-------------------------+
  25. | *Setter* | set_plane(value) |
  26. +-----------+-------------------------+
  27. | *Getter* | get_plane() |
  28. +-----------+-------------------------+
  29. The :ref:`Plane<class_Plane>` used by the ``WorldMarginShape`` for collision.