mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
48 lines
1.9 KiB
ReStructuredText
48 lines
1.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the PlaneShape.xml source instead.
|
|
.. The source is found in doc/classes or modules/<name>/doc_classes.
|
|
|
|
.. _class_PlaneShape:
|
|
|
|
PlaneShape
|
|
==========
|
|
|
|
**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 ``PlaneShape`` 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_PlaneShape_property_plane>` | ``Plane( 0, 1, 0, 0 )`` |
|
|
+---------------------------+-----------------------------------------------+-------------------------+
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_PlaneShape_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 ``PlaneShape`` for collision.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|