reference

Logic Nodes Reference

This document was generated automatically. Please do not edit this 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 to this reference!

This reference was built for Armory 2021.3.

---

Node Categories

• Basic
  • Logic
  • Event
  • Input
  • Native
• Data
  • Camera
  • Material
  • Light
  • Object
  • Scene
  • Trait
• Motion
  • Animation
  • Navmesh
  • Transform
  • Physics
• Values
  • Array
  • Math
  • Random
  • String
  • Variable
• Graphics
  • Canvas
  • Postprocess
  • Renderpath
• Sound
  • Sound
• Misc
  • Miscellaneous
  • Layout

Logic

Logic nodes are used to control execution flow using branching, loops, gates etc.

Alternate Output

Activates the outputs 0 and 1 alternating every time it is active.

Sources: Python | Haxe

Branch

Activates its true or false output, according to the state of the plugged-in boolean.

Sources: Python | Haxe

Call Function

Calls the given function that was created by the Function node.

Sources: Python | Haxe

Function

Creates a reusable function that can be called by the Call Function node.

Sources: Python | Haxe

Function Output

Sets the return value for the given function.

See also:

• Function

Sources: Python | Haxe

Gate

Logic nodes way to do "if" statements. When activated, it compares if its two inputs are being Equal, Greater Equal, Less Equal, or Not Equal, regardless of variable type, and passes through its active input to the output that matches the result of the comparison. "And" and "Or" are being used for booleans only, and pass through the input when both booleans are true (And) or at least one (Or).

Sources: Python | Haxe

Invert Boolean

Inverts the plugged-in boolean. If its input is true it outputs false.

Sources: Python | Haxe

Invert Output

Activates the output if the input is not active.

Sources: Python | Haxe

Is False

Passes through its activation only if the plugged-in boolean equals false.

See also:

• Is True

Sources: Python | Haxe

Is Not Null

Passes through its activation only if the plugged-in value is not null.

See also:

• Is Null

Sources: Python | Haxe

Is Null

Passes through its activation only if the plugged-in value is null (no value).

See also:

• Is Not Null

Sources: Python | Haxe

Is True

Passes through its activation only if the plugged-in boolean equals true.

See also:

• Is False

Sources: Python | Haxe

Loop

Resembles a for-loop (for (i in from...to)) that is executed at once when this node is activated.

See also:

• While
• Loop Break

Inputs:

• From: The value to start the loop from (inclusive)
• To: The value to end the loop at (exclusive)

Outputs:

• Loop: Active at every iteration of the loop
• Index: The index for the current iteration
• Done: Activated once when the looping is done

Sources: Python | Haxe

Loop Break

Terminates the currently executing loop (only one loop is executed at once).

See also:

• Loop
• While

Sources: Python | Haxe

Merge

Activates the output when any connected input is activated.

Options:

• New: Add a new input socket.
• X Button: Remove the lowermost input socket.

Sources: Python | Haxe

Null

A null value that can be used in comparisons and conditions.

Sources: Python | Haxe

Output Sequence

Activates the outputs one by one sequentially and repeatedly.

Sources: Python | Haxe

Output to Boolean

Converts a signal to a boolean value. If the input signal is active, the boolean is true; if not, the boolean is false.

Sources: Python | Haxe

Switch Output

Activates the outputs depending of the value. If the "value" is equal to "case 1", the output "case 1" will be activated.

Outputs:

• Default: Activated if the input value does not match any case.

Sources: Python | Haxe

Value Changed

Sends a signal to Changed output whether the connected value is changed and a signal to Unchanged if the connected value returns to initial. Does not works with null value.

Sources: Python | Haxe

While True

Loops while the condition is true.

See also:

• Loop
• Loop Break

Inputs:

• Condition: boolean that resembles the result of the condition

Outputs:

• Loop: Activated on every iteration step
• Done: Activated when the loop is done executing

Sources: Python | Haxe

Event

On Application State

Listens to different application state changes.

Sources: Python | Haxe

On Event

Activates the output when the given event is received.

See also:

• Send Event to Object
• Send Event

Sources: Python | Haxe

On Init

Activates the output on the first frame of execution of the logic tree.

Sources: Python | Haxe

On Timer

Activates the output when a given time elapsed (optionally repeating the timer).

Inputs:

• Duration: the time in seconds after which to activate the output
• Repeat: whether to repeat the timer

Sources: Python | Haxe

On Update

Activates the output on every frame.

Options:

• Update: (default) activates the output every frame.
• Late Update: activates the output after all non-late updates are calculated.
• Physics Pre-Update: activates the output before calculating the physics. Only available when using a physics engine.

Sources: Python | Haxe

Send Event to Object

Sends a event to the given object.

See also:

• Send Event
• On Event

Inputs:

• Event: the identifier of the event
• Object: the receiving object

Sources: Python | Haxe

Send Global Event

Sends the given event to all objects in the scene.

See also:

• Send Event to Object
• On Event

Inputs:

• Event: the identifier of the event

Sources: Python | Haxe

Input

Gamepad

Activates the output on the given gamepad event.

See also:

• Gamepad Coords

Inputs:

• Gamepad: the ID of the gamepad.

Options:

• State: the state of the gamepad button to listen to.
• Button: the gamepad button that should activate the output.

Sources: Python | Haxe

Gamepad Coords

Returns the coordinates of the given gamepad.

See also:

• Gamepad

Inputs:

• Gamepad: the ID of the gamepad.

Sources: Python | Haxe

Get Cursor Location

Returns the mouse cursor location in screen coordinates (pixels).

Sources: Python | Haxe

Get Cursor State

Returns the state of the mouse cursor.

See also:

• Set Cursor State

Outputs:

• Is Hidden Locked: true if the mouse cursor is both hidden and locked.
• Is Hidden: true if the mouse cursor is hidden.
• Is Locked: true if the mouse cursor is locked.

Sources: Python | Haxe

Get Mouse Lock (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Get Cursor State.

Deprecated. It is recommended to use the 'Get Cursor State' node instead.

Sources: Python | Haxe

Get Mouse Movement

Get the movement coordinates of the mouse and the mouse wheel delta. The multiplied output variants default to -1 to invert the values.

Sources: Python | Haxe

Get Mouse Visible (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Get Cursor State.

Deprecated. It is recommended to use the 'Get Cursor State' node instead.

Sources: Python | Haxe

Get Touch Location

Returns the location of the last touch event in screen coordinates (pixels).

Sources: Python | Haxe

Get Touch Movement

Returns the movement values of the current touch event.

Sources: Python | Haxe

Keyboard

Activates the output on the given keyboard button event.

Sources: Python | Haxe

Mouse

Activates the output on the given mouse event.

Sources: Python | Haxe

Mouse Coords (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Get Cursor Location.

Deprecated. It is recommended to use 'Get Cursor Location' node and the 'Get Mouse Movement' node instead.

Sources: Python | Haxe

On Gamepad (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Gamepad.

Deprecated. It is recommended to use the 'Gamepad' node instead.

Sources: Python | Haxe

On Keyboard (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Keyboard.

Deprecated. It is recommended to use the 'Keyboard' node instead.

Sources: Python | Haxe

On Mouse (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Mouse.

Deprecated. It is recommended to use the 'Mouse' node instead.

Sources: Python | Haxe

On Surface (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Surface.

Deprecated. Is recommended to use the 'Surface' node instead.

Sources: Python | Haxe

On Swipe

Activates the output on the given swipe event.

Sources: Python | Haxe

On Tap Screen

Activates the output on tap screen event.

Inputs:

• Duration: touching time
• Interval: interval between taps
• Repeat: repetitions amount to validate

Outputs:

• Done: the sequence success
• Fail: the the sequence failure
• Tap Number: number of the last tap
• Coords: the coordinates of the last tap

Sources: Python | Haxe

On Virtual Button (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Virtual Button.

Deprecated. Is recommended to use 'Virtual Button' node instead.

Sources: Python | Haxe

Sensor Coords

TO DO.

Sources: Python | Haxe

Set Cursor State

Sets the state of the mouse cursor.

See also:

• Get Cursor State

Options:

• Hide Locked: hide and lock or unhide and unlock the mouse cursor.
• Hide: hide/unhide the mouse cursor.
• Lock: lock/unlock the mouse cursor.

Sources: Python | Haxe

Set Mouse Lock (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Cursor State.

Deprecated. It is recommended to use the 'Set Cursor State' node instead.

Sources: Python | Haxe

Set Mouse Visible (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Cursor State.

Deprecated. It is recommended to use the 'Set Cursor State' node instead.

Sources: Python | Haxe

Surface Coords (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Get Touch Movement, Get Touch Location.

Deprecated. Is recommended to use 'Get Touch Location' and 'Get Touch Movement' node instead.

Sources: Python | Haxe

Touch

Activates the output on the given touch event.

Sources: Python | Haxe

Virtual Button

Activates the output on the given virtual button event.

Sources: Python | Haxe

Native

The Native category contains nodes which interact with the system (Input/Output functionality, etc.) or Haxe.

Call Haxe Static

Calls the given static Haxe function.

Inputs:

• Function: the full module path to the function.

Outputs:

• Result: the result of the function.

Sources: Python | Haxe

Detect Mobile Browser

Determines the mobile browser or not (works only for web browsers).

Sources: Python | Haxe

Expression

Evaluates a Haxe expression and returns its output.

Outputs:

• Result: the result of the expression.

Sources: Python | Haxe

Get Haxe Property

Returns a property of an Haxe object (via the Reflection API).

See also:

• Set Haxe Property

Sources: Python | Haxe

Get System Language

Returns the language of the current system.

Sources: Python | Haxe

Get System Name

Returns the name of the current system.

Sources: Python | Haxe

Load URL

Load the given URL in a new tab (works only for web browsers).

Sources: Python | Haxe

Print

Print the given value to the console.

Sources: Python | Haxe

Read File

Returns the content of the given file.

See also:

• Write File

Sources: Python | Haxe

Read JSON

Returns the content of the given JSON file.

See also:

• Write JSON

Sources: Python | Haxe

Read Storage

Reads a stored content.

See also:

• Write Storage

Sources: Python | Haxe

Script

Executes the given script.

Sources: Python | Haxe

Set Haxe Property

Sets a property of an Haxe object (via the Reflection API).

See also:

• Get Haxe Property

Sources: Python | Haxe

Set Vibrate

Pulses the vibration hardware on the device for time in milliseconds, if such hardware exists.

Sources: Python | Haxe

Shutdown

Closes the application.

Sources: Python | Haxe

Write File

Writes the given content in the given file.

See also:

• Read File

Sources: Python | Haxe

Write JSON

Writes the given content in the given JSON file.

See also:

• Read JSON

Sources: Python | Haxe

Write Storage

Writes the given content in the given key.

See also:

• Read Storage

Sources: Python | Haxe

Camera

Get Camera Active

Returns the active camera.

See also:

• Set Active Camera

Sources: Python | Haxe

Get Camera FOV

Returns the field of view (FOV) of the given camera.

See also:

• Set Camera FOV

Sources: Python | Haxe

Set Camera Active

Sets the active camera.

See also:

• Get Active Camera

Sources: Python | Haxe

Set Camera FOV

Sets the field of view (FOV) of the given camera.

See also:

• Get Camera FOV

Sources: Python | Haxe

Material

Get Object Material

Returns the material of the given object.

Sources: Python | Haxe

Material

Stores the given material as a variable.

Sources: Python | Haxe

Set Material Image Param

TO DO.

Sources: Python | Haxe

Set Material RGB Param

TO DO.

Sources: Python | Haxe

Set Material Value Param

TO DO.

Sources: Python | Haxe

Set Object Material (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Object Material Slot.

Sets the material of the given object.

Sources: Python | Haxe

Set Object Material Slot

TO DO.

Sources: Python | Haxe

Light

Set Light Color

Sets the color of the given light.

Sources: Python | Haxe

Set Light Strength

Sets the strenght of the given light.

Sources: Python | Haxe

Object

Get Distance

Returns the euclidian distance between the two given objects.

See also:

• For distance between two locations, use the Distance operator in the Vector Math node.

Sources: Python | Haxe

Get Object Child

Returns the child of the given object by the child object's name.

Sources: Python | Haxe

Get Object Children

Returns the children of the given object.

Sources: Python | Haxe

Get Object Mesh

Returns the mesh of the given object.

Sources: Python | Haxe

Get Object Name

Returns the name of the given object.

Sources: Python | Haxe

Get Object Offscreen

Returns if the given object is offscreen. Don't works if culling is disabled.

Sources: Python | Haxe

Get Object Parent

Returns the direct parent (nearest in the hierarchy) of the given object.

See also:

• Set Object Parent

Sources: Python | Haxe

Get Object Property

Returns the value of the given object property.

See also:

• Set Object Property

Sources: Python | Haxe

Get Object Visible

Returns whether the given object or its visual components are visible.

See also:

• Set Object Visible

Sources: Python | Haxe

Get Object by Name

Searches for a object that uses the given name and returns it.

Sources: Python | Haxe

Mesh

Stores the given mesh as a variable.

Sources: Python | Haxe

Object

Stores the given object as a variable.

Sources: Python | Haxe

Remove Object

Removes the given object from the scene.

Sources: Python | Haxe

Remove Object Parent

Removes the parent of the given object.

Sources: Python | Haxe

Self Object

Returns the object that owns the trait.

Sources: Python | Haxe

Set Object Mesh

Sets the mesh of the given object.

Sources: Python | Haxe

Set Object Name

Sets the name of the given object.

Sources: Python | Haxe

Set Object Parent

Sets the direct parent (nearest in the hierarchy) of the given object.

See also:

• Get Object Parent

Sources: Python | Haxe

Set Object Property

Sets the value of the given object property. This node can be used to share variables between different traits. If the trait(s) you want to access the variable with are on different objects, use the Global Object node to store the data. Every trait can access this one.

See also:

• Get Object Property

Sources: Python | Haxe

Set Object Visible

Sets whether the given object is visible.

See also:

• Get Object Visible

Sources: Python | Haxe

Spawn Object

Spawns the given object. The spawned object has the same name of its instance, but they are threated as different objects.

Sources: Python | Haxe

Scene

Collection

Returns the objects of the given collection as an array.

See also:

• Get Collection

Sources: Python | Haxe

Create Collection

Creates a collection.

Sources: Python | Haxe

Get Collection

Searches for a collection of objects with the given name and outputs the collection's objects as an array, if found.

See also:

• Collection

Sources: Python | Haxe

Get Scene Active

Returns the active scene.

Sources: Python | Haxe

Get Scene Root

Returns the root object of the current scene.

Sources: Python | Haxe

Global Object

Gives access to a global object which can be used to share information between different traits.

Sources: Python | Haxe

Remove Collection

Removes the given collection from the scene.

Sources: Python | Haxe

Remove Scene Active

Removes the active scene.

Sources: Python | Haxe

Scene

Stores the given scene as a variable.

Sources: Python | Haxe

Set Scene Active

Sets the active scene.

Sources: Python | Haxe

Spawn Collection

Spawns a new instance of the selected collection. Each spawned instance has an empty owner object to control the instance as a whole (like Blender uses it for collection instances).

Inputs:

• In: activates the node.
• Transform: the transformation of the instance that should be spawned. Please note that the collection's instance offset is also taken into account.

Outputs:

• Out: activated when a collection instance was spawned. It is not activated when no collection is selected.
• Top-Level Objects: all objects in the last spawned collection that are direct children of the owner object of the collection's instance.
• All Objects: all objects in the last spawned collection.
• Owner Object: The owning object of the last spawned collection's instance.

Sources: Python | Haxe

Spawn Scene

Spawns the given scene.

Sources: Python | Haxe

Trait

Add Trait to Object

Adds trait to the given object.

Sources: Python | Haxe

Get Object Trait

Searches for a trait with the specified name which is applied to the given object and returns that trait.

Sources: Python | Haxe

Get Object Traits

Returns all traits from the given object.

Sources: Python | Haxe

Get Trait Name

Returns the name and the class type of the given trait.

Sources: Python | Haxe

Get Trait Paused

Returns whether the given trait is paused.

Sources: Python | Haxe

Pause Trait (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Trait Paused.

Pauses the given trait.

Sources: Python | Haxe

Remove Trait

Removes the given trait.

Sources: Python | Haxe

Resume Trait (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Trait Paused.

Resumes the given trait.

Sources: Python | Haxe

Self Trait

Returns the trait that owns this node.

Sources: Python | Haxe

Set Trait Paused

Sets the paused state of the given trait.

Sources: Python | Haxe

Trait

Stores the given trait as a variable. If the trait was not found or was not exported, an error is thrown (more information).

Sources: Python | Haxe

Animation

Action

Stores the given action as a variable.

Sources: Python | Haxe

Blend Action

Interpolates between the two given actions.

Sources: Python | Haxe

Bone FK

Applies forward kinematics in the given object bone.

Sources: Python | Haxe

Bone IK

Applies inverse kinematics in the given object bone.

Sources: Python | Haxe

Get Action State

Returns the information about the current action of the given object.

Sources: Python | Haxe

Get Tilesheet State

Returns the information about the current tilesheet of the given object.

Sources: Python | Haxe

On Action Marker

Activates the output when the object action reaches the action marker.

Sources: Python | Haxe

Pause Action (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Action Paused.

Pauses the given action.

Sources: Python | Haxe

Pause Tilesheet (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Tilesheet Paused.

Pauses the given tilesheet action.

Sources: Python | Haxe

Play Action (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Play Action From.

Plays the given action.

Sources: Python | Haxe

Play Action From

Plays action starting from the given frame.

Sources: Python | Haxe

Play Tilesheet

Plays the given tilesheet action.

Sources: Python | Haxe

Resume Action (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Action Paused.

Resumes the given action.

Sources: Python | Haxe

Resume Tilesheet (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Tilesheet Paused.

Resumes the given tilesheet action.

Sources: Python | Haxe

Set Action Paused

Sets the action paused state of the given object.

Sources: Python | Haxe

Set Action Speed

Sets the current action playback speed of the given object.

Sources: Python | Haxe

Set Parent Bone

Sets the given object parent to the given bone.

Sources: Python | Haxe

Set Particle Speed

Sets the speed of the given particle source.

Sources: Python | Haxe

Set Tilesheet Paused

Sets the tilesheet paused state of the given object.

Sources: Python | Haxe

Navmesh

Go to Location

Makes a NavMesh agent go to location.

Sources: Python | Haxe

Navigable Location

TO DO.

Sources: Python | Haxe

Pick NavMesh Location

Pick a location coordinates in the given NavMesh.

Sources: Python | Haxe

Stop Agent

Stops the given NavMesh agent.

Sources: Python | Haxe

Transform

Append Transform

Appends transform to the given object.

Sources: Python | Haxe

Get Object Location

Returns the current location of the given object in world coordinates.

Sources: Python | Haxe

Get Object Rotation

Returns the current rotation of the given object.

Sources: Python | Haxe

Get Object Scale

Returns the scale of the given object.

Sources: Python | Haxe

Get Object Transform

Returns the transformation of the given object. An object's transform consists of vectors describing its global location, rotation and scale.

Sources: Python | Haxe

Get World Orientation

Returns the world orientation of the given object.

Sources: Python | Haxe

Look At

Converts the two given coordinates to a quaternion rotation.

Sources: Python | Haxe

Rotate Object

Rotates the given object.

Sources: Python | Haxe

Rotate Object Around Axis (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Rotate Object.

Deprecated. It is recommended to use the 'Rotate Object' node instead.

Sources: Python | Haxe

Scale Object (Deprecated)

DEPRECATED. This node is deprecated and will be removed in future versions of Armory. Please use the following node(s) instead: Set Object Scale.

Deprecated. 'Use Set Object Scale' instead.

Sources: Python | Haxe

Separate Transform

Separates the transform of the given object.

Sources: Python | Haxe

Set Object Location

Sets the location of the given object.

Sources: Python | Haxe

Set Object Rotation

Sets the rotation of the given object.

Sources: Python | Haxe

Set Object Scale

Sets the scale of the given object.

Sources: Python | Haxe

Set Object Transform

Sets the transform of the given object.

Sources: Python | Haxe

Transform

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

Sources: Python | Haxe

Transform Math

Operates the two given transform values.

Sources: Python | Haxe

Transform to Vector

Returns vector from the given transform.

Sources: Python | Haxe

Translate Object

Translates (moves) the given object using the given vector in world coordinates.

Sources: Python | Haxe

Translate On Local Axis

Translates (moves) the given object using the given vector in the local coordinates.

Sources: Python | Haxe

Vector to Object Orientation

Converts the given world vector to a vector oriented by the given object. The object scale is taken in count.

See also:

• World Vector To Object Space
• Get World Orientation
• Vector From Transform

Sources: Python | Haxe

World Vector to Local Space

Converts the given world vector to a object space vector. The object scale is taken in count.

See also:

• Vector To Object Orientation
• Get World Orientation
• Vector From Transform

Sources: Python | Haxe

Physics

Add Physics Constraint

Add a physics constraint to constrain two rigid bodies if not already present.

See also:

• Physics Constraint

Options:

• Fixed: No fredom of movement. Relative positions and rotations of rigid bodies are fixed
• Point: Both rigid bodies are constrained at the pivot object.
• Hinge: Constrained objects can move only along angular Z axis of the pivot object.
• Slider: Constrained objects can move only along linear X axis of the pivot object.
• Piston: Constrained objects can move only and rotate along X axis of the pivot object.
• GenericSpring: Fully custimizable generic 6 degree of freedom constraint with optional springs. All liner and angular axes can be constrained along with spring options. Use Physics Constraint Node to set a combination of constraints and springs.

Inputs:

• Pivot object: The object to which the physics constraint traint is applied. This object will not be affected by the constraint but is necessary to specify the constraint axes and location. Hence, the pivot object need not be a rigid body. Typically an Empty object may be used. Each pivot object can have only one constraint trait applied. Moving/rotating/parenting the pivot object after the constraint is applied has no effect. However, removig the pivot object removes the constraint and RB 1 and RB 2 are no longer constrained.
• RB 1: The first rigid body to be constrained. Must be a rigid body. This object can be constrained by more than one constraint.
• RB 2: The second rigid body to be constrained. Must be a rigid body. This object can be constrained by more than one constraint.
• Disable Collisions: Disable collisions between RB 1 and RB 2
• Breakable: Constraint can break if stress on the constraint is more than the set threshold. Disable this option to disable breaking.
• Breaking threshold: Stress on the constraint above which the constraint breaks. Depends on the mass, velocity of rigid bodies and type of constraint.
• Limit Lower: Lower limit of the consraint in that particular axis
• Limit Upper: Upper limit of the constraint in that particular axis. (lower limit = upper limit) --> Fully constrained. (lower limit < upper limit) --> Partially constrained (lower limit > upper limit) --> Full freedom.
• Angular limits: Limits to constarin rotation. Specified in degrees. Range (-360 to +360)
• Add Constarint: Option to add custom constraint to Generic Spring type.

Sources: Python | Haxe

Add Rigid Body

Adds a rigid body to an object if not already present.

Options:

• Advanced: Shows optional advanced options for rigid body.
• Shape: Shape of the rigid body including Box, Sphere, Capsule, Cone, Cylinder, Convex Hull and Mesh

Inputs:

• Object: Object to which rigid body is added.
• Mass: Mass of the rigid body. Must be > 0.
• Active: Rigid body actively participates in the physics world and will be affected by collisions
• Animated: Rigid body follows animation and will affect other active non-animated rigid bodies.
• Trigger: Rigid body behaves as a trigger and detects collision. However, rigd body does not contribute to or receive collissions.
• Friction: Surface friction of the rigid body. Minimum value = 0, Preferred max value = 1.
• Bounciness: How elastic is the surface of the rigid body. Minimum value = 0, Preferred max value = 1.
• Continuous Collision Detection (CCD): Detects for collisions in between frames. Use only for very fast moving objects.
• Collision Margin: Enable an external margin for collision detection
• Margin: Length of the collision margin. Must be > 0.
• Linear Damping: Damping for linear translation. Recommended range 0 to 1.
• Angular Damping: Damping for angular translation. Recommended range 0 to 1.
• Use Deactivation: Deactive this rigid body when below the Linear and Angular velocity threshold. Enable to improve performance.
• Linear Velocity Threshold: Velocity below which decativation occurs if enabled.
• Angular Velocity Threshold: Velocity below which decativation occurs if enabled.
• Collision Group: A set of rigid bodies that can interact with each other
• Collision Mask: Bitmask to filter collisions. Collision can occur between two rigid bodies if they have atleast one bit in common.

Outputs:

• Rigid body: Object to which rigid body was added.
• Out: activated after rigid body is added.

Sources: Python | Haxe

Apply Force

Applies force in the given rigid body.

See also:

• Apply Force At Location
• Apply Impulse
• Apply Impulse At Location

Inputs:

• Force: the force vector
• On Local Axis: if true, interpret the force vector as in object space

Sources: Python | Haxe

Apply Force At Location

Applies force in the given rigid body at the given position.

See also:

• Apply Force
• Apply Impulse
• Apply Impulse At Location

Inputs:

• Force: the force vector
• Force On Local Axis: if true, interpret the force vector as in object space
• Location: the location where to apply the force
• Location On Local Axis: if true, use the location relative to the objects location, otherwise use world coordinates

Sources: Python | Haxe

Apply Impulse

Applies impulse in the given rigid body.

See also:

• Apply Impulse At Location
• Apply Force
• Apply Force At Location

Inputs:

• Impulse: the impulse vector
• On Local Axis: if true, interpret the impulse vector as in object space

Sources: Python | Haxe

Apply Impulse At Location

Applies impulse in the given rigid body at the given position.

See also:

• Apply Impulse
• Apply Force
• Apply Force At Location

Inputs:

• Impulse: the impulse vector
• Impulse On Local Axis: if true, interpret the impulse vector as in object space
• Location: the location where to apply the impulse
• Location On Local Axis: if true, use the location relative to the objects location, otherwise use world coordinates

Sources: Python | Haxe

Apply Torque

Applies torque to the given rigid body.

Sources: Python | Haxe

Apply Torque Impulse

Applies torque impulse in the given rigid body.

Sources: Python | Haxe

Get RB Contacts

Returns an array with all objects that are colliding with the given object.

See also:

• Get First Contact

Sources: Python | Haxe

Get RB Data

Returns the data of the given rigid body.

Sources: Python | Haxe

Get RB First Contact

Returns the first object that is colliding with the given object.

See also:

• Get Contacts

Sources: Python | Haxe

Get RB Velocity

Returns the world velocity of the given rigid body.

Sources: Python | Haxe

Get World Gravity

Returns the world gravity.

See also:

• Set Gravity

Sources: Python | Haxe

Has Contact

Returns whether the given rigid body has contact with another given rigid body.

Sources: Python | Haxe

Has Contact Array

Returns whether the given rigid body has contact with other given rigid bodies.

Sources: Python | Haxe

On Contact

Activates the output when the rigid body make contact with another rigid body.

Options:

• Begin: the output is activated on the first frame when the two objects have contact
• End: the output is activated on the frame after the last frame when the two objects had contact
• Overlap: the output is activated on each frame the object have contact

Sources: Python | Haxe

On Contact Array

Activates the output when the given rigid body make contact with other given rigid bodies.

Sources: Python | Haxe

On Volume Trigger

Activates the output when the given rigid body enter, overlap or leave the given trigger.

Inputs:

• RB: this object is taken as the entering object
• Trigger: this object is used as the volume trigger

Sources: Python | Haxe

Physics Constraint

Custom physics constraint to add to Add Physics Constarint node.

See also:

• Add Physics Constraint

Options:

• Linear/Angualr: Select if constrint is applied along linear or angular axis.
• Axis: Local axis of the pivot object along which the constraint is applied.
• Spring: Constraint is a Spring along the selected axis.

Inputs:

• Limit Lower: Lower limit of the consraint in that particular axis
• Limit Upper: Upper limit of the constraint in that particular axis. (lower limit = upper limit) --> Fully constrained. (lower limit < upper limit) --> Partially constrained (lower limit > upper limit) --> Full freedom.

Sources: Python | Haxe

Pick RB

Picks the rigid body in the given location using the screen coordinates (2D).

See also:

• Mask

Inputs:

• Screen Coords: the location at which to pick, in screen coordinates
• Mask: a bit mask value to specify which objects are considered

Outputs:

• RB: the object that was hit
• Hit: the hit position in world coordinates

Sources: Python | Haxe

Ray Cast

Casts a physics ray and returns the first object that is hit by this ray.

See also:

• Mask

Inputs:

• From: the location from where to start the ray, in world coordinates
• To: the target location of the ray, in world coordinates
• Mask: a bit mask value to specify which objects are considered

Outputs:

• RB: the object that was hit
• Hit: the hit position in world coordinates
• Normal: the surface normal of the hit position relative to the world

Sources: Python | Haxe

Remove RB

Removes the rigid body from the given object.

Sources: Python | Haxe

Set RB Activation State

Sets the rigid body simulation state of the given object.

Sources: Python | Haxe

Set RB Friction

Sets the friction of the given rigid body.

Sources: Python | Haxe

Set RB Gravity Enabled

Sets whether the gravity is enabled for the given rigid body.

Sources: Python | Haxe

Set RB Velocity

Sets the velocity of the given rigid body.

Sources: Python | Haxe

Set World Gravity

Sets the world gravity.

See also:

• Get World Gravity

Sources: Python | Haxe

Volume Trigger

Returns true if the given rigid body enters, overlaps or leaves the given volume trigger.

Inputs:

• RB: this object is taken as the entering object
• Trigger: this object is used as the volume trigger

Sources: Python | Haxe

Array

Array Add

Adds the given value to the given array.

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.

Sources: Python | Haxe

Array Color

Stores an array of color elements as a variable.

Sources: Python | Haxe

Array Contains

Returns whether the given array contains the given value.

Sources: Python | Haxe

Array Dynamic

Stores the given array as a variable.

Sources: Python | Haxe

Array Float

Stores an array of float elements as a variable.

Sources: Python | Haxe

Array Get

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

Sources: Python | Haxe

Array Integer

Stores an array of integer elements as a variable.

Sources: Python | Haxe

Array Length

Returns the length of the given array.

Sources: Python | Haxe

Array Loop

Loops through each item of the given array.

Sources: Python | Haxe

Array Object

Stores an array of object elements as a variable.

Sources: Python | Haxe

Array Pop

Removes the last element of the given array.

See also:

• Haxe API

Sources: Python | Haxe

Array Remove by Index

Removes the element from the given array by its index.

See also:

• Array Remove by Value

Sources: Python | Haxe

Array Remove by Value

Removes the element from the given array by its value.

See also:

• Array Remove by Index

Sources: Python | Haxe

Array Set

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

Sources: Python | Haxe

Array Shift

Removes the first element of the given array.

See also:

• Haxe API

Sources: Python | Haxe

Array Slice

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

See also:

• Haxe API

Sources: Python | Haxe

Array Splice

Removes the given amount of elements from the given array.

See also:

• Haxe API

Sources: Python | Haxe

Array String

Stores an array of string elements as a variable.

Sources: Python | Haxe

Array Vector

Stores an array of vector elements as a variable.

Sources: Python | Haxe

Math

Clamp

Keeps the value inside the given bound.

See also:

• Map Range

Sources: Python | Haxe

Compare

Compares values.

Sources: Python | Haxe

Deg to Rad

Converts degrees to radians.

Sources: Python | Haxe

Map Range

Converts the given value from a range to another range.

See also:

• Clamp

Sources: Python | Haxe

Math

Mathematical operations on values.

Sources: Python | Haxe

Math Expression

Mathematical operations on values.

Sources: Python | Haxe

Matrix Math

Multiplies matrices.

Sources: Python | Haxe

Mix

Interpolates between the two given values.

Sources: Python | Haxe

Mix Vector

Interpolates between the two given vectors.

Sources: Python | Haxe

Quaternion Math

Mathematical operations on quaternions.

Sources: Python | Haxe

Rad to Deg

Converts radians to degrees.

Sources: Python | Haxe

Screen to World Space

Transforms the given screen coordinates into world coordinates.

Sources: Python | Haxe

Separate Quaternion

Splits the given quaternion into X, Y, Z and W.

Sources: Python | Haxe

Separate RGB

Splits the given color into RGB (red, green and blue).

Sources: Python | Haxe

Separate XYZ

Splits the given vector into X, Y and Z.

Sources: Python | Haxe

Vector Clamp

Keeps the vector value inside the given range.

Sources: Python | Haxe

Vector Math

Mathematical operations on vectors.

Sources: Python | Haxe

World to Screen Space

Transforms the given world coordinates into screen coordinates.

Sources: Python | Haxe

Random

Random Boolean

Generates a random boolean.

Sources: Python | Haxe

Random Choice

Choose a random value from a given array.

Sources: Python | Haxe

Random Color

Generates a random color.

Sources: Python | Haxe

Random Float

Generates a random float.

Sources: Python | Haxe

Random Integer

Generates a random integer.

Sources: Python | Haxe

Random Output

Activate a random output when the input is activated.

Sources: Python | Haxe

Random Vector

Generates a random vector.

Sources: Python | Haxe

String

Concatenate String

Concatenates the given string.

Sources: Python | Haxe

Parse Float

Returns the floats that are in the given string.

Sources: Python | Haxe

Split String

Splits the given string.

Sources: Python | Haxe

String

Stores the given string as a variable.

Sources: Python | Haxe

String Case

Changes the given string case.

Sources: Python | Haxe

String Contains

Returns whether the given string contains a given part.

Sources: Python | Haxe

String Length

Returns the length of the given string.

Sources: Python | Haxe

Sub String

Returns a part of the given string.

Sources: Python | Haxe

Variable

Boolean

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

Sources: Python | Haxe

Color

Stores the given color as a variable.

Sources: Python | Haxe

Dynamic

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

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.

Sources: Python | Haxe

Integer

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

Sources: Python | Haxe

Mask

TO DO.

Sources: Python | Haxe

Quaternion

TO DO.

Sources: Python | Haxe

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

Sources: Python | Haxe

Vector

Stores the given 3D vector as a variable.

Sources: Python | Haxe

Canvas

Note: To get the canvas, be sure that the node(s) and the canvas (UI) is attached to the same object.

Get Canvas Checkbox

Returns whether the given UI checkbox is checked.

Sources: Python | Haxe

Get Canvas Input Text

Returns the input text of the given UI element.

Sources: Python | Haxe

Get Canvas Location

Returns the location of the given UI element (pixels).

Sources: Python | Haxe

Get Canvas Position

TO DO.

Sources: Python | Haxe

Get Canvas Progress Bar

Returns the value of the given UI progress bar.

Sources: Python | Haxe

Get Canvas Rotation

Returns the rotation of the given UI element.

Sources: Python | Haxe

Get Canvas Scale

Returns the scale of the given UI element.

Sources: Python | Haxe

Get Canvas Slider

Returns the value of the given UI slider.

Sources: Python | Haxe

Get Canvas Visible

Returns whether the given UI element is visible.

Sources: Python | Haxe

On Canvas Element

Activates the output whether an action over the given UI element is done.

Sources: Python | Haxe

Set Canvas Asset

Sets the asset of the given UI element.

Sources: Python | Haxe

Set Canvas Checkbox

Sets the state of the given UI checkbox.

Sources: Python | Haxe

Set Canvas Location

Sets the location of the given UI element.

Sources: Python | Haxe

Set Canvas Progress Bar

Sets the value of the given UI progress bar.

Sources: Python | Haxe

Set Canvas Rotation

Sets the rotation of the given UI element.

Sources: Python | Haxe

Set Canvas Scale

Sets the scale of the given UI element.

Sources: Python | Haxe

Set Canvas Slider

Sets the value of the given UI slider.

Sources: Python | Haxe

Set Canvas Text

Sets the text of the given UI element.

Sources: Python | Haxe

Set Canvas Text Color

Sets the color of the given UI element.

Sources: Python | Haxe

Set Canvas Visible

Sets whether the given UI element is visibile.

Sources: Python | Haxe

Postprocess

Colorgrading Get Global

TO DO.

Sources: Python | Haxe

Colorgrading Get Highlight

TO DO.

Sources: Python | Haxe

Colorgrading Get Midtone

TO DO.

Sources: Python | Haxe

Colorgrading Get Shadow

TO DO.

Sources: Python | Haxe

Colorgrading Set Global

TO DO.

Sources: Python | Haxe

Colorgrading Set Highlight

TO DO.

Sources: Python | Haxe

Colorgrading Set Midtone

TO DO.

Sources: Python | Haxe

Colorgrading Set Shadow

TO DO.

Sources: Python | Haxe

Get Bloom Settings

Returns the bloom post-processing settings.

Sources: Python | Haxe

Get CA Settings

Returns the chromatic aberration post-processing settings.

Sources: Python | Haxe

Get Camera Post Process

Returns the post-processing effects of a camera.

Sources: Python | Haxe

Get Lenstexture Settings

Returns the lens texture settings.

Sources: Python | Haxe

Get SSAO Settings

Returns the SSAO post-processing settings.

Sources: Python | Haxe

Get SSR Settings

Returns the SSR post-processing settings.

Sources: Python | Haxe

Set Bloom Settings

Set the bloom post-processing settings.

Sources: Python | Haxe

Set CA Settings

Set the chromatic aberration post-processing settings.

Sources: Python | Haxe

Set Camera Post Process

Set the post-processing effects of a camera.

Sources: Python | Haxe

Set Lenstexture

Set the lens texture settings.

Sources: Python | Haxe

Set SSAO Settings

Set the SSAO post-processing settings.

Sources: Python | Haxe

Set SSR Settings

Set the SSR post-processing settings.

Sources: Python | Haxe

Renderpath

Set MSAA Quality

Sets the MSAA quality.

Sources: Python | Haxe

Set Post Process Quality

Sets the post process quality.

Sources: Python | Haxe

Set SSAA Quality

Sets the supersampling quality.

Sources: Python | Haxe

Set Shader Uniform

Set a global shader uniform value.

Sources: Python | Haxe

Set Shadows Quality

Sets the shadows quality.

Sources: Python | Haxe

Sound

Pause Speaker

Pauses playback of the given speaker object. The playback will be resumed at the paused position.

See also:

• Play Speaker
• Stop Speaker

Sources: Python | Haxe

Play Sound

Plays the given sound.

Inputs:

• Play: Plays the sound, or if paused, resumes the playback. The exact behaviour depends on the Retrigger option (see below).
• Pause: Pauses the playing sound. If no sound is playing, nothing happens.
• Stop: Stops the playing sound. If the playback is paused, this will reset the playback position to the start of the sound.

Outputs:

• Out: activated once when Play is activated.
• Running: activated while the playback is active.
• Done: activated when the playback has finished or was stopped manually.

Options:

• Sound: The sound that will be played.
• Loop: Whether to loop the playback.
• Retrigger: If true, the playback position will be reset to the beginning on each activation of Play. If false, the playback will continue at the current position.
• Sample Rate: Manually override the sample rate of the sound (this controls the pitch and the playback speed).

Sources: Python | Haxe

Play Speaker

Starts the playback of the given speaker object. If the playback was paused, it is resumed from the paused position.

See also:

• Pause Speaker
• Play Speaker

Sources: Python | Haxe

Stop Speaker

Stops playback of the given speaker object. The playback position will be reset to the start.

See also:

• Pause Speaker
• Play Speaker

Sources: Python | Haxe

Miscellaneous

Boolean to Vector

Returns a vector depending on the respective boolean state.

Sources: Python | Haxe

Call Node Group

Calls the given group of nodes.

Sources: Python | Haxe

Default if Null

Returns the connected value only if it is not null, otherwise the default value is returned.

Inputs:

• Value: the one that will be eventually null
• Default: will be returned in case the primary value is null

Sources: Python | Haxe

Get Application Time

Returns the application execution time and the delta time.

Sources: Python | Haxe

Get Debug Console Settings

Returns the debug console settings.

Sources: Python | Haxe

Get Display Resolution

Returns the current display resolution.

See also:

• Get Window Resolution

Sources: Python | Haxe

Get Frames Per Second

Get the frames per second count.

Sources: Python | Haxe

Get Window Resolution

Returns the current window resolution.

See also:

• Get Display Resolution

Sources: Python | Haxe

Group Nodes

Sets the connected chain of nodes as a group of nodes.

Sources: Python | Haxe

Set Debug Console Settings

Sets the debug console settings.

Sources: Python | Haxe

Set Time Scale

Sets the global time scale.

Sources: Python | Haxe

Sleep

Waits a specified amount of seconds until passing through the incoming signal.

Sources: Python | Haxe

Timer

Creates a timer.

Sources: Python | Haxe

Layout

Frame

Reroute