diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-07-22 21:37:58 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-07-22 21:37:58 +0200 |
| commit | bcfbd25eefe4d1c0b8ac54ef7eb4abcc51cf68d4 (patch) | |
| tree | 4aa0edab84d5e6e213589e1ce34682b2300ebe5f /doc | |
| parent | d8d85762c4416ed383a33825dc3dd37b4fe15a9f (diff) | |
| parent | 9a84cef4fca3986bd46b3311e2771dbd1d0dbc08 (diff) | |
Merge pull request #30728 from FlamyAT/fix-inputevent-doc
Documents the need for input_pickable in _input_event
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 eb69a4aed4..b9ec9480cf 100644 --- a/doc/classes/CollisionObject2D.xml +++ b/doc/classes/CollisionObject2D.xml @@ -19,7 +19,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. + Accepts unhandled [InputEvent]s. Requires [member input_pickable] to be [code]true[/code]. [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"> @@ -227,17 +227,17 @@ <argument index="2" name="shape_idx" type="int"> </argument> <description> - 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. + Emitted when an input event occurs. Requires [member input_pickable] 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. Requires [code]input_pickable[/code] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. + Emitted when the mouse pointer enters any of this object's shapes. Requires [member input_pickable] 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. Requires [code]input_pickable[/code] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. + Emitted when the mouse pointer exits all this object's shapes. Requires [member input_pickable] to be [code]true[/code] and at least one [code]collision_layer[/code] bit to be set. </description> </signal> </signals> |