Merge pull request #53819 from TokageItLab/re-implement-ping-pong

Reimplement ping-pong animation and reverse playback

3 files changed, 44 insertions, 23 deletions

diff --git a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
index 942d92311b..f4abb3c122 100644
--- a/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
+++ b/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml
@@ -140,73 +140,76 @@
 		</constant>
 		<constant name="MATH_WRAPF" value="42" enum="BuiltinFunc">
 		</constant>
-		<constant name="LOGIC_MAX" value="43" enum="BuiltinFunc">
+		<constant name="MATH_PINGPONG" value="43" enum="BuiltinFunc">
+			Return the [code]value[/code] wrapped between [code]0[/code] and the [code]length[/code]. If the limit is reached, the next value the function returned is decreased to the [code]0[/code] side or increased to the [code]length[/code] side (like a triangle wave). If [code]length[/code] is less than zero, it becomes positive.
+		</constant>
+		<constant name="LOGIC_MAX" value="44" enum="BuiltinFunc">
 			Return the greater of the two numbers, also known as their maximum.
 		</constant>
-		<constant name="LOGIC_MIN" value="44" enum="BuiltinFunc">
+		<constant name="LOGIC_MIN" value="45" enum="BuiltinFunc">
 			Return the lesser of the two numbers, also known as their minimum.
 		</constant>
-		<constant name="LOGIC_CLAMP" value="45" enum="BuiltinFunc">
+		<constant name="LOGIC_CLAMP" value="46" enum="BuiltinFunc">
 			Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to [code]min(max(input, range_low), range_high)[/code].
 		</constant>
-		<constant name="LOGIC_NEAREST_PO2" value="46" enum="BuiltinFunc">
+		<constant name="LOGIC_NEAREST_PO2" value="47" enum="BuiltinFunc">
 			Return the nearest power of 2 to the input.
 		</constant>
-		<constant name="OBJ_WEAKREF" value="47" enum="BuiltinFunc">
+		<constant name="OBJ_WEAKREF" value="48" enum="BuiltinFunc">
 			Create a [WeakRef] from the input.
 		</constant>
-		<constant name="TYPE_CONVERT" value="48" enum="BuiltinFunc">
+		<constant name="TYPE_CONVERT" value="49" enum="BuiltinFunc">
 			Convert between types.
 		</constant>
-		<constant name="TYPE_OF" value="49" enum="BuiltinFunc">
+		<constant name="TYPE_OF" value="50" enum="BuiltinFunc">
 			Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned.
 		</constant>
-		<constant name="TYPE_EXISTS" value="50" enum="BuiltinFunc">
+		<constant name="TYPE_EXISTS" value="51" enum="BuiltinFunc">
 			Checks if a type is registered in the [ClassDB].
 		</constant>
-		<constant name="TEXT_CHAR" value="51" enum="BuiltinFunc">
+		<constant name="TEXT_CHAR" value="52" enum="BuiltinFunc">
 			Return a character with the given ascii value.
 		</constant>
-		<constant name="TEXT_STR" value="52" enum="BuiltinFunc">
+		<constant name="TEXT_STR" value="53" enum="BuiltinFunc">
 			Convert the input to a string.
 		</constant>
-		<constant name="TEXT_PRINT" value="53" enum="BuiltinFunc">
+		<constant name="TEXT_PRINT" value="54" enum="BuiltinFunc">
 			Print the given string to the output window.
 		</constant>
-		<constant name="TEXT_PRINTERR" value="54" enum="BuiltinFunc">
+		<constant name="TEXT_PRINTERR" value="55" enum="BuiltinFunc">
 			Print the given string to the standard error output.
 		</constant>
-		<constant name="TEXT_PRINTRAW" value="55" enum="BuiltinFunc">
+		<constant name="TEXT_PRINTRAW" value="56" enum="BuiltinFunc">
 			Print the given string to the standard output, without adding a newline.
 		</constant>
-		<constant name="TEXT_PRINT_VERBOSE" value="56" enum="BuiltinFunc">
+		<constant name="TEXT_PRINT_VERBOSE" value="57" enum="BuiltinFunc">
 		</constant>
-		<constant name="VAR_TO_STR" value="57" enum="BuiltinFunc">
+		<constant name="VAR_TO_STR" value="58" enum="BuiltinFunc">
 			Serialize a [Variant] to a string.
 		</constant>
-		<constant name="STR_TO_VAR" value="58" enum="BuiltinFunc">
+		<constant name="STR_TO_VAR" value="59" enum="BuiltinFunc">
 			Deserialize a [Variant] from a string serialized using [constant VAR_TO_STR].
 		</constant>
-		<constant name="VAR_TO_BYTES" value="59" enum="BuiltinFunc">
+		<constant name="VAR_TO_BYTES" value="60" enum="BuiltinFunc">
 			Serialize a [Variant] to a [PackedByteArray].
 		</constant>
-		<constant name="BYTES_TO_VAR" value="60" enum="BuiltinFunc">
+		<constant name="BYTES_TO_VAR" value="61" enum="BuiltinFunc">
 			Deserialize a [Variant] from a [PackedByteArray] serialized using [constant VAR_TO_BYTES].
 		</constant>
-		<constant name="MATH_SMOOTHSTEP" value="61" enum="BuiltinFunc">
+		<constant name="MATH_SMOOTHSTEP" value="62" enum="BuiltinFunc">
 			Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to [constant MATH_LERP], but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula:
 			[codeblock]
 			var t = clamp((weight - from) / (to - from), 0.0, 1.0)
 			return t * t * (3.0 - 2.0 * t)
 			[/codeblock]
 		</constant>
-		<constant name="MATH_POSMOD" value="62" enum="BuiltinFunc">
+		<constant name="MATH_POSMOD" value="63" enum="BuiltinFunc">
 		</constant>
-		<constant name="MATH_LERP_ANGLE" value="63" enum="BuiltinFunc">
+		<constant name="MATH_LERP_ANGLE" value="64" enum="BuiltinFunc">
 		</constant>
-		<constant name="TEXT_ORD" value="64" enum="BuiltinFunc">
+		<constant name="TEXT_ORD" value="65" enum="BuiltinFunc">
 		</constant>
-		<constant name="FUNC_MAX" value="65" enum="BuiltinFunc">
+		<constant name="FUNC_MAX" value="66" enum="BuiltinFunc">
 			Represents the size of the [enum BuiltinFunc] enum.
 		</constant>
 	</constants>
diff --git a/modules/visual_script/visual_script_builtin_funcs.cpp b/modules/visual_script/visual_script_builtin_funcs.cpp
index 7e01031128..54a5e1449f 100644
--- a/modules/visual_script/visual_script_builtin_funcs.cpp
+++ b/modules/visual_script/visual_script_builtin_funcs.cpp
@@ -81,6 +81,7 @@ const char *VisualScriptBuiltinFunc::func_name[VisualScriptBuiltinFunc::FUNC_MAX
 	"db2linear",
 	"wrapi",
 	"wrapf",
+	"pingpong",
 	"max",
 	"min",
 	"clamp",
@@ -190,6 +191,7 @@ int VisualScriptBuiltinFunc::get_func_argument_count(BuiltinFunc p_func) {
 		case MATH_FMOD:
 		case MATH_FPOSMOD:
 		case MATH_POSMOD:
+		case MATH_PINGPONG:
 		case MATH_POW:
 		case MATH_EASE:
 		case MATH_SNAPPED:
@@ -381,6 +383,13 @@ PropertyInfo VisualScriptBuiltinFunc::get_input_value_port_info(int p_idx) const
 		case MATH_DB2LINEAR: {
 			return PropertyInfo(Variant::FLOAT, "db");
 		} break;
+		case MATH_PINGPONG: {
+			if (p_idx == 0) {
+				return PropertyInfo(Variant::FLOAT, "value");
+			} else {
+				return PropertyInfo(Variant::FLOAT, "length");
+			}
+		} break;
 		case MATH_WRAP: {
 			if (p_idx == 0) {
 				return PropertyInfo(Variant::INT, "value");
@@ -537,6 +546,7 @@ PropertyInfo VisualScriptBuiltinFunc::get_output_value_port_info(int p_idx) cons
 		case MATH_RAD2DEG:
 		case MATH_LINEAR2DB:
 		case MATH_WRAPF:
+		case MATH_PINGPONG:
 		case MATH_DB2LINEAR: {
 			t = Variant::FLOAT;
 		} break;
@@ -859,6 +869,11 @@ void VisualScriptBuiltinFunc::exec_func(BuiltinFunc p_func, const Variant **p_in
 			VALIDATE_ARG_NUM(0);
 			*r_return = Math::db2linear((double)*p_inputs[0]);
 		} break;
+		case VisualScriptBuiltinFunc::MATH_PINGPONG: {
+			VALIDATE_ARG_NUM(0);
+			VALIDATE_ARG_NUM(1);
+			*r_return = Math::pingpong((double)*p_inputs[0], (double)*p_inputs[1]);
+		} break;
 		case VisualScriptBuiltinFunc::MATH_WRAP: {
 			VALIDATE_ARG_NUM(0);
 			VALIDATE_ARG_NUM(1);
@@ -1206,6 +1221,7 @@ void VisualScriptBuiltinFunc::_bind_methods() {
 	BIND_ENUM_CONSTANT(MATH_DB2LINEAR);
 	BIND_ENUM_CONSTANT(MATH_WRAP);
 	BIND_ENUM_CONSTANT(MATH_WRAPF);
+	BIND_ENUM_CONSTANT(MATH_PINGPONG);
 	BIND_ENUM_CONSTANT(LOGIC_MAX);
 	BIND_ENUM_CONSTANT(LOGIC_MIN);
 	BIND_ENUM_CONSTANT(LOGIC_CLAMP);
@@ -1296,6 +1312,7 @@ void register_visual_script_builtin_func_node() {
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/db2linear", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_DB2LINEAR>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/wrapi", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_WRAP>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/wrapf", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_WRAPF>);
+	VisualScriptLanguage::singleton->add_register_func("functions/built_in/pingpong", create_builtin_func_node<VisualScriptBuiltinFunc::MATH_PINGPONG>);
 
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/max", create_builtin_func_node<VisualScriptBuiltinFunc::LOGIC_MAX>);
 	VisualScriptLanguage::singleton->add_register_func("functions/built_in/min", create_builtin_func_node<VisualScriptBuiltinFunc::LOGIC_MIN>);
diff --git a/modules/visual_script/visual_script_builtin_funcs.h b/modules/visual_script/visual_script_builtin_funcs.h
index f9eb7e983f..30f1f0d417 100644
--- a/modules/visual_script/visual_script_builtin_funcs.h
+++ b/modules/visual_script/visual_script_builtin_funcs.h
@@ -81,6 +81,7 @@ public:
 		MATH_DB2LINEAR,
 		MATH_WRAP,
 		MATH_WRAPF,
+		MATH_PINGPONG,
 		LOGIC_MAX,
 		LOGIC_MIN,
 		LOGIC_CLAMP,