reference_values
This reference was generated automatically. Please do not edit the page directly, instead change the docstrings of the nodes in their Python files or the generator script and open a pull request. Thank you for contributing!
This reference was built for Armory 2023.11.
- Basic
- Data
- Motion
- Values
- Graphics
- Sound
- Misc
Adds the given value to the given array.
Inputs:
-
Array: the array to manipulate. -
Modify Original: iffalse, the input array is copied before adding the value. -
Unique Values: iftrue, values may occur only once in that array (only primitive data types are supported).
Stores an array of boolean elements as a variable.
Stores an array of color elements as a variable.
Compare arrays.
Join arrays.
Returns whether the given array contains the given value.
Returns an array with the item counts of the given array.
Returns the length of the given array.
Returns the Distinct and Duplicated items of the given array.
Stores the given array as a variable.
Returns the length of the given array.
Stores an array of float elements as a variable.
Returns the value of the given array at the given index.
Returns the next value to be retrieve by looping the array.
Returns the previous or next value to be retrieve by looping the array according to the boolean condition.
Returns the array index of the given value.
Stores an array of integer elements as a variable.
Returns the length of the given array.
Loops through each item of the given array.
Stores an array of object elements as a variable.
Removes the last element of the given array.
See also:
Removes the element from the given array by its index.
See also:
Removes the element from the given array by its value.
See also:
Resize the array to the given length. For more details, please take a look at the documentation of Array.resize() in the Haxe API.
Reverse the items order of the array.
Take a sample of n items from an array (boolean option to remove those items from original array)
Sets the value of the given array at the given index.
Removes the first element of the given array.
See also:
Shuffle the items in the array and return a new array
Creates a shallow copy of the given array in the specified range.
See also:
Sort the items order of the array by ascending or descending.
Removes the given amount of elements from the given array.
See also:
Stores an array of string elements as a variable.
Stores an array of vector elements as a variable.
Clear Map
Create Map
Get Map Value
Map Key Exists
Map Loop
Remove Map Key
Set Map Value
Perform bitwise math on integer values.
Keeps the value inside the given bound.
See also:
Combines the given HSVA() components to a color value. If any input is null, the respective channel of the output color is set to 0.0. formula from // https://stackoverflow.com/a/17243070
Combines the given RGBA (red, green, blue, and alpha) components to a color value. If any input is null, the respective channel of the output color is set to 0.0.
Compares values.
Converts degrees to radians.
Linearly interpolate to a new value with specified interpolation Rate.
Inputs:
-
From: Value to interpolate from. -
To: Value to interpolate to. -
Delta Time: Delta Time. -
Rate: Rate of interpolation.
Linearly interpolate to 1.0 if input is true and interpolate to 0.0 if input is false.
Inputs:
-
Key State: Interpolate to 1.0 if true and 0.0 if false. -
Init: Initial value in the range 0.0 to 1.0. -
Rate: Rate of interpolation.
Converts the given value from a range to another range.
See also:
Mathematical operations on values.
Mathematical operations on values.
Formula for symbolic Math
Multiplies matrices.
Interpolates between the two given values.
Interpolates between the two given vectors.
Mathematical operations on quaternions.
Converts radians to degrees.
Mathematical operations on rotations.
Transforms the given screen coordinates into world coordinates.
Splits the given color into its HSVA components (hue, saturation, value, and alpha). If the input color is null, the outputs are each set to 0.0. formula from: https://axonflux.com/handy-rgb-to-hsl-and-rgb-to-hsv-color-model-c
DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Do not use quaternion sockets.
Splits the given quaternion into X, Y, Z and W.
Splits the given color into its RGBA components (red, green, blue, and alpha). If the input color is null, the outputs are each set to 0.0.
Splits the given vector into X, Y and Z.
Tween a float value.
Inputs:
-
Start: Start tweening -
Stop: Stop a tweening. tweening can be re-started via theStartinput -
From: Tween start value -
To: Tween final value -
Duration: Duartion of the tween in seconds
Outputs:
-
Out: Executed immidiately afterStartorStopis called -
Tick: Executed at every time step in the tween duration -
Done: Executed when tween is successfully completed. Not executed if tweening is stopped mid-way -
Value: Current tween value
Tween rotation.
Inputs:
-
Start: Start tweening -
Stop: Stop a tweening. tweening can be re-started via theStartinput -
From: Tween start value -
To: Tween final value -
Duration: Duartion of the tween in seconds
Outputs:
-
Out: Executed immidiately afterStartorStopis called -
Tick: Executed at every time step in the tween duration -
Done: Executed when tween is successfully completed. Not executed if tweening is stopped mid-way -
Value: Current tween value
Tween Transform.
Inputs:
-
Start: Start tweening -
Stop: Stop a tweening. tweening can be re-started via theStartinput -
From: Tween start value -
To: Tween final value -
Duration: Duartion of the tween in seconds
Outputs:
-
Out: Executed immidiately afterStartorStopis called -
Tick: Executed at every time step in the tween duration -
Done: Executed when tween is successfully completed. Not executed if tweening is stopped mid-way -
Value: Current tween value
Tween a vector value.
Inputs:
-
Start: Start tweening -
Stop: Stop a tweening. tweening can be re-started via theStartinput -
From: Tween start value -
To: Tween final value -
Duration: Duartion of the tween in seconds
Outputs:
-
Out: Executed immidiately afterStartorStopis called -
Tick: Executed at every time step in the tween duration -
Done: Executed when tween is successfully completed. Not executed if tweening is stopped mid-way -
Value: Current tween value
Clamp the vector's value inside the given range and return the result as a new vector.
Options:
-
Clamping Mode: Whether to clamp the length of the vector or the value of each individual component.
Mathematical operations on vectors.
Add a constant value to the given vector until it reach the target vector.
Transforms the given world coordinates into screen coordinates, using the active camera or a selected camera.
Generates a random boolean.
Choose a random value from a given array.
Generates a random color.
Generates a random float.
Generates a random integer.
Activate a random output when the input is activated.
Generate a random string based on a provided characters list.
Inputs:
-
Length: The length of the string to generate. If the length is 0 or negative, an empty string is returned. -
Characters: A string containing the characters from which the random generator can choose. For each letter in the output, the generator randomly samples a character in the input string, so the more often a character occurs in the input, the higher is its chance of appearance in each letter of the result. For example, if you provideaaabas a character string, approximately 75% percent of the characters in all generated strings area, the remaining 25% areb.
Generates a random vector.
Concatenates the given string.
Returns the floats that are in the given string.
Returns the Ints that are in the given string.
Splits the given string.
Stores the given string as a variable.
Changes the given string case.
Returns whether the given string contains a given part.
Returns the length of the given string.
Replace all ocurrences of string to find in the input String
Returns a part of the given string.
Stores the given boolean as a variable. A boolean value has just two states: true and false.
Stores the given color as a variable.
Stores the given dynamic value (a value with an arbitrary type) as a variable.
Stores the given float as a variable. If the set float value has more than 3 decimal places, the displayed value in the node will be rounded, but when you click on it you can still edit the exact value which will be used in the game as well.
Stores the given integer (a whole number) as a variable.
TO DO.
DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Do not use quaternion sockets.
TO DO.
Retains the input value.
Inputs:
-
Retain: Retains the value when exeuted. -
Value: The value that should be retained.
A rotation, created from one of its possible mathematical representations
Stores the given scene as a variable.
Sets the value of the given variable.
Inputs:
-
Variable: this socket must be connected to a variable node (recognized by the little dot inside the socket). The value that is stored inside the connected node is changed upon activation. -
Value: the value that should be written into the variable.
Stores the location, rotation and scale values as a transform.
Stores the given 3D vector as a variable.
