summaryrefslogtreecommitdiff
path: root/doc/classes/WorldBoundaryShape2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/WorldBoundaryShape2D.xml')
-rw-r--r--doc/classes/WorldBoundaryShape2D.xml23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/classes/WorldBoundaryShape2D.xml b/doc/classes/WorldBoundaryShape2D.xml
new file mode 100644
index 0000000000..190f289601
--- /dev/null
+++ b/doc/classes/WorldBoundaryShape2D.xml
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="WorldBoundaryShape2D" inherits="Shape2D" version="4.0">
+ <brief_description>
+ World boundary shape for 2D collisions.
+ </brief_description>
+ <description>
+ World boundary shape for 2D collisions. It works like a 2D plane and will not allow any physics body to go to the negative side. Not recommended for rigid bodies, and usually not recommended for static bodies either because it forces checks against it on every frame.
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ </methods>
+ <members>
+ <member name="distance" type="float" setter="set_distance" getter="get_distance" default="0.0">
+ The line's distance from the origin.
+ </member>
+ <member name="normal" type="Vector2" setter="set_normal" getter="get_normal" default="Vector2(0, -1)">
+ The line's normal. Defaults to [code]Vector2.UP[/code].
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>