Light category

Related help topics

Lighting and Rendering > Lighting > Light sources > Change light source properties

Nodes

Get Light Casts Shadows Enabled Gets the casts shadows state of the light.

Outputs
		Enabled		boolean	A boolean value indicating if the light is casting shadows (true value) or not (false value).
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to retrieve. If Light is not specified and the unit contains multiple lights the status of the first light found in the unit will be returned.

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

Get Light Color Returns the current color for the specified light.

Outputs
		Color		vector3	The color of the light. The values for the X, Y and Z axes indicate the red, green, and blue color channels respectively; each is a value between 0 and 255.
Inputs
unit		Unit			The unit owning the light whose value you want to retrieve.
light		Light			The game light whose value you want to retrieve.

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

Get Light Enabled Gets the enabled state of the light.

Outputs
		Enabled		boolean	A boolean value indicating if the light is on (true value) or off (false value).
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to retrieve. If Light is not specified and the unit contains multiple lights the status of the first light found in the unit will be returned.

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

Get Light Falloff End Returns the end falloff value for a specified light.

Outputs
		Distance		float	The distance at which the light starts to lose its intensity.
Inputs
unit		Unit			The unit owning the light whose value you want to retrieve.
light		Light			The game light whose value you want to retrieve.

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

Get Light Falloff Start Returns the start falloff value for a specified light.

Outputs
		Distance		float	The distance at which the light has reached zero intensity.
Inputs
unit		Unit			The unit owning the light whose value you want to retrieve.
light		Light			The game light whose value you want to retrieve.

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

Get Light Intensity Returns the current intensity value for a light.

Outputs
		Intensity		float	The intensity of the light.
Inputs
unit		Unit			The unit owning the light whose value you want to retrieve.
light		Light			The game light whose value you want to retrieve.

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

Get Light Local Position Returns the light’s current local position values.

Outputs
		Position		vector3	The light’s current local position value.
Inputs
unit		Unit			The unit owning the light whose value you want to retrieve.
light		Light			The game light whose value you want to retrieve.

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

Get Light Local Rotation Returns the light’s current local rotation value.

Outputs
		Rotation		quaternion	The light’s current local rotation value.
Inputs
unit		Unit			The unit owning the light whose value you want to retrieve.
light		Light			The game light whose value you want to retrieve.

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

Get Light World Position Returns the light’s current world position value.

Outputs
		Position		vector3	The light’s current world position value.
Inputs
unit		Unit			The unit owning the light whose value you want to retrieve.
light		Light			The game light whose value you want to retrieve.

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

Get Light World Rotation Returns the light’s current world rotation value.

Outputs
		Rotation		quaternion	The light’s current world rotation value.
Inputs
unit		Unit			The unit owning the light whose value you want to retrieve.
light		Light			The game light whose value you want to retrieve.

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

Move Light Changes the light’s position over time using a delta position and a directional velocity.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
vector3		Delta Position			The delta position.
vector3		Velocity			The directional velocity to move the light.
event		In			This event triggers the evaluation of this node.

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

Set Light Casts Shadows Enabled Controls whether a light will cast shadows or not.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
boolean		Enabled			A boolean value to turn the shadow casting on (true value) or off (false value).
event		In			This event triggers the evaluation of this node.

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

Set Light Color Sets a light to the specified color.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
vector3		Color			The color to set for the light. The values for the X, Y and Z axes indicate the red, green, and blue color channels respectively; each should be a value between 0 and 255.
event		In			This event triggers the evaluation of this node.

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

Set Light Enabled Controls whether a light will be enabled or disabled.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
boolean		Enabled			A boolean value to turn the light on (true value) or off (false value).
event		In			This event triggers the evaluation of this node.

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

Set Light Falloff End Sets the falloff end value for a light.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
float		Distance			The distance at which the light should reach zero intensity.
event		In			This event triggers the evaluation of this node.

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

Set Light Falloff Start Sets the falloff start value for a light.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
float		Distance			The distance at which the light should start to lose its intensity.
event		In			This event triggers the evaluation of this node.

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

Set Light Intensity Sets the intensity value for a light.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
float		Intensity			The intensity set for the light.
event		In			This event triggers the evaluation of this node.

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

Set Light Local Position Sets the local position value of a light.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
vector3		Position			The new position of the light.
event		In			This event triggers the evaluation of this node.

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

Set Light Local Rotation Sets the local rotation value of a light.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
quaternion		Rotation			The new rotation value of the light.
event		In			This event triggers the evaluation of this node.

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

Set Light Type Sets the active light type of a light.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
string		Type			The type of the light source. Valid values are spot, omni, box or directional. Accepted values: omni spot box directional
event		In			This event triggers the evaluation of this node.

Options are spot, omni or directional.

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

Set Spotlight Angle End Sets the end angle value of a spotlight.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
float		Angle			The cone angle in radians.
event		In			This event triggers the evaluation of this node.

Only works for spotlight light types.

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

Set Spotlight Angle Start Sets the start angle value of a spotlight.

Outputs
		Out		event	This event is triggered when the node finishes its evaluation.
Inputs
unit		Unit			The unit holding the light.
light		Light			The game light whose value you want to set.
float		Angle			The cone angle in radians.
event		In			This event triggers the evaluation of this node.

Only works for spotlight light types.

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