summaryrefslogtreecommitdiff
path: root/doc/classes/CollisionShape.xml
diff options
context:
space:
mode:
authorJuan Linietsky <reduzio@gmail.com>2017-09-12 17:42:36 -0300
committerJuan Linietsky <reduzio@gmail.com>2017-09-12 17:45:41 -0300
commit4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch)
tree730471182cae00f2e47c7430db441d057383d29b /doc/classes/CollisionShape.xml
parent175777596ec3521731665dd750fd7087793b10fc (diff)
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/CollisionShape.xml')
-rw-r--r--doc/classes/CollisionShape.xml69
1 files changed, 69 insertions, 0 deletions
diff --git a/doc/classes/CollisionShape.xml b/doc/classes/CollisionShape.xml
new file mode 100644
index 0000000000..7e7ea2e3e6
--- /dev/null
+++ b/doc/classes/CollisionShape.xml
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="CollisionShape" inherits="Spatial" category="Core" version="3.0.alpha.custom_build">
+ <brief_description>
+ Node that represents collision shape data in 3D space.
+ </brief_description>
+ <description>
+ Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area] to give it a detection shape, or add it to a [PhysicsBody] 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="Shape">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="is_disabled" qualifiers="const">
+ <return type="bool">
+ </return>
+ <description>
+ </description>
+ </method>
+ <method name="make_convex_from_brothers">
+ <return type="void">
+ </return>
+ <description>
+ Sets the collision shape's shape to the addition of all its convexed [MeshInstance] siblings geometry.
+ </description>
+ </method>
+ <method name="resource_changed">
+ <return type="void">
+ </return>
+ <argument index="0" name="resource" type="Resource">
+ </argument>
+ <description>
+ If this method exists within a script it will be called whenever the shape resource has been modified.
+ </description>
+ </method>
+ <method name="set_disabled">
+ <return type="void">
+ </return>
+ <argument index="0" name="enable" type="bool">
+ </argument>
+ <description>
+ </description>
+ </method>
+ <method name="set_shape">
+ <return type="void">
+ </return>
+ <argument index="0" name="shape" type="Shape">
+ </argument>
+ <description>
+ </description>
+ </method>
+ </methods>
+ <members>
+ <member name="disabled" type="bool" setter="set_disabled" getter="is_disabled" brief="">
+ A disabled collision shape has no effect in the world.
+ </member>
+ <member name="shape" type="Shape" setter="set_shape" getter="get_shape" brief="">
+ The actual shape owned by this collision shape.
+ </member>
+ </members>
+ <constants>
+ </constants>
+</class>