diff options
author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2019-05-02 22:34:33 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-05-02 22:34:33 +0200 |
commit | c50ab02e4ceb1517f3a87a7bac82967ba1e6e2a9 (patch) | |
tree | 553b186dc61a04acae1376109a60e4f632c2b649 /doc | |
parent | 262924296b08b9065816e68e756a42c3963fa1ed (diff) | |
parent | da73bcca6fcfab16dbf06ebbf62f5b34b1ee19d5 (diff) |
Merge pull request #28608 from lopho/patch-1
Document CollisionObject2D pickable requires collision_layer
Diffstat (limited to 'doc')
-rw-r--r-- | doc/classes/CollisionObject2D.xml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/classes/CollisionObject2D.xml b/doc/classes/CollisionObject2D.xml index 1467812e4d..f847893a39 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -215,7 +215,7 @@ </methods> <members> <member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable"> - If [code]true[/code], this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. + If [code]true[/code], this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one [code]collision_layer[/code] bit to be set. </member> </members> <signals> @@ -227,17 +227,17 @@ <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]. See [method _input_event] for details. + Emitted when an input event occurs. Requires [code]input_pickable[/code] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. See [method _input_event] for details. </description> </signal> <signal name="mouse_entered"> <description> - Emitted when the mouse pointer enters any of this object's shapes. + Emitted when the mouse pointer enters any of this object's shapes. Requires [code]input_pickable[/code] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. </description> </signal> <signal name="mouse_exited"> <description> - Emitted when the mouse pointer exits all this object's shapes. + Emitted when the mouse pointer exits all this object's shapes. Requires [code]input_pickable[/code] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. </description> </signal> </signals> |