godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document CollisionObject2D pickable requires collision_layer 

Documents CollisionObject2D mouse_entered, mouse_exited and input_event requiring at least one collision_layer to be set.

(cherry picked from commit da73bcca6f)
This commit is contained in:
lopho 2019-05-02 15:43:28 +02:00 committed by Rémi Verschelde
parent 3086084ace
commit 4c6327e426
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/classes/CollisionObject2D.xml
View File

@ -215,7 +215,7 @@
</methods> </methods>
<members> <members>
<member name="input_pickable" type="bool" setter="set_pickable" getter="is_pickable"> <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> </member>
</members> </members>
<signals> <signals>
@ -227,17 +227,17 @@
<argument index="2" name="shape_idx" type="int"> <argument index="2" name="shape_idx" type="int">
</argument> </argument>
<description> <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> </description>
</signal> </signal>
<signal name="mouse_entered"> <signal name="mouse_entered">
<description> <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> </description>
</signal> </signal>
<signal name="mouse_exited"> <signal name="mouse_exited">
<description> <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> </description>
</signal> </signal>
</signals> </signals>