Skip to content
Moritz Brückner edited this page Feb 2, 2023 · 21 revisions

Logic Nodes Reference: Values nodes

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.2.


Node Categories

Array

Array Add

Adds the given value to the given array.

Array Add node

Inputs:

  • Array: the array to manipulate.
  • Modify Original: if false, the input array is copied before adding the value.
  • Unique Values: if true, values may occur only once in that array (only primitive data types are supported).

Sources: Python | Haxe

Array Boolean

Stores an array of boolean elements as a variable.

Array Boolean node

Sources: Python | Haxe

Array Color

Stores an array of color elements as a variable.

Array Color node

Sources: Python | Haxe

Array Concat

Join arrays.

Array Concat node

Sources: Python | Haxe

Array Contains

Returns whether the given array contains the given value.

Array Contains node

Sources: Python | Haxe

Array Dynamic

Stores the given array as a variable.

Array Dynamic node

Sources: Python | Haxe

Array Float

Stores an array of float elements as a variable.

Array Float node

Sources: Python | Haxe

Array Get

Returns the value of the given array at the given index.

Array Get node

Sources: Python | Haxe

Array Get Next

Returns the next value to be retrieve by looping the array.

Array Get Next node

Sources: Python | Haxe

Array Index

Returns the array index of the given value.

Array Index node

Sources: Python | Haxe

Array Integer

Stores an array of integer elements as a variable.

Array Integer node

Sources: Python | Haxe

Array Length

Returns the length of the given array.

Array Length node

Sources: Python | Haxe

Array Loop

Loops through each item of the given array.

Array Loop node

Sources: Python | Haxe

Array Object

Stores an array of object elements as a variable.

Array Object node

Sources: Python | Haxe

Array Pop

Removes the last element of the given array.

See also:

Array Pop node

Sources: Python | Haxe

Array Remove by Index

Removes the element from the given array by its index.

See also:

Array Remove by Index node

Sources: Python | Haxe

Array Remove by Value

Removes the element from the given array by its value.

See also:

Array Remove by Value node

Sources: Python | Haxe

Array Resize

Resize the array to the given length. For more details, please take a look at the documentation of Array.resize() in the Haxe API.

Array Resize node

Sources: Python | Haxe

Array Reverse

Reverse the items order of the array.

Array Reverse node

Sources: Python | Haxe

Array Sample

Take a sample of n items from an array (boolean option to remove those items from original array)

Array Sample node

Sources: Python | Haxe

Array Set

Sets the value of the given array at the given index.

Array Set node

Sources: Python | Haxe

Array Shift

Removes the first element of the given array.

See also:

Array Shift node

Sources: Python | Haxe

Array Shuffle

Shuffle the items in the array and return a new array

Array Shuffle node

Sources: Python | Haxe

Array Slice

Creates a shallow copy of the given array in the specified range.

See also:

Array Slice node

Sources: Python | Haxe

Array Sort

Sort the items order of the array by ascending or descending.

Array Sort node

Sources: Python | Haxe

Array Splice

Removes the given amount of elements from the given array.

See also:

Array Splice node

Sources: Python | Haxe

Array String

Stores an array of string elements as a variable.

Array String node

Sources: Python | Haxe

Array Vector

Stores an array of vector elements as a variable.

Array Vector node

Sources: Python | Haxe

Math

Bitwise Math

Perform bitwise math on integer values.

Bitwise Math node

Sources: Python | Haxe

Clamp

Keeps the value inside the given bound.

See also:

Clamp node

Sources: Python | Haxe

Combine HSVA

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

Combine HSVA node

Sources: Python | Haxe

Combine RGBA

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.

Combine RGBA node

Sources: Python | Haxe

Compare

Compares values.

Compare node

Sources: Python | Haxe

Deg to Rad

Converts degrees to radians.

Deg to Rad node

Sources: Python | Haxe

Float Delta Interpolate

Linearly interpolate to a new value with specified interpolation Rate.

Float Delta Interpolate node

Inputs:

  • From: Value to interpolate from.
  • To: Value to interpolate to.
  • Delta Time: Delta Time.
  • Rate: Rate of interpolation.

Sources: Python | Haxe

Key Interpolate Node

Linearly interpolate to 1.0 if input is true and interpolate to 0.0 if input is false.

Key Interpolate Node node

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.

Sources: Python | Haxe

Map Range

Converts the given value from a range to another range.

See also:

Map Range node

Sources: Python | Haxe

Math

Mathematical operations on values.

Math node

Sources: Python | Haxe

Math Expression

Mathematical operations on values.

Math Expression node

Sources: Python | Haxe

Matrix Math

Multiplies matrices.

Matrix Math node

Sources: Python | Haxe

Mix

Interpolates between the two given values.

Mix node

Sources: Python | Haxe

Mix Vector

Interpolates between the two given vectors.

Mix Vector node

Sources: Python | Haxe

Quaternion Math

Mathematical operations on quaternions.

Quaternion Math node

Sources: Python | Haxe

Rad to Deg

Converts radians to degrees.

Rad to Deg node

Sources: Python | Haxe

Rotation Math

Mathematical operations on rotations.

Rotation Math node

Sources: Python | Haxe

Screen to World Space

Transforms the given screen coordinates into world coordinates.

Screen to World Space node

Sources: Python | Haxe

Separate HSVA

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

Separate HSVA node

Sources: Python | Haxe

Separate Quaternion (do not use: quaternions sockets have been

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.

Separate Quaternion (do not use: quaternions sockets have been  node

Sources: Python | Haxe

Separate RGBA

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.

Separate RGBA node

Sources: Python | Haxe

Separate XYZ

Splits the given vector into X, Y and Z.

Separate XYZ node

Sources: Python | Haxe

Tween Float

Tween a float value.

Tween Float node

Inputs:

  • Start: Start tweening
  • Stop: Stop a tweening. tweening can be re-started via the Startinput
  • From: Tween start value
  • To: Tween final value
  • Duration: Duartion of the tween in seconds

Outputs:

  • Out: Executed immidiately after Start or Stop is 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

Sources: Python | Haxe

Tween Rotation

Tween rotation.

Tween Rotation node

Inputs:

  • Start: Start tweening
  • Stop: Stop a tweening. tweening can be re-started via the Startinput
  • From: Tween start value
  • To: Tween final value
  • Duration: Duartion of the tween in seconds

Outputs:

  • Out: Executed immidiately after Start or Stop is 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

Sources: Python | Haxe

Tween Transform

Tween Transform.

Tween Transform node

Inputs:

  • Start: Start tweening
  • Stop: Stop a tweening. tweening can be re-started via the Startinput
  • From: Tween start value
  • To: Tween final value
  • Duration: Duartion of the tween in seconds

Outputs:

  • Out: Executed immidiately after Start or Stop is 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

Sources: Python | Haxe

Tween Vector

Tween a vector value.

Tween Vector node

Inputs:

  • Start: Start tweening
  • Stop: Stop a tweening. tweening can be re-started via the Startinput
  • From: Tween start value
  • To: Tween final value
  • Duration: Duartion of the tween in seconds

Outputs:

  • Out: Executed immidiately after Start or Stop is 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

Sources: Python | Haxe

Vector Clamp

Keeps the vector value inside the given range.

Vector Clamp node

Sources: Python | Haxe

Vector Math

Mathematical operations on vectors.

Vector Math node

Sources: Python | Haxe

World to Screen Space

Transforms the given world coordinates into screen coordinates.

World to Screen Space node

Sources: Python | Haxe

Random

Random Boolean

Generates a random boolean.

Random Boolean node

Sources: Python | Haxe

Random Choice

Choose a random value from a given array.

Random Choice node

Sources: Python | Haxe

Random Color

Generates a random color.

Random Color node

Sources: Python | Haxe

Random Float

Generates a random float.

Random Float node

Sources: Python | Haxe

Random Integer

Generates a random integer.

Random Integer node

Sources: Python | Haxe

Random Output

Activate a random output when the input is activated.

Random Output node

Sources: Python | Haxe

Random String

Generate a random string based on a provided characters list.

Random String node

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 provide aaab as a character string, approximately 75% percent of the characters in all generated strings are a, the remaining 25% are b.

Sources: Python | Haxe

Random Vector

Generates a random vector.

Random Vector node

Sources: Python | Haxe

String

Concatenate String

Concatenates the given string.

Concatenate String node

Sources: Python | Haxe

Parse Float

Returns the floats that are in the given string.

Parse Float node

Sources: Python | Haxe

Parse Int

Returns the Ints that are in the given string.

Parse Int node

Sources: Python | Haxe

Split String

Splits the given string.

Split String node

Sources: Python | Haxe

String

Stores the given string as a variable.

String node

Sources: Python | Haxe

String Case

Changes the given string case.

String Case node

Sources: Python | Haxe

String Contains

Returns whether the given string contains a given part.

String Contains node

Sources: Python | Haxe

String Length

Returns the length of the given string.

String Length node

Sources: Python | Haxe

String Replace

Replace all ocurrences of string to find in the input String

String Replace node

Sources: Python | Haxe

Sub String

Returns a part of the given string.

Sub String node

Sources: Python | Haxe

Variable

Boolean

Stores the given boolean as a variable. A boolean value has just two states: true and false.

Boolean node

Sources: Python | Haxe

Color

Stores the given color as a variable.

Color node

Sources: Python | Haxe

Dynamic

Stores the given dynamic value (a value with an arbitrary type) as a variable.

Dynamic node

Sources: Python | Haxe

Float

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.

Float node

Sources: Python | Haxe

Integer

Stores the given integer (a whole number) as a variable.

Integer node

Sources: Python | Haxe

Mask

TO DO.

Mask node

Sources: Python | Haxe

Quaternion (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Do not use quaternion sockets.

TO DO.

Quaternion (Deprecated) node

Sources: Python | Haxe

Retain Value

Retains the input value.

Retain Value node

Inputs:

  • Retain: Retains the value when exeuted.
  • Value: The value that should be retained.

Sources: Python | Haxe

Rotation

A rotation, created from one of its possible mathematical representations

Rotation node

Sources: Python | Haxe

Scene

Stores the given scene as a variable.

Scene node

Sources: Python | Haxe

Set Variable

Sets the value of the given variable.

Set Variable node

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.

Sources: Python | Haxe

Transform

Stores the location, rotation and scale values as a transform.

Transform node

Sources: Python | Haxe

Vector

Stores the given 3D vector as a variable.

Vector node

Sources: Python | Haxe

Clone this wiki locally