Light Object

Light

Description

This Level Object is used to add a spot light to a Layout. Lights do not cast shadows and extend vertically infinitely.

Location

Right-click on an empty space in the Layout Scene Manager and choose Building Blocks > Light from the list.

Properties

Name	Type	Description	Read Only
BRIGHTNESS
BRIGHTNESS	int	Set the additive brightness of the Light. Cannot be set below 1.
ORIENTATION
FORWARD	CVector3	Forward by X,Y,Z
RIGHT	CVector3	Right by X,Y,Z
POSITION
POSITION	CVector3	Position by X,Y,Z world coordinates.
PROPERTIES
FILE	string	Set the mesh file to use for the Light.
FILTER	string	Filter the "File" list by folder.
VISIBLE	string	Set the Light visible or not.
ROTATION ANGLE
ANGLE	float	The Light rotation angle.
SCALE
SCALE X	string	Scale the Light on the X axis.
SCALE Z	string	Scale the Light on the Z axis.
SHADOW
SHADOW	bool	Render the Light as a shadow.

Input Events

Show

This does nothing.

Hide

This does nothing.

Output Events

On Visible

This event will fire when the Light receives a "Show" Input event.

On Invisible

This event will fire when the Light receives a "Hide" Input event.

Tutorials

• Lighting a Layout