reference_data
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
Returns the active camera.
See also:
Returns the aspect of the given camera.
Returns the field of view (FOV) of the given camera.
See also:
Returns the scale of the given camera.
Returns the Start & End of the given camera.
See also:
Returns the camera Type: 0 : Perspective 1 : Ortographic .
Sets the active camera.
See also:
Sets the aspect of the given camera.
Sets the field of view (FOV) of the given camera.
See also:
Sets the aspect of the given camera.
Sets the Start & End of the given camera.
See also:
Sets the camera type.
Returns the material of the given object.
Stores the given material as a variable.
Set an image value material parameter to the specified object.
See also:
Inputs:
-
Object: Object whose material parameter should change. UseGet Scene Rootnode 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.
Set a color or vector value material parameter to the specified object.
See also:
Inputs:
-
Object: Object whose material parameter should change. UseGet Scene Rootnode 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.
Set a float value material parameter to the specified object.
See also:
Inputs:
-
Object: Object whose material parameter should change. UseGet Scene Rootnode 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.
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.
TO DO.
Sets the size of the given area light.
Sets the color of the given light.
Sets the strenght of the given light.
Sets the blend of the given spot light.
Sets the size of the given spot light.
Returns the euclidian distance between the two given objects.
See also:
- For distance between two locations, use the
Distanceoperator in theVector Mathnode.
Searches for a object with this uid in the current active scene and returns it.
Returns the child of the given object by the child object's name.
Returns the children of the given object.
Returns the mesh of the given object.
Returns the name of the given object.
Returns if the given object is offscreen. Don't works if culling is disabled.
Returns the direct parent (nearest in the hierarchy) of the given object.
See also:
Returns the value of the given object property.
See also:
Returns the uid of the given object.
Returns whether the given object or its visual components are visible.
See also:
Searches for a object that uses the given name in the current active scene and returns it.
Stores the given mesh as a variable.
Stores the given object as a variable.
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
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
This node will remove a scene object or a scene object and its children.
Inputs:
-
Object: Scene object to remove. -
Remove Children: Remove scene object's children too. -
Keep Children Transforms: Scene object's children will maintain current transforms when the scene object is removed, else children transforms revert to scene origin transforms.
Removes the parent of the given object.
Returns the object that owns the trait.
Sets the mesh of the given object.
Sets the name of the given object.
Sets the direct parent (nearest in the hierarchy) of the given object.
See also:
Inputs:
-
Object: Object to be parented. -
Parent: New parent object. UseGet Scene Rootnode to unparent object. -
Keep Transform: Keep transform after unparenting from old parent -
Parent Inverse: Preserve object transform after parenting to new object.
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:
Sets shape key value of the object
Sets whether the given object is visible.
See also:
Inputs:
-
Object: Object whose property to be set. -
Visible: Visibility. -
Children: Set the visibility of the children too. Visibility is set only to the immediate children. -
Recursive: If enabled, visibility of all the children in the tree is set. Ignored ifChildrenis disabled.
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.
Spawns an object bearing the given name, even if not present in the active scene
Add Object to a collection.
Returns the objects of the given collection as an array.
See also:
Creates a collection.
Searches for a collection of objects with the given name and outputs the collection's objects as an array, if found.
See also:
Get Object collection.
Returns the active scene.
Returns the root object of the current scene.
Gives access to a global object which can be used to share information between different traits.
Removes the given collection from the scene.
Remove Object from a collection.
Removes the active scene.
Sets the active scene.
Spawns a new instance of the selected collection from the given scene. If the scene is empty or null, the current active scene is used. Each spawned instance has an empty owner object to control the instance as a whole (like Blender uses it for collection instances).
Inputs:
-
Scene: Scene in which the collection belongs. -
Collection: Collection to be spawned. -
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.
Spawns the given scene.
Adds trait to the given object.
Searches for a trait with the specified name which is applied to the given object and returns that trait.
Returns all traits from the given object.
Returns the name and the class type of the given trait.
Returns whether the given trait is paused.
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.
Removes the given trait.
Remove trait from the given object.
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.
Returns the trait that owns this node.
Sets the paused state of the given trait.
Stores the given trait as a variable. If the trait was not found or was not exported, an error is thrown (more information).
Close connection on the network
Network client to connect to an existing host
Network host for other clients to connect
Close a client from a host connection by ID
Return an IP from the ID of a connection
Network Http Request
Parses message type from data packet
Triggers an event from the network getting both message data and sender ID
Open connection on the network
Send messages directly to a host as a client or to all of the network clients connected to a host send messages directly
