2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-04-01 12:33:56 +02:00
<class name= "VisualScriptBuiltinFunc" inherits= "VisualScriptNode" category= "Core" version= "3.2" >
2017-09-12 22:42:36 +02:00
<brief_description >
2017-09-28 12:07:20 +02:00
A Visual Script node used to call built-in functions.
2017-09-12 22:42:36 +02:00
</brief_description>
<description >
2017-09-28 12:07:20 +02:00
A built-in function used inside a [VisualScript]. It is usually a math function or an utility function.
See also [@GDScript], for the same functions in the GDScript language.
2017-09-12 22:42:36 +02:00
</description>
<tutorials >
</tutorials>
<methods >
</methods>
<members >
2019-06-29 12:38:01 +02:00
<member name= "function" type= "int" setter= "set_func" getter= "get_func" enum= "VisualScriptBuiltinFunc.BuiltinFunc" default= "0" >
2017-09-28 12:07:20 +02:00
The function to be executed.
2017-09-12 22:42:36 +02:00
</member>
</members>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "MATH_SIN" value= "0" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the sine of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_COS" value= "1" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the cosine of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_TAN" value= "2" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the tangent of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_SINH" value= "3" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the hyperbolic sine of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_COSH" value= "4" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the hyperbolic cosine of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_TANH" value= "5" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the hyperbolic tangent of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_ASIN" value= "6" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the arc sine of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_ACOS" value= "7" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the arc cosine of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_ATAN" value= "8" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the arc tangent of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_ATAN2" value= "9" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the arc tangent of the input, using the signs of both parameters to determine the exact angle.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_SQRT" value= "10" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the square root of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_FMOD" value= "11" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the remainder of one input divided by the other, using floating-point numbers.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_FPOSMOD" value= "12" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the positive remainder of one input divided by the other, using floating-point numbers.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_FLOOR" value= "13" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the input rounded down.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_CEIL" value= "14" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the input rounded up.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_ROUND" value= "15" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the input rounded to the nearest integer.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_ABS" value= "16" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the absolute value of the input.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_SIGN" value= "17" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the sign of the input, turning it into 1, -1, or 0. Useful to determine if the input is positive or negative.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_POW" value= "18" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the input raised to a given power.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_LOG" value= "19" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_EXP" value= "20" enum= "BuiltinFunc" >
2018-04-15 18:40:31 +02:00
Return the mathematical constant [b]e[/b] raised to the specified power of the input. [b]e[/b] has an approximate value of 2.71828.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_ISNAN" value= "21" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return whether the input is NaN (Not a Number) or not. NaN is usually produced by dividing 0 by 0, though other ways exist.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_ISINF" value= "22" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return whether the input is an infinite floating-point number or not. Infinity is usually produced by dividing a number by 0, though other ways exist.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_EASE" value= "23" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Easing function, based on exponent. 0 is constant, 1 is linear, 0 to 1 is ease-in, 1+ is ease out. Negative values are in-out/out in.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_DECIMALS" value= "24" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the number of digit places after the decimal that the first non-zero digit occurs.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_STEPIFY" value= "25" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the input snapped to a given step.
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_LERP" value= "26" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula [code]a + (a - b) * t[/code].
2017-09-16 01:46:14 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_INVERSE_LERP" value= "27" enum= "BuiltinFunc" >
2017-10-21 12:02:08 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "MATH_RANGE_LERP" value= "28" enum= "BuiltinFunc" >
2017-10-21 12:02:08 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_MOVE_TOWARD" value= "29" enum= "BuiltinFunc" >
Moves the number toward a value, based on the third input.
</constant>
<constant name= "MATH_DECTIME" value= "30" enum= "BuiltinFunc" >
2019-06-22 01:04:47 +02:00
Return the result of [code]value[/code] decreased by [code]step[/code] * [code]amount[/code].
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_RANDOMIZE" value= "31" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_RAND" value= "32" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return a random 32 bits integer value. To obtain a random value between 0 to N (where N is smaller than 2^32 - 1), you can use it with the remainder function.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_RANDF" value= "33" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return a random floating-point value between 0 and 1. To obtain a random value between 0 to N, you can use it with multiplication.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_RANDOM" value= "34" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return a random floating-point value between the two inputs.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_SEED" value= "35" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Set the seed for the random number generator.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_RANDSEED" value= "36" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return a random value from the given seed, along with the new seed.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_DEG2RAD" value= "37" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Convert the input from degrees to radians.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_RAD2DEG" value= "38" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Convert the input from radians to degrees.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_LINEAR2DB" value= "39" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Convert the input from linear volume to decibel volume.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_DB2LINEAR" value= "40" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Convert the input from decibel volume to linear volume.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_POLAR2CARTESIAN" value= "41" enum= "BuiltinFunc" >
2019-06-22 01:04:47 +02:00
Converts a 2D point expressed in the polar coordinate system (a distance from the origin [code]r[/code] and an angle [code]th[/code]) to the cartesian coordinate system (X and Y axis).
2017-11-13 09:24:36 +01:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_CARTESIAN2POLAR" value= "42" enum= "BuiltinFunc" >
2019-06-22 01:04:47 +02:00
Converts a 2D point expressed in the cartesian coordinate system (X and Y axis) to the polar coordinate system (a distance from the origin and an angle).
2017-11-13 09:24:36 +01:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_WRAP" value= "43" enum= "BuiltinFunc" >
2017-10-13 01:15:45 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_WRAPF" value= "44" enum= "BuiltinFunc" >
2017-10-13 01:15:45 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "LOGIC_MAX" value= "45" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the greater of the two numbers, also known as their maximum.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "LOGIC_MIN" value= "46" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the lesser of the two numbers, also known as their minimum.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "LOGIC_CLAMP" value= "47" enum= "BuiltinFunc" >
2018-12-27 11:10:09 +01:00
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].
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "LOGIC_NEAREST_PO2" value= "48" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the nearest power of 2 to the input.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "OBJ_WEAKREF" value= "49" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Create a [WeakRef] from the input.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "FUNC_FUNCREF" value= "50" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Create a [FuncRef] from the input.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "TYPE_CONVERT" value= "51" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Convert between types.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "TYPE_OF" value= "52" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "TYPE_EXISTS" value= "53" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Checks if a type is registered in the [ClassDB].
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "TEXT_CHAR" value= "54" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Return a character with the given ascii value.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "TEXT_STR" value= "55" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Convert the input to a string.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "TEXT_PRINT" value= "56" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Print the given string to the output window.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "TEXT_PRINTERR" value= "57" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Print the given string to the standard error output.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "TEXT_PRINTRAW" value= "58" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Print the given string to the standard output, without adding a newline.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "VAR_TO_STR" value= "59" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Serialize a [Variant] to a string.
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "STR_TO_VAR" value= "60" enum= "BuiltinFunc" >
2019-06-27 12:34:26 +02:00
Deserialize a [Variant] from a string serialized using [constant VAR_TO_STR].
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "VAR_TO_BYTES" value= "61" enum= "BuiltinFunc" >
2017-09-28 12:07:20 +02:00
Serialize a [Variant] to a [PoolByteArray].
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "BYTES_TO_VAR" value= "62" enum= "BuiltinFunc" >
2019-06-27 12:34:26 +02:00
Deserialize a [Variant] from a [PoolByteArray] serialized using [constant VAR_TO_BYTES].
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "COLORN" value= "63" enum= "BuiltinFunc" >
2019-06-22 01:04:47 +02:00
Return the [Color] with the given name and alpha ranging from 0 to 1
[b]Note:[/b] Names are defined in [code]color_names.inc[/code].
2017-09-16 01:46:14 +02:00
</constant>
2019-04-07 23:40:56 +02:00
<constant name= "MATH_SMOOTHSTEP" value= "64" enum= "BuiltinFunc" >
2019-06-27 12:34:26 +02:00
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:
2019-03-19 12:39:43 +01:00
[codeblock]
var t = clamp((weight - from) / (to - from), 0.0, 1.0)
return t * t * (3.0 - 2.0 * t)
[/codeblock]
2019-07-22 12:24:14 +02:00
</constant>
2019-07-14 06:30:45 +02:00
<constant name= "MATH_POSMOD" value= "65" enum= "BuiltinFunc" >
2019-03-19 12:39:43 +01:00
</constant>
2019-07-14 06:30:45 +02:00
<constant name= "MATH_LERP_ANGLE" value= "66" enum= "BuiltinFunc" >
</constant>
<constant name= "FUNC_MAX" value= "67" enum= "BuiltinFunc" >
2019-06-27 11:10:53 +02:00
Represents the size of the [enum BuiltinFunc] enum.
2017-09-16 01:46:14 +02:00
</constant>
2017-09-12 22:42:36 +02:00
</constants>
</class>