Expose replace(Vector<String>, String) to script as replace_all

shana · May 27, 2024 · 44235e5 · 44235e5
1 parent 60c35c4
commit 44235e5
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/core/variant/variant_call.cpp b/core/variant/variant_call.cpp
@@ -1668,6 +1668,7 @@ static void _register_variant_builtin_methods() {
 	bind_string_method(format, sarray("values", "placeholder"), varray("{_}"));
 	bind_string_methodv(replace, static_cast<String (String::*)(const String &, const String &) const>(&String::replace), sarray("what", "forwhat"), varray());
 	bind_string_methodv(replacen, static_cast<String (String::*)(const String &, const String &) const>(&String::replacen), sarray("what", "forwhat"), varray());
+	bind_string_methodv(replace_all, static_cast<String (String::*)(const Vector<String> &, const String &) const>(&String::replace), sarray("what", "forwhat"), varray());
 	bind_string_method(repeat, sarray("count"), varray());
 	bind_string_method(reverse, sarray(), varray());
 	bind_string_method(insert, sarray("position", "what"), varray());

diff --git a/doc/classes/String.xml b/doc/classes/String.xml
@@ -744,6 +744,14 @@
 				Replaces all occurrences of [param what] inside the string with the given [param forwhat].
 			</description>
 		</method>
+		<method name="replace_all" qualifiers="const">
+			<return type="String" />
+			<param index="0" name="what" type="PackedStringArray" />
+			<param index="1" name="forwhat" type="String" />
+			<description>
+				Replaces all occurrences of all [param what] entries inside the string with the given [param forwhat]. This is more efficient than calling [code skip-lint]replace[/code] multiple times with different [param what] and the same [param forwhat].
+			</description>
+		</method>
 		<method name="replacen" qualifiers="const">
 			<return type="String" />
 			<param index="0" name="what" type="String" />

diff --git a/doc/classes/StringName.xml b/doc/classes/StringName.xml
@@ -645,6 +645,14 @@
 				Replaces all occurrences of [param what] inside the string with the given [param forwhat].
 			</description>
 		</method>
+		<method name="replace_all" qualifiers="const">
+			<return type="String" />
+			<param index="0" name="what" type="PackedStringArray" />
+			<param index="1" name="forwhat" type="String" />
+			<description>
+				Replaces all occurrences of all [param what] entries inside the string with the given [param forwhat]. This is more efficient than calling [code skip-lint]replace[/code] multiple times with different [param what] and the same [param forwhat].
+			</description>
+		</method>
 		<method name="replacen" qualifiers="const">
 			<return type="String" />
 			<param index="0" name="what" type="String" />