Add color option for img bbcode tag in RichTextLabel to tint images

[pouleyKetchoupp]

edit: changed to add a color option in img tag instead of a new tag img-color.

Allows RichTextLabel to display an image with tint using a new option color in img tag.

Allows RichTextLabel to display an image with tint using a new bbcode tag img-color.

It works the same way as the color tag, but only affects images. It was added as a separate tag to keep the expected behavior that color only affects the font color and images are not affected by color changes by default.

bbcode = Text with icon [img width=16]res://icon.png[/img]

bbcode = Text with icon[img width=16 color=#00FF00]res://icon.png[/img]

[akien-mga]

Maybe this could be an optional parameter in [img] instead of a new tag?

[Calinou]

If breaking compatibility isn't an issue, we could make [color] affect images instead. I guess the concern was to have something cherry-pickable to the 3.2 branch, so we could have a separate PR with a dedicated tag for that branch.

[groud]

we could make [color] affect images instead.

I think this would be annoying to have to close a color tag just to have your icon to be displayed with the original colors. As it is kind of a corner case, I think I like @akien-mga's solution better.

[pouleyKetchoupp]

Thanks all for the feedback!

@Calinou If possible, I would rather not break compatibility and keep the two branches in sync, but my main concern is that I think intuitively you would not expect the font color to affect images too.

I agree the idea proposed by @akien-mga to have an optional parameter instead of a dedicated tag seems like a good compromise.

The syntax for images with color could be:
[img color=<color>]{path}[/img]
[img=<width> color=<color>]{path}[/img]
[img=<width>x<height> color=<color>]{path}[/img]
And it would be just a Color parameter added to image items, so the code changes would be much simpler than what I did so far.

[akien-mga]

I'd say the size parameter should probably be made explicit too as [img=<width>] is a bit weird currently. So:

[img size=<width> color=<color>]{path}[/img]
[img size=<width>x<height> color=<color>]{path}[/img]

Edit: Well looking at https://docs.godotengine.org/en/stable/tutorials/gui/bbcode_in_richtextlabel.html currently we do have various tags that use [tag=<value>], so I guess [img=<width>] made sense in this context... but what bothers me is that <width> is not a proper value for img, I'd expect more something like [img=<path> size=<width>]...

I think there's an opportunity for cleaning up the BBcode tags and make them more consistent and standard for 4.0.

But in the meantime if we want a simple change that doesn't break compat, just adding the optional color parameter and keeping [img=<width>] makes sense (then it should be compatible with 3.2).

[dalexeev]

Maybe [tint={color}][img]{path}[/img][/tint] or [modulate={color}][img]{path}[/img][/modulate]?

This is UNIX BBCode way! 😄

[pouleyKetchoupp]

@akien-mga Yes, I would rather keep this PR simple for now and have more involved syntax changes separated.

About changing the syntax:
The way image path & size is handled seems to follow some standard bbcode syntax:
https://www.bbcode.org/reference.php

So if we want to keep our syntax consistent with this reference we could add this version as an alternative to set the size:
[img width=<width> height=<height>]{path}[/img]

That said, we could use a custom syntax, but I don't know if it should be called bbcode if it's too different from the original version, to make sure it's not misleading to users.

[akien-mga]

I think we should aim to stay BBcode compatible as far as possible yeah, even though we do have extra tags that BBcode doesn't have (so it's more like "Godot Extended BBcode").

[pouleyKetchoupp]

Just pushed the changed to make color an option in img tag instead of a new tag.

Since I've added easier-to-use code to check for options in tags, I've also added width & height options to img as an alternative and updated the code handling built-in effects to use it too.

[pouleyKetchoupp]

I've pushed a little update on comments styling.

[akien-mga]

Thanks!