Event category

Related help topics

	Building Levels > Create level objects
	Creating Gameplay > Visual programming using Flow > About Flow Evaluation
	Creating Gameplay > Visual programming using Flow > Example workflow: Trigger a door opening
	Creating Gameplay > Scripting with Lua > Starting Lua from a template: Using the Appkit > Using the SimpleProject
	Animation > HumanIK > Set up floor contact using HumanIK
	Animation > HumanIK > Example: HumanIK through Flow
	Working with Audio > Wwise audio basics > Load sound banks at runtime
	Using Entities in your Project > Set up an entity's behavior using Flow or Lua

Nodes

Entity Spawned Triggers an event whenever an instance of an entity that uses this Flow graph is spawned.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Entity		entity	The spawned entity.

Can only be used in a Flow graph that you create using the External Flow Editor and that you set in an entity's Flow component.

This node triggers:

• while you are testing a level from the editor, running your project from the editor, or running a deployed build of your project.
• when the project loads a level that contains an instance of an entity that uses this Flow graph.
• when an instance of an entity that uses this Flow graph is spawned dynamically (e.g. by Flow or Lua).

However, this node never triggers within the Stingray editor. See also Event > Entity Spawned Editor.

Available in Unit Flow Editor only.

Other related nodes

Entity Spawned Editor

Entity Spawned Editor Triggers an event whenever an instance of an entity that uses this Flow graph is spawned within the Stingray editor.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Entity		entity	The spawned entity.

Can only be used in a Flow graph that you create using the External Flow Editor and that you set in an entity's Flow component.

This node triggers in the editor:

• when you open a level that contains an instance of an entity that uses this Flow graph.
• when you place a new instance of an entity that uses this Flow graph into a level.
• when the Asset Preview viewport starts showing an instance of an entity that uses this Flow graph.

This node does not trigger when you are testing a level from the editor, running your project from the editor, or running a deployed build of your project. See also Event > Entity Spawned.

Available in Unit Flow Editor only.

Other related nodes

Entity Spawned

Entity Unspawned Triggers an event whenever an instance of an entity that uses this Flow graph is unspawned.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Entity		entity	The unspawned entity.

Can only be used in a Flow graph that you create using the External Flow Editor and that you set in an entity's Flow component.

This node triggers:

• while you are testing a level from the editor, running your project from the editor, or running a deployed build of your project.
• when the game unloads a level that contains an instance of an entity that uses this Flow graph.
• when an instance of an entity that uses this Flow graph is unspawned dynamically (e.g. by Flow or Lua).

However, this node never triggers within the Stingray editor. See also Event > Entity Unspawned Editor.

Available in Unit Flow Editor only.

Other related nodes

Entity Unspawned Editor

Entity Unspawned Editor Triggers an event whenever an instance of an entity that uses this Flow graph is unspawned within the Stingray editor.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Entity		entity	The unspawned entity.

Can only be used in a Flow graph that you create using the External Flow Editor and that you set in an entity's Flow component.

This node triggers in the editor:

• when you close a level that contains an instance of an entity that uses this Flow graph.
• when you delete an instance of an entity that uses this Flow graph from a level.
• when the Asset Preview viewport stops showing an instance of an entity that uses this Flow graph.

This node does not trigger when you are testing a level from the editor, running your project from the editor, or running a deployed build of your project. See also Event > Entity Unspawned.

Available in Unit Flow Editor only.

Other related nodes

Entity Unspawned

Level Loaded Passes an event when the level has been loaded into the world.

Outputs
		Out		event	An output event triggered on level loaded.

Available in Level Flow Editor only.

Level Shutdown Triggers an event on level shut down.

Outputs
		Out		event	An output event triggered on level shut down.

Available in Level Flow Editor only.

Level Update Passes an event at every update interval of the engine.

Outputs
		Out		event	An output event triggered on level update.

Available in both Unit Flow Editor and Level Flow Editor.

Mover Actor Collision Triggers physics events on actor collision with mover.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Touching Unit		unit	The unit holding the touched actor.
		Touching Actor		actor	The actor that is touching the mover.
		Touched Mover		mover	The mover that is collided with.
		Position		vector3	The position of the mover.
		Normal		vector3	The normal force of the collision.
		Motion Direction		vector3	The direction of the mover.
		Motion Length		float	The length of the collision.

Available in Unit Flow Editor only.

Mover Mover Collision Triggers physics events on mover collision.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Touching Unit		unit	The unit holding the movers.
		Touching Mover		mover	The mover that is touching the other mover.
		Touched Mover		mover	The mover that is collided with.

Available in Unit Flow Editor only.

Physics Collision Triggers physics events on actor collision.

Outputs
		Touched Actor		actor	The actor that is touched.
		Touching Actor		actor	The actor that is touching the other actor.
		Touching Unit		unit	The unit holding the touched actor.
		Position		vector3	The position of the actor.
		Normal		vector3	The normal force of the collision.
		Separation Distance		float	The distance.
		Impulse Force		vector3	The impulse added to the actor.
		Start Touch		event	The output event triggered when the actors touch.
		Stay Touching		event	The output event triggered when the actors remain touching.
		End Touch		event	The output event triggered when the actors end touch.
Variables
		Actor		string

Available in Unit Flow Editor only.

Physics Trigger Triggers physics events for actors touching another in the unit.

Outputs
		Touched Actor		actor	The actor that is touched.
		Touching Actor		actor	The actor that is touching the other actor.
		Touching Unit		unit	The unit holding the touched actor.
		Enter		event	The output event.
		Leave		event	The output event.
Variables
		Actor		string	The actor to touch.

Available in Unit Flow Editor only.

Trigger Triggers events for a shape touching an actor in the unit.

Outputs
		Touched		event	An output event triggered when the actor is touched.
		Untouched		event	An output event triggered when the actor is untouched.
		Touching Actor		actor	The actor that is touched by the shape.
		Touching Unit		unit	The unit holding the touched actor.
Variables
		Shape		level_object	The shape object.
Inputs
event		Enable			An input event for enabling.
event		Disable			An input event for disabling.

Available in Level Flow Editor only.

Unit Spawned Triggers an event whenever an instance of the unit that uses this Flow graph is spawned.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Unit		unit	The spawned unit.

Can only be used in a Unit Flow.

This node triggers:

• while you are testing a level from the editor, running your project from the editor, or running a deployed build of your project.
• when the project loads a level that contains an instance of the unit that uses this Flow graph.
• when an instance of the unit that uses this Flow graph is spawned dynamically (e.g. by Flow or Lua).

However, this node never triggers within the Stingray editor. See also Event > Unit Spawned Editor.

Available in Unit Flow Editor only.

Other related nodes

Unit Spawned Editor Unit Unspawned Editor

Unit Spawned Editor Triggers an event whenever an instance of the unit that uses this Flow graph is spawned inside the Stingray editor.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Unit		unit	The spawned unit.

Can only be used in a Unit Flow.

This node triggers in the editor:

• when you open a level that contains an instance of the unit that uses this Flow graph.
• when you place a new instance of the unit that uses this Flow graph into a level.
• when the Asset Preview viewport starts showing an instance of the unit that uses this Flow graph.

This node does not trigger when you are testing a level from the editor, running your project from the editor, or running a deployed build of your project. See also Event > Unit Spawned.

Available in Unit Flow Editor only.

Other related nodes

Unit Spawned

Unit Unspawned Triggers an event whenever an instance of the unit that uses this Flow graph is unspawned.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Unit		unit	The unspawned unit.

Can only be used in a Unit Flow.

This node triggers:

• while you are testing a level from the editor, running your project from the editor, or running a deployed build of your project.
• when the game unloads a level that contains an instance of the unit that uses this Flow graph.
• when an instance of the unit that uses this Flow graph is unspawned dynamically (e.g. by Flow or Lua).

However, this node never triggers within the Stingray editor. See also Event > Unit Unspawned Editor.

Available in Unit Flow Editor only.

Unit Unspawned Editor Triggers an event whenever an instance of the unit that uses this Flow graph is unspawned inside the Stingray editor.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
		Unit		unit	The unspawned unit.

Can only be used in a Unit Flow.

This node triggers in the editor:

• when you close a level that contains an instance of the unit that uses this Flow graph, or close the editor.
• when you delete an instance of the unit that uses this Flow graph from a level.
• when the Asset Preview viewport stops showing an instance of the unit that uses this Flow graph.

This node does not trigger when you are testing a level from the editor, running your project from the editor, or running a deployed build of your project. See also Event > Unit Spawned.

Available in Unit Flow Editor only.

Other related nodes

Unit Unspawned