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