:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/modules/visual_script/doc_classes/VisualScriptBuiltinFunc.xml. .. _class_VisualScriptBuiltinFunc: VisualScriptBuiltinFunc ======================= **Inherits:** :ref:`VisualScriptNode` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` A Visual Script node used to call built-in functions. .. rst-class:: classref-introduction-group Description ----------- A built-in function used inside a :ref:`VisualScript`. It is usually a math function or an utility function. See also :ref:`@GDScript`, for the same functions in the GDScript language. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +--------------------------------------------------------------+------------------------------------------------------------------+-------+ | :ref:`BuiltinFunc` | :ref:`function` | ``0`` | +--------------------------------------------------------------+------------------------------------------------------------------+-------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_VisualScriptBuiltinFunc_BuiltinFunc: .. rst-class:: classref-enumeration enum **BuiltinFunc**: .. _class_VisualScriptBuiltinFunc_constant_MATH_SIN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_SIN** = ``0`` Return the sine of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_COS: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_COS** = ``1`` Return the cosine of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_TAN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_TAN** = ``2`` Return the tangent of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_SINH: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_SINH** = ``3`` Return the hyperbolic sine of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_COSH: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_COSH** = ``4`` Return the hyperbolic cosine of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_TANH: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_TANH** = ``5`` Return the hyperbolic tangent of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_ASIN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_ASIN** = ``6`` Return the arc sine of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_ACOS: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_ACOS** = ``7`` Return the arc cosine of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_ATAN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_ATAN** = ``8`` Return the arc tangent of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_ATAN2: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_ATAN2** = ``9`` Return the arc tangent of the input, using the signs of both parameters to determine the exact angle. .. _class_VisualScriptBuiltinFunc_constant_MATH_SQRT: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_SQRT** = ``10`` Return the square root of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_FMOD: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_FMOD** = ``11`` Return the remainder of one input divided by the other, using floating-point numbers. .. _class_VisualScriptBuiltinFunc_constant_MATH_FPOSMOD: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_FPOSMOD** = ``12`` Return the positive remainder of one input divided by the other, using floating-point numbers. .. _class_VisualScriptBuiltinFunc_constant_MATH_FLOOR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_FLOOR** = ``13`` Return the input rounded down. .. _class_VisualScriptBuiltinFunc_constant_MATH_CEIL: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_CEIL** = ``14`` Return the input rounded up. .. _class_VisualScriptBuiltinFunc_constant_MATH_ROUND: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_ROUND** = ``15`` Return the input rounded to the nearest integer. .. _class_VisualScriptBuiltinFunc_constant_MATH_ABS: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_ABS** = ``16`` Return the absolute value of the input. .. _class_VisualScriptBuiltinFunc_constant_MATH_SIGN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_SIGN** = ``17`` Return the sign of the input, turning it into 1, -1, or 0. Useful to determine if the input is positive or negative. .. _class_VisualScriptBuiltinFunc_constant_MATH_POW: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_POW** = ``18`` Return the input raised to a given power. .. _class_VisualScriptBuiltinFunc_constant_MATH_LOG: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_LOG** = ``19`` Return the natural logarithm of the input. Note that this is not the typical base-10 logarithm function calculators use. .. _class_VisualScriptBuiltinFunc_constant_MATH_EXP: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_EXP** = ``20`` Return the mathematical constant **e** raised to the specified power of the input. **e** has an approximate value of 2.71828. .. _class_VisualScriptBuiltinFunc_constant_MATH_ISNAN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_ISNAN** = ``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. .. _class_VisualScriptBuiltinFunc_constant_MATH_ISINF: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_ISINF** = ``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. .. _class_VisualScriptBuiltinFunc_constant_MATH_EASE: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_EASE** = ``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. .. _class_VisualScriptBuiltinFunc_constant_MATH_DECIMALS: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_DECIMALS** = ``24`` Return the number of digit places after the decimal that the first non-zero digit occurs. .. _class_VisualScriptBuiltinFunc_constant_MATH_STEPIFY: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_STEPIFY** = ``25`` Return the input snapped to a given step. .. _class_VisualScriptBuiltinFunc_constant_MATH_LERP: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_LERP** = ``26`` Return a number linearly interpolated between the first two inputs, based on the third input. Uses the formula ``a + (a - b) * t``. .. _class_VisualScriptBuiltinFunc_constant_MATH_INVERSE_LERP: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_INVERSE_LERP** = ``27`` .. _class_VisualScriptBuiltinFunc_constant_MATH_RANGE_LERP: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_RANGE_LERP** = ``28`` .. _class_VisualScriptBuiltinFunc_constant_MATH_MOVE_TOWARD: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_MOVE_TOWARD** = ``29`` Moves the number toward a value, based on the third input. .. _class_VisualScriptBuiltinFunc_constant_MATH_DECTIME: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_DECTIME** = ``30`` Return the result of ``value`` decreased by ``step`` \* ``amount``. .. _class_VisualScriptBuiltinFunc_constant_MATH_RANDOMIZE: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_RANDOMIZE** = ``31`` Randomize the seed (or the internal state) of the random number generator. Current implementation reseeds using a number based on time. .. _class_VisualScriptBuiltinFunc_constant_MATH_RAND: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_RAND** = ``32`` 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. .. _class_VisualScriptBuiltinFunc_constant_MATH_RANDF: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_RANDF** = ``33`` 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. .. _class_VisualScriptBuiltinFunc_constant_MATH_RANDOM: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_RANDOM** = ``34`` Return a random floating-point value between the two inputs. .. _class_VisualScriptBuiltinFunc_constant_MATH_SEED: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_SEED** = ``35`` Set the seed for the random number generator. .. _class_VisualScriptBuiltinFunc_constant_MATH_RANDSEED: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_RANDSEED** = ``36`` Return a random value from the given seed, along with the new seed. .. _class_VisualScriptBuiltinFunc_constant_MATH_DEG2RAD: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_DEG2RAD** = ``37`` Convert the input from degrees to radians. .. _class_VisualScriptBuiltinFunc_constant_MATH_RAD2DEG: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_RAD2DEG** = ``38`` Convert the input from radians to degrees. .. _class_VisualScriptBuiltinFunc_constant_MATH_LINEAR2DB: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_LINEAR2DB** = ``39`` Convert the input from linear volume to decibel volume. .. _class_VisualScriptBuiltinFunc_constant_MATH_DB2LINEAR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_DB2LINEAR** = ``40`` Convert the input from decibel volume to linear volume. .. _class_VisualScriptBuiltinFunc_constant_MATH_POLAR2CARTESIAN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_POLAR2CARTESIAN** = ``41`` Converts a 2D point expressed in the polar coordinate system (a distance from the origin ``r`` and an angle ``th``) to the cartesian coordinate system (X and Y axis). .. _class_VisualScriptBuiltinFunc_constant_MATH_CARTESIAN2POLAR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_CARTESIAN2POLAR** = ``42`` 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). .. _class_VisualScriptBuiltinFunc_constant_MATH_WRAP: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_WRAP** = ``43`` .. _class_VisualScriptBuiltinFunc_constant_MATH_WRAPF: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_WRAPF** = ``44`` .. _class_VisualScriptBuiltinFunc_constant_LOGIC_MAX: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **LOGIC_MAX** = ``45`` Return the greater of the two numbers, also known as their maximum. .. _class_VisualScriptBuiltinFunc_constant_LOGIC_MIN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **LOGIC_MIN** = ``46`` Return the lesser of the two numbers, also known as their minimum. .. _class_VisualScriptBuiltinFunc_constant_LOGIC_CLAMP: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **LOGIC_CLAMP** = ``47`` Return the input clamped inside the given range, ensuring the result is never outside it. Equivalent to ``min(max(input, range_low), range_high)``. .. _class_VisualScriptBuiltinFunc_constant_LOGIC_NEAREST_PO2: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **LOGIC_NEAREST_PO2** = ``48`` Return the nearest power of 2 to the input. .. _class_VisualScriptBuiltinFunc_constant_OBJ_WEAKREF: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **OBJ_WEAKREF** = ``49`` Create a :ref:`WeakRef` from the input. .. _class_VisualScriptBuiltinFunc_constant_FUNC_FUNCREF: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **FUNC_FUNCREF** = ``50`` Create a :ref:`FuncRef` from the input. .. _class_VisualScriptBuiltinFunc_constant_TYPE_CONVERT: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TYPE_CONVERT** = ``51`` Convert between types. .. _class_VisualScriptBuiltinFunc_constant_TYPE_OF: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TYPE_OF** = ``52`` Return the type of the input as an integer. Check :ref:`Variant.Type` for the integers that might be returned. .. _class_VisualScriptBuiltinFunc_constant_TYPE_EXISTS: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TYPE_EXISTS** = ``53`` Checks if a type is registered in the :ref:`ClassDB`. .. _class_VisualScriptBuiltinFunc_constant_TEXT_CHAR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TEXT_CHAR** = ``54`` Return a character with the given ascii value. .. _class_VisualScriptBuiltinFunc_constant_TEXT_STR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TEXT_STR** = ``55`` Convert the input to a string. .. _class_VisualScriptBuiltinFunc_constant_TEXT_PRINT: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TEXT_PRINT** = ``56`` Print the given string to the output window. .. _class_VisualScriptBuiltinFunc_constant_TEXT_PRINTERR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TEXT_PRINTERR** = ``57`` Print the given string to the standard error output. .. _class_VisualScriptBuiltinFunc_constant_TEXT_PRINTRAW: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TEXT_PRINTRAW** = ``58`` Print the given string to the standard output, without adding a newline. .. _class_VisualScriptBuiltinFunc_constant_VAR_TO_STR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **VAR_TO_STR** = ``59`` Serialize a :ref:`Variant` to a string. .. _class_VisualScriptBuiltinFunc_constant_STR_TO_VAR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **STR_TO_VAR** = ``60`` Deserialize a :ref:`Variant` from a string serialized using :ref:`VAR_TO_STR`. .. _class_VisualScriptBuiltinFunc_constant_VAR_TO_BYTES: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **VAR_TO_BYTES** = ``61`` Serialize a :ref:`Variant` to a :ref:`PoolByteArray`. .. _class_VisualScriptBuiltinFunc_constant_BYTES_TO_VAR: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **BYTES_TO_VAR** = ``62`` Deserialize a :ref:`Variant` from a :ref:`PoolByteArray` serialized using :ref:`VAR_TO_BYTES`. .. _class_VisualScriptBuiltinFunc_constant_COLORN: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **COLORN** = ``63`` Return the :ref:`Color` with the given name and alpha ranging from 0 to 1. \ **Note:** Names are defined in ``color_names.inc``. .. _class_VisualScriptBuiltinFunc_constant_MATH_SMOOTHSTEP: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_SMOOTHSTEP** = ``64`` Return a number smoothly interpolated between the first two inputs, based on the third input. Similar to :ref:`MATH_LERP`, but interpolates faster at the beginning and slower at the end. Using Hermite interpolation formula: :: var t = clamp((weight - from) / (to - from), 0.0, 1.0) return t * t * (3.0 - 2.0 * t) .. _class_VisualScriptBuiltinFunc_constant_MATH_POSMOD: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_POSMOD** = ``65`` .. _class_VisualScriptBuiltinFunc_constant_MATH_LERP_ANGLE: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **MATH_LERP_ANGLE** = ``66`` .. _class_VisualScriptBuiltinFunc_constant_TEXT_ORD: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **TEXT_ORD** = ``67`` .. _class_VisualScriptBuiltinFunc_constant_FUNC_MAX: .. rst-class:: classref-enumeration-constant :ref:`BuiltinFunc` **FUNC_MAX** = ``68`` Represents the size of the :ref:`BuiltinFunc` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_VisualScriptBuiltinFunc_property_function: .. rst-class:: classref-property :ref:`BuiltinFunc` **function** = ``0`` .. rst-class:: classref-property-setget - void **set_func** **(** :ref:`BuiltinFunc` value **)** - :ref:`BuiltinFunc` **get_func** **(** **)** The function to be executed. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`