Skip to content

LightInfo ​

The LightInfo class extends Entity with light color and scalar field accessors.

NOTE

This page documents members declared directly on LightInfo. Inherited members are available from Entity.


Methods ​

GetColorArray(field: string, index: number)Color ​

Retrieves the color array.

  • fieldstring - The field name.
  • indexnumber - The index value.

Returned:

  • Color - The result of the call.

SetColorArray(field: string, index: number, color: Color)void ​

Sets the color array.

  • fieldstring - The field name.
  • indexnumber - The index value.
  • colorColor - The color value to use.

GetFloatArray(field: string, index: number)number ​

Retrieves the float array.

  • fieldstring - The field name.
  • indexnumber - The index value.

Returned:

  • number - The requested float array.

SetFloatArray(field: string, index: number, value: number)void ​

Sets the float array.

  • fieldstring - The field name.
  • indexnumber - The index value.
  • valuenumber - The value to set or use.

GetFloat(field: string)number ​

Retrieves the float.

  • fieldstring - The field name.

Returned:

  • number - The requested float.

SetFloat(field: string, value: number)void ​

Sets the float.

  • fieldstring - The field name.
  • valuenumber - The value to set or use.

GetColor(field: string)Color ​

Retrieves the color.

  • fieldstring - The field name.

Returned:

  • Color - The result of the call.

SetColor(field: string, color: Color)void ​

Sets the color.

  • fieldstring - The field name.
  • colorColor - The color value to use.