reference_data

Logic Nodes Reference: Data 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 2022.6.

---

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

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

Set an image value material parameter to the specified object.

See also:

• Get Scene Root

Inputs:

• Object: Object whose material parameter should change. Use Get Scene Root node to set parameter globally.
• Per Object: - Enabled: Set material parameter specific to this object. Global parameter will be ignored.
  • Disabled: Set parameter globally, including this object.
• Material: Material whose parameter to be set.
• Node: Name of the parameter.
• Image: Name of the image.

Sources: Python | Haxe

Set Material RGB Param

Set a color or vector value material parameter to the specified object.

See also:

• Get Scene Root

Inputs:

• Object: Object whose material parameter should change. Use Get Scene Root node to set parameter globally.
• Per Object: - Enabled: Set material parameter specific to this object. Global parameter will be ignored.
  • Disabled: Set parameter globally, including this object.
• Material: Material whose parameter to be set.
• Node: Name of the parameter.
• Color: Color or vector input.

Sources: Python | Haxe

Set Material Value Param

Set a float value material parameter to the specified object.

See also:

• Get Scene Root

Inputs:

• Object: Object whose material parameter should change. Use Get Scene Root node to set parameter globally.
• Per Object: - Enabled: Set material parameter specific to this object. Global parameter will be ignored.
  • Disabled: Set parameter globally, including this object.
• Material: Material whose parameter to be set.
• Node: Name of the parameter.
• Float: float value.

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 Area Light Size

Sets the size of the given area light.

Sources: Python | Haxe

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

Set Spot Light Blend

Sets the blend of the given spot light.

Sources: Python | Haxe

Set Spot Light Size

Sets the size of the given spot 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 By Uid

Searches for a object with this uid in the current active scene and returns it.

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 Uid

Returns the uid of the given object.

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 in the current active scene 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

Raycast Closest Object

it takes an objects array and returns true of false if at least one of those objects is touched at screen (x, y), the object that is touched and the (x,y, z) position of that touch if returned

Sources: Python | Haxe

Raycast Object

it takes an object and returns true or false if the object is touched at screen (x, y) and the (x,y, z) position of that touch if returned

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 Shape Key

Sets shape key value of the object

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 if present in the current active scene. The spawned object has the same name of its instance, but they are treated as different objects.

Sources: Python | Haxe

Spawn Object By Name

Spawns an object bearing the given name, even if not present in the active scene

Sources: Python | Haxe

Scene

Add Object to Collection

Add Object to a collection.

Sources: Python | Haxe

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 Object from Collection

Remove Object from a collection.

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