RichTextLabel: Adding ability for single meta hovering

[willnationsdev]

This will enable meta_hover_start and meta_hover_end events which also have the meta attached as a parameter. It supports only a single meta tag.

Note that the use of current_meta for line 930 of the .cpp was only needed because the attached meta kept on printing as an empty array on the scripting side when I tried just using meta_hovering->meta. Not quite sure why. If there is a way to remove the use of current_meta though, I'd be all for it.

[willnationsdev]

not entirely sure if that will affect performance

There shouldn't be any problem since the function in question is already calling _find_click and _find_meta, so it's largely already been devoting those resources.

You might be able to get a hover signal sent out on a recurring basis. Maybe just in the _gui_input, check to see if meta_hovering is non-null? If so, emit with current_meta? I'll try it tomorrow. After midnight for me at the moment.

[akien-mga]

The design of signals is to be discrete, I don't think a meta_hovering signal would make sense as you would be spammed with signals as long as it's true. It should be easy enough to catch meta_hover_start and set a boolean in your code, and reset it when you catch meta_hover_end. This is the design used everywhere in Godot, for example area_entered/area_exited and no area_occupied/overlapped.

[willnationsdev]

My mistake. Yeah, basically I needed to have access to the item and outside properties, so I had to move the _find_click up out of the if statement. As a result, it will get called much more frequently. So this new code will effectively make the node find the currently clicked item every single time your mouse moves while over the node's dimensions. That will be a loss of performance, but is mandatory to add this feature.

No function caching here (I wish, that'd be a cool feature), just me not picking up on what you meant initially.

Also, I agree with you guys on not including a hovering signal.

When I next get a chance, I'll try to fix the clang format issues. My plugin for it just doesn't seem to work. Will try to use something else or will make the necessary changes manually if need be.

[willnationsdev]

Oh woops, and people should note that the signal names are past tense, started and ended.

[HummusSamurai]

Can you post the code for the example in the GIF?

I can't find documentation for this.

[willnationsdev]

@HummusSamurai sure.

_ready():
    push_meta("test")
    add_text("hello")
    pop()
    push_meta({"data":"hi"})
    add_text("hello2")
    pop()

[willnationsdev]

I've updated documentation in a separate merge as well, so when they next generate the docs, it will have full descriptions.

[HummusSamurai]

@willnationsdev Thank you!