summaryrefslogtreecommitdiff
path: root/doc/classes/WorldMarginShape.xml
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2020-02-28 09:15:38 +0100
committerGitHub <noreply@github.com>2020-02-28 09:15:38 +0100
commit4f64f3401a5f3652fdd2b01483011dbe0106352b (patch)
tree96786e4a897cbfab3f73a81b14868a42f4ef5ba5 /doc/classes/WorldMarginShape.xml
parent4ff84cbfb32e4ca7f4804c5d8f4c5267eb6a3e38 (diff)
parent483994601d8c9f25185fc78e1ae60b19849b00f9 (diff)
Merge pull request #36388 from AndreaCatania/some_renames
Rename Navigation{Mesh,Polygon}Instance and PlaneShape for clarity
Diffstat (limited to 'doc/classes/WorldMarginShape.xml')
-rw-r--r--doc/classes/WorldMarginShape.xml20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/classes/WorldMarginShape.xml b/doc/classes/WorldMarginShape.xml
new file mode 100644
index 0000000000..54f76a066b
--- /dev/null
+++ b/doc/classes/WorldMarginShape.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="WorldMarginShape" inherits="Shape" version="4.0">
+ <brief_description>
+ Infinite plane shape for 3D collisions.
+ </brief_description>
+ <description>
+ An infinite plane shape for 3D collisions. Note that the [Plane]'s normal matters; anything "below" the plane will collide with it. If the [WorldMarginShape] is used in a [PhysicsBody], it will cause colliding objects placed "below" it to teleport "above" the plane.
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ </methods>
+ <members>
+ <member name="plane" type="Plane" setter="set_plane" getter="get_plane" default="Plane( 0, 1, 0, 0 )">
+ The [Plane] used by the [WorldMarginShape] for collision.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>