summaryrefslogtreecommitdiff
path: root/doc/classes/CollisionShape2D.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/CollisionShape2D.xml')
-rw-r--r--doc/classes/CollisionShape2D.xml70
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/classes/CollisionShape2D.xml b/doc/classes/CollisionShape2D.xml
new file mode 100644
index 0000000000..cefa0c1c81
--- /dev/null
+++ b/doc/classes/CollisionShape2D.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="CollisionShape2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Node that represents collision shape data in 2D space.
+ </brief_description>
+ <description>
+ Editor facility for creating and editing collision shapes in 2D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area2D] to give it a detection shape, or add it to a [PhysicsBody2D] to give create solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape.
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_shape" qualifiers="const">
+ <return type="Shape2D">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_disabled" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_one_way_collision_enabled" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="set_disabled">
+ <return type="void">
+ </return>
+ <argument index="0" name="disabled" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_one_way_collision">
+ <return type="void">
+ </return>
+ <argument index="0" name="enabled" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_shape">
+ <return type="void">
+ </return>
+ <argument index="0" name="shape" type="Shape2D">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
+ A disabled collision shape has no effect in the world.
+ </member>
+ <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled">
+ Sets whether this collision shape should only detect collision on one side (top or bottom).
+ </member>
+ <member name="shape" type="Shape2D" setter="set_shape" getter="get_shape">
+ The actual shape owned by this collision shape.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>