Files
godot-docs/classes/class_worldmarginshape.rst
2020-03-13 17:17:50 +01:00

45 lines
1.6 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the WorldMarginShape.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_WorldMarginShape:
WorldMarginShape
================
**Inherits:** :ref:`Shape<class_Shape>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
Infinite plane shape for 3D collisions.
Description
-----------
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.
Properties
----------
+---------------------------+-----------------------------------------------------+-------------------------+
| :ref:`Plane<class_Plane>` | :ref:`plane<class_WorldMarginShape_property_plane>` | ``Plane( 0, 1, 0, 0 )`` |
+---------------------------+-----------------------------------------------------+-------------------------+
Property Descriptions
---------------------
.. _class_WorldMarginShape_property_plane:
- :ref:`Plane<class_Plane>` **plane**
+-----------+-------------------------+
| *Default* | ``Plane( 0, 1, 0, 0 )`` |
+-----------+-------------------------+
| *Setter* | set_plane(value) |
+-----------+-------------------------+
| *Getter* | get_plane() |
+-----------+-------------------------+
The :ref:`Plane<class_Plane>` used by the ``WorldMarginShape`` for collision.