LightSource

This is the base class of all LightSource types, which are components that can be added to certain Renderable types to add lighting effects.

A LightSource, in this case, is just a table that describes properties such as the location of the light. It does not physically exist in the scene, and the table of parameters have to be added to each Renderable that should be affected by the light source. This is commonly done by exporting a light source table from an Asset file that represents an illuminating object in the scene, such as the Sun in our solar system.

Members

Name

Documentation

Type

Description

Optional

Identifier

The identifier of the light source.

Identifier

An identifier string. May not contain ‘.’, spaces, newlines, or tabs

No

Type

The type of light source that is described in this element.

String

Must name a valid LightSource type

No

Enabled

Whether the light source is enabled or not.

Boolean

Value of type ‘Boolean’

Yes