Expose a method to get hovered Control in Viewport

[Kimau]

Found myself needing this to resolve some UI stuff in a clean way.

[AThousandShips]

You need to add documentation for this new method as well, see here

Also I think the name might need a discussion, the current name isn't very clear to me, maybe something gui_get_control_under_mouse, or gui_get_mouse_over_control, or something similar

[Kimau]

I was trying to keep the naming convention as close to the underlying code as possible.
I thought the fact the return type was Control was self documenting enough to show the behaviour.

I have tried to make it clear in the docs.

[AThousandShips]

The return type isn't always obvious from the name in for example autocomplete, but I think the name works, we'll see what others think 🙂

[Kimau]

Tried to elaborate more in the docs but I did still use the term leaf node and the likely function a user would want to use with it.

[AThousandShips]

LGTM, someone with detail knowledge of the mouse over system should look at the docs to check the wording and claims

[Kimau]

Maybe control tree or stack is better than group 🤷

[AThousandShips]

"Subtree" or "hierarchy" might be best, as they are pretty established

[AThousandShips]

CC @Sauermann If I'm not mistaken you've worked with the viewport input area

[AThousandShips]

Updated the title as the binding isn't exclusive to GDScript

[Sauermann]

Implementation looks correct, didn't test it however.

[YuriSizov]

I was trying to keep the naming convention as close to the underlying code as possible.
I thought the fact the return type was Control was self documenting enough to show the behaviour.

I would say that in this case our internal naming convention is not great and should be adjusted alongside your changes if we seek consistency, or can be left as is to avoid making this PR bigger than it needs to be. But the public method needs to have a subject in its name. Internal properties and methods don't always have good names for public API because they are never considered from this perspective.

So something like gui_get_hovered_control would be ideal for a public method name.

---

Other than that, this seems fine, it's just exposing an existing value. Once you address the name and squash the commits this can be merged.

[YuriSizov]

Updated and rebased on your behalf.

[YuriSizov]

Thanks, and congrats on your first merged Godot contribution!

[Kimau]

Thanks, and congrats on your first merged Godot contribution!

Thanks for making the changes and merging work for busy. Yeah funny this one beat #83138 😂

But yeah this was actually simple 👍