Allow image dimensions in RichTextLabel to be relative to font size

Use base font size

Added docs and compatibility methods

Fix compatibility methods maybe for real this time????

Please?

Make width/height use floats instead of ints, and then make 1em be the height of surrounding text

Fix documentation for floats instead of ints

Update compatibility

# Conflicts:
#	misc/extension_api_validation/4.5-stable.expected

# Conflicts:
#	misc/extension_api_validation/4.5-stable.expected

# Conflicts:
#	misc/extension_api_validation/4.5-stable.expected

# Conflicts:
#	misc/extension_api_validation/4.5-stable.expected

# Conflicts:
#	misc/extension_api_validation/4.5-stable.expected

# Conflicts:
#	misc/extension_api_validation/4.5-stable.expected

Add compatibility breakages file

# Conflicts:
#	misc/extension_api_validation/4.5-stable_4.6-stable/GH-112617.txt

# Conflicts:
#	scene/gui/rich_text_label.cpp

Author: Meorge

doc/classes/RichTextLabel.xml

@@ -34,25 +34,24 @@
 		<method name="add_image">
 			<return type="void" />
 			<param index="0" name="image" type="Texture2D" />
-			<param index="1" name="width" type="int" default="0" />
-			<param index="2" name="height" type="int" default="0" />
+			<param index="1" name="width" type="float" default="0" />
+			<param index="2" name="height" type="float" default="0" />
 			<param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" />
 			<param index="4" name="inline_align" type="int" enum="InlineAlignment" default="5" />
 			<param index="5" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" />
 			<param index="6" name="key" type="Variant" default="null" />
 			<param index="7" name="pad" type="bool" default="false" />
 			<param index="8" name="tooltip" type="String" default="&quot;&quot;" />
-			<param index="9" name="width_in_percent" type="bool" default="false" />
-			<param index="10" name="height_in_percent" type="bool" default="false" />
+			<param index="9" name="width_unit" type="int" enum="RichTextLabel.ImageUnit" default="0" />
+			<param index="10" name="height_unit" type="int" enum="RichTextLabel.ImageUnit" default="0" />
 			<param index="11" name="alt_text" type="String" default="&quot;&quot;" />
 			<description>
 				Adds an image's opening and closing tags to the tag stack, optionally providing a [param width] and [param height] to resize the image, a [param color] to tint the image and a [param region] to only use parts of the image.
 				If [param width] or [param height] is set to 0, the image size will be adjusted in order to keep the original aspect ratio.
 				If [param width] and [param height] are not set, but [param region] is, the region's rect will be used.
 				[param key] is an optional identifier, that can be used to modify the image via [method update_image].
 				If [param pad] is set, and the image is smaller than the size specified by [param width] and [param height], the image padding is added to match the size instead of upscaling.
-				If [param width_in_percent] is set, [param width] values are percentages of the control width instead of pixels.
-				If [param height_in_percent] is set, [param height] values are percentages of the control width instead of pixels.
+				Parameters [param width_unit] and [param height_unit] determine the units used to calculate the image width and height, respectively.
 				[param alt_text] is used as the image description for assistive apps.
 			</description>
 		</method>
@@ -698,15 +697,15 @@
 			<param index="0" name="key" type="Variant" />
 			<param index="1" name="mask" type="int" enum="RichTextLabel.ImageUpdateMask" is_bitfield="true" />
 			<param index="2" name="image" type="Texture2D" />
-			<param index="3" name="width" type="int" default="0" />
-			<param index="4" name="height" type="int" default="0" />
+			<param index="3" name="width" type="float" default="0" />
+			<param index="4" name="height" type="float" default="0" />
 			<param index="5" name="color" type="Color" default="Color(1, 1, 1, 1)" />
 			<param index="6" name="inline_align" type="int" enum="InlineAlignment" default="5" />
 			<param index="7" name="region" type="Rect2" default="Rect2(0, 0, 0, 0)" />
 			<param index="8" name="pad" type="bool" default="false" />
 			<param index="9" name="tooltip" type="String" default="&quot;&quot;" />
-			<param index="10" name="width_in_percent" type="bool" default="false" />
-			<param index="11" name="height_in_percent" type="bool" default="false" />
+			<param index="10" name="width_unit" type="int" enum="RichTextLabel.ImageUnit" default="0" />
+			<param index="11" name="height_unit" type="int" enum="RichTextLabel.ImageUnit" default="0" />
 			<description>
 				Updates the existing images with the key [param key]. Only properties specified by [param mask] bits are updated. See [method add_image].
 			</description>
@@ -901,8 +900,17 @@
 		<constant name="UPDATE_TOOLTIP" value="64" enum="ImageUpdateMask" is_bitfield="true">
 			If this bit is set, [method update_image] changes image tooltip.
 		</constant>
-		<constant name="UPDATE_WIDTH_IN_PERCENT" value="128" enum="ImageUpdateMask" is_bitfield="true">
-			If this bit is set, [method update_image] changes image width from/to percents.
+		<constant name="UPDATE_WIDTH_UNIT" value="128" enum="ImageUpdateMask" is_bitfield="true">
+			If this bit is set, [method update_image] changes the units used to calculate image size.
+		</constant>
+		<constant name="IMAGE_UNIT_PIXEL" value="0" enum="ImageUnit">
+			Images drawn with this unit will be in pixels.
+		</constant>
+		<constant name="IMAGE_UNIT_PERCENT" value="1" enum="ImageUnit">
+			Images drawn with this unit will be in percentages of the control width.
+		</constant>
+		<constant name="IMAGE_UNIT_EM" value="2" enum="ImageUnit">
+			Images drawn with this unit will be in percentages of the surrounding font size.
 		</constant>
 	</constants>
 	<theme_items>

editor/doc/editor_help.cpp

@@ -2889,7 +2889,7 @@ static void _add_text_to_rt(const String &p_bbcode, RichTextLabel *p_rt, const C
 			}
 
 			String image_path = bbcode.substr(brk_end + 1, end - brk_end - 1);
-			p_rt->add_image(ResourceLoader::load(image_path, "Texture2D"), width, height, Color(1, 1, 1), INLINE_ALIGNMENT_CENTER, Rect2(), Variant(), false, String(), size_in_percent);
+			p_rt->add_image(ResourceLoader::load(image_path, "Texture2D"), width, height, Color(1, 1, 1), INLINE_ALIGNMENT_CENTER, Rect2(), Variant(), false, String(), size_in_percent ? RichTextLabel::IMAGE_UNIT_PERCENT : RichTextLabel::IMAGE_UNIT_PIXEL);
 
 			pos = end;
 			tag_stack.push_front("img");

misc/extension_api_validation/4.6-stable/GH-112617.txt

@@ -0,0 +1,21 @@
+GH-112617
+---------
+Validate extension JSON: API was removed: classes/RichTextLabel/enums/ImageUpdateMask/values/UPDATE_WIDTH_IN_PERCENT
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/add_image/arguments/10': default_value changed value in new API, from "false" to "0".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/add_image/arguments/10': type changed value in new API, from "bool" to "enum::RichTextLabel.ImageUnit".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/add_image/arguments/9': default_value changed value in new API, from "false" to "0".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/add_image/arguments/9': type changed value in new API, from "bool" to "enum::RichTextLabel.ImageUnit".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/update_image/arguments/10': default_value changed value in new API, from "false" to "0".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/update_image/arguments/10': type changed value in new API, from "bool" to "enum::RichTextLabel.ImageUnit".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/update_image/arguments/11': default_value changed value in new API, from "false" to "0".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/update_image/arguments/11': type changed value in new API, from "bool" to "enum::RichTextLabel.ImageUnit".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/add_image/arguments/1': meta changed value in new API, from "int32" to "float".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/add_image/arguments/1': type changed value in new API, from "int" to "float".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/add_image/arguments/2': meta changed value in new API, from "int32" to "float".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/add_image/arguments/2': type changed value in new API, from "int" to "float".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/update_image/arguments/3': meta changed value in new API, from "int32" to "float".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/update_image/arguments/3': type changed value in new API, from "int" to "float".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/update_image/arguments/4': meta changed value in new API, from "int32" to "float".
+Validate extension JSON: Error: Field 'classes/RichTextLabel/methods/update_image/arguments/4': type changed value in new API, from "int" to "float".
+
+Arguments changed from bools to enums for a few methods. Compatibility methods registered.

scene/gui/rich_text_label.compat.inc

@@ -51,11 +51,11 @@ void RichTextLabel::_push_meta_bind_compat_89024(const Variant &p_meta) {
 }
 
 void RichTextLabel::_add_image_bind_compat_80410(const Ref<Texture2D> &p_image, const int p_width, const int p_height, const Color &p_color, InlineAlignment p_alignment, const Rect2 &p_region) {
-	add_image(p_image, p_width, p_height, p_color, p_alignment, p_region, Variant(), false, String(), false, false, String());
+	add_image(p_image, p_width, p_height, p_color, p_alignment, p_region, Variant(), false, String(), IMAGE_UNIT_PIXEL, IMAGE_UNIT_PIXEL, String());
 }
 
 void RichTextLabel::_add_image_bind_compat_76829(const Ref<Texture2D> &p_image, const int p_width, const int p_height, const Color &p_color, InlineAlignment p_alignment, const Rect2 &p_region, const Variant &p_key, bool p_pad, const String &p_tooltip, bool p_size_in_percent) {
-	add_image(p_image, p_width, p_height, p_color, p_alignment, p_region, p_key, p_pad, p_tooltip, p_size_in_percent, p_size_in_percent, String());
+	add_image(p_image, p_width, p_height, p_color, p_alignment, p_region, p_key, p_pad, p_tooltip, p_size_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL, p_size_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL, String());
 }
 
 void RichTextLabel::_push_table_bind_compat_76829(int p_columns, InlineAlignment p_alignment, int p_align_to_row) {
@@ -75,11 +75,19 @@ void RichTextLabel::_push_strikethrough_bind_compat_106300() {
 }
 
 void RichTextLabel::_add_image_bind_compat_107347(const Ref<Texture2D> &p_image, int p_width, int p_height, const Color &p_color, InlineAlignment p_alignment, const Rect2 &p_region, const Variant &p_key, bool p_pad, const String &p_tooltip, bool p_size_in_percent, const String &p_alt_text) {
-	add_image(p_image, p_width, p_height, p_color, p_alignment, p_region, p_key, p_pad, p_tooltip, p_size_in_percent, p_size_in_percent, p_alt_text);
+	add_image(p_image, p_width, p_height, p_color, p_alignment, p_region, p_key, p_pad, p_tooltip, p_size_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL, p_size_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL, p_alt_text);
 }
 
 void RichTextLabel::_update_image_bind_compat_107347(const Variant &p_key, BitField<ImageUpdateMask> p_mask, const Ref<Texture2D> &p_image, int p_width, int p_height, const Color &p_color, InlineAlignment p_alignment, const Rect2 &p_region, bool p_pad, const String &p_tooltip, bool p_size_in_percent) {
-	update_image(p_key, p_mask, p_image, p_width, p_height, p_color, p_alignment, p_region, p_pad, p_tooltip, p_size_in_percent, p_size_in_percent);
+	update_image(p_key, p_mask, p_image, p_width, p_height, p_color, p_alignment, p_region, p_pad, p_tooltip, p_size_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL, p_size_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL);
+}
+
+void RichTextLabel::_add_image_bind_compat_112617(const Ref<Texture2D> &p_image, int p_width, int p_height, const Color &p_color, InlineAlignment p_alignment, const Rect2 &p_region, const Variant &p_key, bool p_pad, const String &p_tooltip, bool p_width_in_percent, bool p_height_in_percent, const String &p_alt_text) {
+	add_image(p_image, p_width, p_height, p_color, p_alignment, p_region, p_key, p_pad, p_tooltip, p_width_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL, p_height_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL, p_alt_text);
+}
+
+void RichTextLabel::_update_image_bind_compat_112617(const Variant &p_key, BitField<ImageUpdateMask> p_mask, const Ref<Texture2D> &p_image, int p_width, int p_height, const Color &p_color, InlineAlignment p_alignment, const Rect2 &p_region, bool p_pad, const String &p_tooltip, bool p_width_in_percent, bool p_height_in_percent) {
+	update_image(p_key, p_mask, p_image, p_width, p_height, p_color, p_alignment, p_region, p_pad, p_tooltip, p_width_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL, p_height_in_percent ? IMAGE_UNIT_PERCENT : IMAGE_UNIT_PIXEL);
 }
 
 void RichTextLabel::_bind_compatibility_methods() {
@@ -96,6 +104,9 @@ void RichTextLabel::_bind_compatibility_methods() {
 	ClassDB::bind_compatibility_method(D_METHOD("push_strikethrough"), &RichTextLabel::_push_strikethrough_bind_compat_106300);
 	ClassDB::bind_compatibility_method(D_METHOD("add_image", "image", "width", "height", "color", "inline_align", "region", "key", "pad", "tooltip", "size_in_percent", "alt_text"), &RichTextLabel::_add_image_bind_compat_107347, DEFVAL(0), DEFVAL(0), DEFVAL(Color(1.0, 1.0, 1.0)), DEFVAL(INLINE_ALIGNMENT_CENTER), DEFVAL(Rect2()), DEFVAL(Variant()), DEFVAL(false), DEFVAL(String()), DEFVAL(false), DEFVAL(String()));
 	ClassDB::bind_compatibility_method(D_METHOD("update_image", "key", "mask", "image", "width", "height", "color", "inline_align", "region", "pad", "tooltip", "size_in_percent"), &RichTextLabel::_update_image_bind_compat_107347, DEFVAL(0), DEFVAL(0), DEFVAL(Color(1.0, 1.0, 1.0)), DEFVAL(INLINE_ALIGNMENT_CENTER), DEFVAL(Rect2()), DEFVAL(false), DEFVAL(String()), DEFVAL(false));
+
+	ClassDB::bind_compatibility_method(D_METHOD("add_image", "image", "width", "height", "color", "inline_align", "region", "key", "pad", "tooltip", "width_in_percent", "height_in_percent", "alt_text"), &RichTextLabel::_add_image_bind_compat_112617, DEFVAL(0), DEFVAL(0), DEFVAL(Color(1.0, 1.0, 1.0)), DEFVAL(INLINE_ALIGNMENT_CENTER), DEFVAL(Rect2()), DEFVAL(Variant()), DEFVAL(false), DEFVAL(String()), DEFVAL(false), DEFVAL(false), DEFVAL(String()));
+	ClassDB::bind_compatibility_method(D_METHOD("update_image", "key", "mask", "image", "width", "height", "color", "inline_align", "region", "pad", "tooltip", "width_in_percent", "height_in_percent"), &RichTextLabel::_update_image_bind_compat_112617, DEFVAL(0), DEFVAL(0), DEFVAL(Color(1.0, 1.0, 1.0)), DEFVAL(INLINE_ALIGNMENT_CENTER), DEFVAL(Rect2()), DEFVAL(false), DEFVAL(String()), DEFVAL(false), DEFVAL(false));
 }
 
 #endif // DISABLE_DEPRECATED