2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "VisualScriptBuiltinFunc" inherits= "VisualScriptNode" category= "Core" version= "3.0.alpha.custom_build" >
<brief_description >
2017-09-28 10:07:20 +00:00
A Visual Script node used to call built-in functions.
2017-09-12 20:42:36 +00:00
</brief_description>
<description >
2017-09-28 10:07:20 +00: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 20:42:36 +00:00
</description>
<tutorials >
</tutorials>
<demos >
</demos>
<methods >
<method name= "get_func" >
<return type= "int" enum= "VisualScriptBuiltinFunc.BuiltinFunc" >
</return>
<description >
</description>
</method>
<method name= "set_func" >
<return type= "void" >
</return>
<argument index= "0" name= "which" type= "int" enum= "VisualScriptBuiltinFunc.BuiltinFunc" >
</argument>
<description >
</description>
</method>
</methods>
<members >
2017-09-13 06:49:40 +00:00
<member name= "function" type= "int" setter= "set_func" getter= "get_func" enum= "VisualScriptBuiltinFunc.BuiltinFunc" >
2017-09-28 10:07:20 +00:00
The function to be executed.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants >
2017-09-15 23:46:14 +00:00
<constant name= "MATH_SIN" value= "0" >
2017-09-28 10:07:20 +00:00
Return the sine of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_COS" value= "1" >
2017-09-28 10:07:20 +00:00
Return the cosine of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_TAN" value= "2" >
2017-09-28 10:07:20 +00:00
Return the tangent of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_SINH" value= "3" >
2017-09-28 10:07:20 +00:00
Return the hyperbolic sine of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_COSH" value= "4" >
2017-09-28 10:07:20 +00:00
Return the hyperbolic cosine of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_TANH" value= "5" >
2017-09-28 10:07:20 +00:00
Return the hyperbolic tangent of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_ASIN" value= "6" >
2017-09-28 10:07:20 +00:00
Return the arc sine of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_ACOS" value= "7" >
2017-09-28 10:07:20 +00:00
Return the arc cosine of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_ATAN" value= "8" >
2017-09-28 10:07:20 +00:00
Return the arc tangent of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_ATAN2" value= "9" >
2017-09-28 10:07:20 +00:00
Return the arc tangent of the input, using the signs of both parameters to determine the exact angle.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_SQRT" value= "10" >
2017-09-28 10:07:20 +00:00
Return the square root of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_FMOD" value= "11" >
2017-09-28 10:07:20 +00:00
Return the remainder of one input divided by the other, using floating-point numbers.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_FPOSMOD" value= "12" >
2017-09-28 10:07:20 +00:00
Return the positive remainder of one input divided by the other, using floating-point numbers.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_FLOOR" value= "13" >
2017-09-28 10:07:20 +00:00
Return the input rounded down.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_CEIL" value= "14" >
2017-09-28 10:07:20 +00:00
Return the input rounded up.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_ROUND" value= "15" >
2017-09-28 10:07:20 +00:00
Return the input rounded to the nearest integer.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_ABS" value= "16" >
2017-09-28 10:07:20 +00:00
Return the absolute value of the input.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_SIGN" value= "17" >
2017-09-28 10:07:20 +00: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-15 23:46:14 +00:00
</constant>
<constant name= "MATH_POW" value= "18" >
2017-09-28 10:07:20 +00:00
Return the input raised to a given power.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_LOG" value= "19" >
2017-09-28 10:07:20 +00:00
Return the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_EXP" value= "20" >
2017-09-28 10:07:20 +00:00
Return [b]e[/b] raised to the power of the input. [b]e[/b] sometimes called "Euler's number" is a mathematical constant whose value is approximately 2.71828.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_ISNAN" value= "21" >
2017-09-28 10:07:20 +00: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-15 23:46:14 +00:00
</constant>
<constant name= "MATH_ISINF" value= "22" >
2017-09-28 10:07:20 +00: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-15 23:46:14 +00:00
</constant>
<constant name= "MATH_EASE" value= "23" >
2017-09-28 10:07:20 +00: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-15 23:46:14 +00:00
</constant>
<constant name= "MATH_DECIMALS" value= "24" >
2017-09-28 10:07:20 +00:00
Return the number of digit places after the decimal that the first non-zero digit occurs.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_STEPIFY" value= "25" >
2017-09-28 10:07:20 +00:00
Return the input snapped to a given step.
2017-09-15 23:46:14 +00:00
</constant>
<constant name= "MATH_LERP" value= "26" >
2017-09-28 10:07:20 +00: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-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_INVERSE_LERP" value= "27" >
</constant>
<constant name= "MATH_RANGE_LERP" value= "28" >
</constant>
<constant name= "MATH_DECTIME" value= "29" >
2017-09-28 10:07:20 +00:00
Return the result of 'value' decreased by 'step' * 'amount'.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_RANDOMIZE" value= "30" >
2017-09-28 10:07:20 +00:00
Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_RAND" value= "31" >
2017-09-28 10:07:20 +00: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-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_RANDF" value= "32" >
2017-09-28 10:07:20 +00: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-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_RANDOM" value= "33" >
2017-09-28 10:07:20 +00:00
Return a random floating-point value between the two inputs.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_SEED" value= "34" >
2017-09-28 10:07:20 +00:00
Set the seed for the random number generator.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_RANDSEED" value= "35" >
2017-09-28 10:07:20 +00:00
Return a random value from the given seed, along with the new seed.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_DEG2RAD" value= "36" >
2017-09-28 10:07:20 +00:00
Convert the input from degrees to radians.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_RAD2DEG" value= "37" >
2017-09-28 10:07:20 +00:00
Convert the input from radians to degrees.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_LINEAR2DB" value= "38" >
2017-09-28 10:07:20 +00:00
Convert the input from linear volume to decibel volume.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "MATH_DB2LINEAR" value= "39" >
2017-09-28 10:07:20 +00:00
Convert the input from decibel volume to linear volume.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "LOGIC_MAX" value= "40" >
2017-09-28 10:07:20 +00:00
Return the greater of the two numbers, also known as their maximum.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "LOGIC_MIN" value= "41" >
2017-09-28 10:07:20 +00:00
Return the lesser of the two numbers, also known as their minimum.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "LOGIC_CLAMP" value= "42" >
2017-09-28 10:07:20 +00:00
Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to `min(max(input, range_low), range_high)`
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "LOGIC_NEAREST_PO2" value= "43" >
2017-09-28 10:07:20 +00:00
Return the nearest power of 2 to the input.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "OBJ_WEAKREF" value= "44" >
2017-09-28 10:07:20 +00:00
Create a [WeakRef] from the input.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "FUNC_FUNCREF" value= "45" >
2017-09-28 10:07:20 +00:00
Create a [FuncRef] from the input.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "TYPE_CONVERT" value= "46" >
2017-09-28 10:07:20 +00:00
Convert between types.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "TYPE_OF" value= "47" >
2017-09-28 10:07:20 +00:00
Return the type of the input as an integer. Check [enum Variant.Type] for the integers that might be returned.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "TYPE_EXISTS" value= "48" >
2017-09-28 10:07:20 +00:00
Checks if a type is registered in the [ClassDB].
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "TEXT_CHAR" value= "49" >
2017-09-28 10:07:20 +00:00
Return a character with the given ascii value.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "TEXT_STR" value= "50" >
2017-09-28 10:07:20 +00:00
Convert the input to a string.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "TEXT_PRINT" value= "51" >
2017-09-28 10:07:20 +00:00
Print the given string to the output window.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "TEXT_PRINTERR" value= "52" >
2017-09-28 10:07:20 +00:00
Print the given string to the standard error output.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "TEXT_PRINTRAW" value= "53" >
2017-09-28 10:07:20 +00:00
Print the given string to the standard output, without adding a newline.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "VAR_TO_STR" value= "54" >
2017-09-28 10:07:20 +00:00
Serialize a [Variant] to a string.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "STR_TO_VAR" value= "55" >
2017-09-28 10:07:20 +00:00
Deserialize a [Variant] from a string serialized using [VAR_TO_STR].
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "VAR_TO_BYTES" value= "56" >
2017-09-28 10:07:20 +00:00
Serialize a [Variant] to a [PoolByteArray].
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "BYTES_TO_VAR" value= "57" >
2017-09-28 10:07:20 +00:00
Deserialize a [Variant] from a [PoolByteArray] serialized using [VAR_TO_BYTES].
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "COLORN" value= "58" >
2017-09-28 10:07:20 +00:00
Return the [Color] with the given name and alpha ranging from 0 to 1. Note: names are defined in color_names.inc.
2017-09-15 23:46:14 +00:00
</constant>
2017-10-21 10:02:08 +00:00
<constant name= "FUNC_MAX" value= "59" >
2017-09-28 10:07:20 +00:00
The maximum value the [member function] property can have.
2017-09-15 23:46:14 +00:00
</constant>
2017-09-12 20:42:36 +00:00
</constants>
</class>