aboutsummaryrefslogtreecommitdiff
path: root/doc/classes/CollisionPolygon2D.xml
diff options
context:
space:
mode:
authorJuan Linietsky2017-09-12 17:42:36 -0300
committerJuan Linietsky2017-09-12 17:45:41 -0300
commit4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch)
tree730471182cae00f2e47c7430db441d057383d29b /doc/classes/CollisionPolygon2D.xml
parent175777596ec3521731665dd750fd7087793b10fc (diff)
downloadgodot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.gz
godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.tar.zst
godot-4f929a0fdfae24b1ca5acf0b732219119090ee43.zip
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/CollisionPolygon2D.xml')
-rw-r--r--doc/classes/CollisionPolygon2D.xml88
1 files changed, 88 insertions, 0 deletions
diff --git a/doc/classes/CollisionPolygon2D.xml b/doc/classes/CollisionPolygon2D.xml
new file mode 100644
index 000000000..6b86d205b
--- /dev/null
+++ b/doc/classes/CollisionPolygon2D.xml
@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="CollisionPolygon2D" inherits="Node2D" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Editor-only class for easy editing of collision polygons.
+ </brief_description>
+ <description>
+ Editor-only class. This is not present when running the game. It's used in the editor to properly edit and position collision shapes in [CollisionObject2D]. This is not accessible from regular code. This class is for editing custom shape polygons.
+ </description>
+ <tutorials>
+ </tutorials>
+ <demos>
+ </demos>
+ <methods>
+ <method name="get_build_mode" qualifiers="const">
+ <return type="int" enum="CollisionPolygon2D.BuildMode">
+ </return>
+ <description>
+ Return whether the polygon is a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
+ </description>
+ </method>
+ <method name="get_polygon" qualifiers="const">
+ <return type="PoolVector2Array">
+ </return>
+ <description>
+ Return the list of points that define the polygon.
+ </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_build_mode">
+ <return type="void">
+ </return>
+ <argument index="0" name="build_mode" type="int" enum="CollisionPolygon2D.BuildMode">
+ </argument>
+ <description>
+ Set whether the polygon is to be a [ConvexPolygonShape2D] ([code]build_mode==0[/code]), or a [ConcavePolygonShape2D] ([code]build_mode==1[/code]).
+ </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_polygon">
+ <return type="void">
+ </return>
+ <argument index="0" name="polygon" type="PoolVector2Array">
+ </argument>
+ <description>
+ Set the array of points forming the polygon.
+ When editing the point list via the editor, depending on [method get_build_mode], it has to be a list of points (for [code]build_mode==0[/code]), or a list of lines (for [code]build_mode==1[/code]). In the second case, the even elements of the array define the start point of the line, and the odd elements the end point.
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="build_mode" type="int" setter="set_build_mode" getter="get_build_mode" brief="" enum="CollisionPolygon2D.BuildMode">
+ </member>
+ <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" brief="">
+ </member>
+ <member name="one_way_collision" type="bool" setter="set_one_way_collision" getter="is_one_way_collision_enabled" brief="">
+ </member>
+ <member name="polygon" type="PoolVector2Array" setter="set_polygon" getter="get_polygon" brief="">
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>