Unit category

Related help topics

	Release Notes > Stingray 1.7 Release Notes
	Lighting and Rendering > Lighting > Light sources > Create a light source
	Creating Gameplay > Visual programming using Flow > About Flow Evaluation
	Creating Gameplay > Visual programming using Flow > Flow Node Colors and Types (Level Flow)

Sub-categories

Data

Nodes

Create Unit Actor Creates an actor with the specified name or index in the unit, if it has not been created already.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit that will contain the actor.
string		Actor Name			The name of the actor.
float		Inherit Velocity			Specifies to what extent the physics actor should inherit the velocity of the animated objects that it is connected to. A value of 1.0 means it completely inherits the animated velocity.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Destroy Unit Actor Destroys the actor with the specified name or index, if it has been created previously in the unit.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit that contain the actor to destroy.
string		Actor Name			The name of the actor to destroy.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Actor Returns the actor with the specified name or index in the unit.

Outputs
		Actor		actor	The specified actor.
Inputs
unit		Unit			The unit whose actor you want to retrieve.
float		Actor Index			The index of the actor to retrieve.
string		Actor Name			The name of the actor.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Camera Returns the camera with the specified camera name in the unit.

Outputs
		Camera		camera	The specified camera.
Inputs
unit		Unit			The unit whose camera you want to retrieve.
string		Camera Name			The name of the camera to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Level Name Returns the level that spawned the unit.

Outputs
		Name		string	The level that spawned the unit.
Inputs
unit		Unit			The unit whose level you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Light Returns the light with the specified light name in the unit.

Outputs
		Light		light	The specified light.
Inputs
unit		Unit			The unit whose light you want to retrieve.
string		Light Name			The name of the light to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Local Position Returns the units local position.

Outputs
		Position		vector3	The local position of the unit.
Inputs
unit		Unit			The unit whose position is retrieved.
id		Object			The name of the object node inside the units scene graph.

If no object is specified, the units local position will be set instead.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Local Rotation Returns the units local rotation.

Outputs
		Rotation		quaternion	The local rotation of the unit.
Inputs
unit		Unit			The unit whose rotation is retrieved.
id		Object			The name of the object node inside the units scene graph.

If no object is specified, the units local rotation will be used instead.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Local Scale Returns the units local scale.

Outputs
		Scale		vector3	The local scale of the unit.
Inputs
unit		Unit			The unit whose scale is retrieved.
id		Object			The name of the object node inside the units scene graph.

If no object is specified, the units local scale will be used instead.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Mesh Returns the mesh with the specified mesh name in the unit.

Outputs
		Mesh		mesh	The specified mesh.
Inputs
unit		Unit			The unit whose mesh you want to retrieve.
string		Mesh Name			The name of the mesh to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Mover Returns the mover of the unit.

Outputs
		Mover		mover	The mover of the unit.
Inputs
unit		Unit			The unit whose mover you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Num Actors Returns the number of actors owned by the unit.

Outputs
		Value		float	The number of actors in the unit.
Inputs
unit		Unit			The unit to test.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Numeric Property Returns the numeric value of a property on a unit, or on any object owned by the unit, such as a material, mesh or light.

Outputs
		Value		float	The value currently set for the property.
Inputs
unit		Unit			The unit whose numeric value you want to retrieve.
string		Path			A string delimited by forward slashes that make up the path to the property.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit Resource Type Returns the resource type of the unit.

Outputs
		Type		string	The name of the unit's resource type.
Inputs
unit		Unit			The unit whose resource type you want to retrieve.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit World Position Returns the world position of the unit.

Outputs
		Position		vector3	The world position of the unit.
Inputs
unit		Unit			The unit whose position is retrieved.
id		Object			The name of the object node inside the units scene graph.

If no object is specified, the units world position will be used instead.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Get Unit World Rotation Returns the world rotation of the unit.

Outputs
		Rotation		quaternion	The world rotation of the unit.
Inputs
unit		Unit			The unit whose rotation is retrieved.
id		Object			The name of the object node inside the units scene graph.

If no object is specified, the units world rotation will be used instead.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Link Unit Links the child unit to the parent unit, or breaks an existing link.

Outputs
		Linked		event	The output event triggered when the unit is linked.
		Unlinked		event	The output event triggered when the unit is unlinked.
Inputs
unit		Child			The child unit to link to the parent unit.
string		Child Node
unit		Parent			The unit that is set as the parent.
string		Parent Node
event		Link			Trigger this event to link the child unit to the parent.
event		Unlink			Trigger this event to unlink the child unit from the parent.

When a unit is linked to a parent, it is a slave of the parent unit. Any changes you make to the parent unit's position and rotation will also be applied to the child.

Calling this node automatically resets the local transform of the child node, so that it is positioned at the exact location of the parent node, with the same rotation, and the same scale. If you want to offset the child, you need to set its local position, rotation and scale after this node.

You cannot link one child unit to multiple parent units. A unit must have a single, well-defined parent unit. If a unit is already linked to a parent, you must first unlink it before you can link it to a different parent unit.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Mesh Pick Raycast Test for intersections with visual meshes within the provided Unit.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Hit		boolean	Returns true if the collision is detected and false otherwise.
		Distance		float	The distance of the collision point from the starting point of the collision test.
		Normal		vector3	The normal of the surface that was hit.
		Mesh		mesh	The mesh that was hit.
		Slot Name		id	The material slot id used by the triangle that was hit.
Inputs
unit		Unit			The unit to raycast against.
vector3		From			The start position of the raycast.
vector3		Direction			The direction that the ray will be cast from its starting point.
float		Length			The length of the ray.
boolean		Include Hidden Meshes			Include hidden meshes or not.
event		In			This event triggers the evaluation of this node.

Will return mesh and material slot information for the intersected triangle within the mesh. Note: Will be very expensive for units containing high density meshes.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Move Unit Sets the units position every frame update by the delta position in the direction specified by the velocity.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit to teleport.
id		Object			The name of the object node inside the units scene graph to move.
vector3		Delta Position			The delta position to set for the unit.
vector3		Velocity			The velocity of the unit.
boolean		Teleport			A boolean to indicate whether to teleport the unit or not.
event		In			This event triggers the evaluation of this node.

If no object is specified, the unit will be moved instead. Enabling teleport will cause the unit to teleport to the location instead of move fluidly.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Relay Unit Relays the specified unit value to other nodes.

Pass-through Inputs
unit		Unit		unit	The unit to relay.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Rotate Unit Sets the units rotation every frame update by the delta rotation in the direction specified by the velocity.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit to rotate.
id		Object			The name of the object node inside the units scene graph to rotate.
quaternion		Delta Rotation			The new rotation to set for the unit.
vector3		Velocity			The velocity.
boolean		Teleport			A boolean to indicate whether to teleport the unit or not.
event		In			This event triggers the evaluation of this node.

If no object is specified, the unit will be rotated instead. Enabling teleport will cause the unit to teleport to the desired rotation instead of rotate fluidly.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Unit Local Position Sets the local position of the unit.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit whose position is set.
vector3		Position			The new position to set for the unit.
id		Object			The name of the object node inside the units scene graph to move.
boolean		Teleport			A boolean to indicate whether to teleport the unit or not.
event		In			This event triggers the evaluation of this node.

If no object is specified, the units local position will be set instead. Enabling teleport will cause the unit to teleport to the destination.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Unit Local Rotation Sets the local rotation of a sub-object within the unit's scene graph, or the local rotation of the unit itself if no sub-object is specified.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
quaternion		Rotation			The new rotation to set for the unit.
id		Object			The name of the object node inside the unit's scene graph to rotate.
boolean		Teleport			(Optional) A boolean to indicate whether to teleport the unit.
unit		Unit			The unit whose rotation is set.
event		In			This event triggers the evaluation of this node.

Enabling teleport will cause the unit to teleport to the specified rotation value.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Unit Local Scale Sets the local scale of the unit.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit whose scale is set.
vector3		Scale			The new scale for the unit.
id		Object			The name of the object node inside the units scene graph to scale.
boolean		Teleport			A boolean to indicate whether to teleport the unit or not.
event		In			This event triggers the evaluation of this node.

If no object is specified, the units local scale will be set instead. Enabling teleport will cause the unit to teleport to the specified scale value.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Unit Mover Sets the unit to use the mover with the specified name.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit to use with the mover.
string		Mover Name			The name of the mover.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Unit Numeric Property Sets the numeric value of a property on a unit, or on any object owned by the unit, such as a material, mesh or light.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit whose data you want to set.
string		Path			A string delimited by forward slashes that make up the path to the property, for example "meshes/my_unit_mesh_name/materials/slot_name/albedo/x"
float		Value			The value to set for the property.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Set Unit Visibility Sets the visibility of all meshes in the specified unit, or all meshes included in a visibility group owned by that unit.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit you want to show or hide.
id		Group			The name of a visibility group that you want to show or hide. Optional. If specified, only the meshes in this group will be affected. If omitted, all meshes in the unit will be affected.
boolean		Visible			A boolean that determines whether the meshes will be made visible (true) or hidden (false).
event		In			This event triggers the evaluation of this node.

You can create visibility groups and assign meshes to them in the Unit Editor.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Spawn Unit on Marker Spawns a unit at the specified marker in the level.

Outputs
		Spawned Unit		unit	The spawned unit at the marker position.
		Spawned		event	The output event triggered when the unit is spawned.
		Unspawned		event	The output event triggered when the unit is unspawned.
Variables
		Spawn Point		level_object
Inputs
id		Unit
event		Spawn			The input event triggered to spawn the unit.
event		Unspawn			The input event triggered to unspawn the unit.

Available in Level Flow Editor only.

Spawn Unit on Position Spawns a unit at the specified position in the level.

Outputs
		Spawned Unit		unit	The spawned unit on the level.
		Spawned		event	The output event triggered when the unit is spawned.
		Unspawned		event	The output event triggered when the unit is unspawned.
Inputs
id		Unit
vector3		Position			The new position of the unit.
quaternion		Rotation			The new rotation of the unit.
event		Spawn			The input event triggered to spawn the unit.
event		Unspawn			The input event triggered to unspawn the unit.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Unit Flow Event Triggers the external event with the specified name in the unit’s flow graph.

Variables
		Event		string	The name of the flow event to trigger.
Inputs
unit		Unit			The unit for which you want to trigger a flow event.
event		In			This event triggers the evaluation of this node.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Unit Is Alive Indicates whether the unit exists, or whether it has been deleted.

Outputs
		Value		boolean	Returns false if the unit has been deleted or if the unit is nil.
Inputs
unit		Unit			The unit to test.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Unit Is Of Type Indicates whether or not the unit is a resource of the specified type.

Outputs
		Value		boolean	Returns true if the unit's resource type matches the specified name, and false otherwise.
Inputs
unit		Unit			The unit to test.
id		Type			The name of the unit resource type.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Unit Resource Returns the unit resource as a string.

Outputs
		Resource		string	The unit resource.
Inputs
string		Resource

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Unspawn Unit Unspawns the unit from the current level.

Outputs
		Unspawned		event	The output event triggered when the unit is unspawned.
Inputs
unit		Unit			The unit to unspawn.
event		Unspawn			The input event triggered to unspawn the unit.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.

Update Unit Forces an update of the unit's scene graph after the main world update has been performed.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit to update.
event		In			This event triggers the evaluation of this node.

This can be used to implement units that are dependent on other units positions in complicated ways that cannot be expressed just with the Link Unit node. It should be used sparingly.

Available in Unit Flow Editor, Level Flow Editor, and External Flow Editor.