summaryrefslogtreecommitdiff
path: root/doc/classes/CollisionObject2D.xml
diff options
context:
space:
mode:
authorChris Bradfield <cb@scribe.net>2017-12-07 20:16:15 -0800
committerGitHub <noreply@github.com>2017-12-07 20:16:15 -0800
commitd055031c73ebce375f3b0087baf9ba617fc996aa (patch)
tree8da8a57757479d99487ce94ba3745f57050c4064 /doc/classes/CollisionObject2D.xml
parent6f764d3f0a0353f7eff2c81d90f0dc2ce7418d1b (diff)
parenta9c9499c730be809dab420704961a611b0a2d04a (diff)
Merge pull request #14395 from willnationsdev/docs2
[DOCS] CanvasItem(Material)/Layer, ClassDB, and CollisionObject(2D)
Diffstat (limited to 'doc/classes/CollisionObject2D.xml')
-rw-r--r--doc/classes/CollisionObject2D.xml6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml
index ffc79d359d..086513cad5 100644
--- a/doc/classes/CollisionObject2D.xml
+++ b/doc/classes/CollisionObject2D.xml
@@ -21,6 +21,7 @@
<argument index="2" name="shape_idx" type="int">
</argument>
<description>
+ Accepts unhandled [InputEvent]s. [code]shape_idx[/code] is the child index of the clicked [Shape2D]. Connect to the [code]input_event[/code] signal to easily pick up these events.
</description>
</method>
<method name="create_shape_owner">
@@ -61,6 +62,7 @@
<argument index="0" name="owner_id" type="int">
</argument>
<description>
+ Returns [code]true[/code] if collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s.
</description>
</method>
<method name="remove_shape_owner">
@@ -138,6 +140,7 @@
<argument index="1" name="shape_id" type="int">
</argument>
<description>
+ Returns the child index of the [Shape2D] with the given id from the given shape owner.
</description>
</method>
<method name="shape_owner_get_transform" qualifiers="const">
@@ -179,6 +182,7 @@
<argument index="1" name="enable" type="bool">
</argument>
<description>
+ If [code]enable[/code] is [code]true[/code], collisions for the shape owner originating from this [code]CollisionObject2D[/code] will not be reported to collided with [code]CollisionObject2D[/code]s.
</description>
</method>
<method name="shape_owner_set_transform">
@@ -207,7 +211,7 @@
<argument index="2" name="shape_idx" type="int">
</argument>
<description>
- Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code].
+ Emitted when an input event occurs and [code]input_pickable[/code] is [code]true[/code]. See [method _input_event] for details.
</description>
</signal>
<signal name="mouse_entered">