The Light class allows you to access a light object within your zone from its object ID. All settings can be manipulated through script.
![]() |
|
new(int ObjectID) | Description Gets a light object in the current zone from its object ID. Parameters int ObjectID
Returns Light |
![]() |
|
GetTimelineAreaHeight(int nodeID) | Description Gets the value of the rectangular area light height at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineAreaRadius(int nodeID) | Description Gets the value of the disk or sphere area light radius at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineAttenuationRadius(int nodeID) | Description Gets the value of the attenuation radius of the light at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineColor(int nodeID) | Description Gets the value of the color of the light at the specified node index of the timeline. Parameters int nodeID
Returns Vector3D |
GetTimelineColorBlue(int nodeID) | Description Gets the value of the blue channel of the color of the light at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineColorGreen(int nodeID) | Description Gets the value of the green channel of the color of the light at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineColorRed(int nodeID) | Description Gets the value of the green channel of the color of the light at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineIlluminance(int nodeID) | Description Gets the value of the illuminance of the area light at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineInnerAngle(int nodeID) | Description Gets the value of the inner angle of the spot light at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineIntensity(int nodeID) | Description Gets the value of the intensity of the point or spot light at the specified node index of the timeline. Parameters int nodeID
Returns float |
GetTimelineOuterAngle(int nodeID) | Description Gets the value of the outer angle of the spot light at the specified node index of the timeline. Parameters int nodeID
Returns float |
SetTimelineAreaHeight(int nodeID, float height) | Description Gets the value of the rectangular area light height at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineAreaRadius(int nodeID, float radius) | Description Sets the value of the disk or sphere area light radius at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineAreaWidth(int nodeID, float width) | Description Sets the value of the rectangular area light width at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineAttenuationRadius(int nodeID, float attenuation) | Description Sets the value of the attenuation radius of the light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineColor(int nodeID, Vector3D color) | Description Sets the value of the color of the light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineColorBlue(int nodeID, float blue) | Description Sets the value of the blue channel of the color of the light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineColorGreen(int nodeID, float green) | Description Sets the value of the green channel of the color of the light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineColorRed(int nodeID, float red) | Description Sets the value of the red channel of the color of the light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineIlluminance(int nodeID, float illuminance) | Description Sets the value of the illuminance of the area light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineInnerAngle(int nodeID, float angle) | Description Sets the value of the inner angle of the spot light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineIntensity(int nodeID, float intensity) | Description Sets the value of the intensity of the point or spot light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
SetTimelineOuterAngle(int nodeID, float angle) | Description Sets the value of the outer angle of spot light at the specified node index of the timeline. Parameters int nodeID
Returns Void |
![]() |
|
float areaHeight | Gets or sets the height of a rectangular area light. |
float areaRadius | Gets or sets the radius of a disk or sphere area light. |
float areaWidth | Gets or sets the width of a rectangular area light. |
float attenuationRadius | Gets or sets the attenuation radius of the light. |
Vector3D color | Gets or sets the color of the light. |
float colorBlue | Gets or sets the blue channel value of the color of the light. |
float colorGreen | Gets or sets the green channel value of the color of the light. |
int colorMode | Gets or sets the color mode of the light.
|
float colorRed | Gets or sets the red channel value of the color of the light. |
float fadeOutRange | Gets or sets the distance over which the light will be gradually faded out upon reaching its maximum render distance. |
float falloffBias | Gets or sets the falloff bias of the light. |
float illuminance | Gets or sets the illuminance of the area light. |
float innerAngle | Gets or sets the inner angle of the spot light. |
float intensity | Gets or sets the intensity of the point or spot light. |
bool isShadowCaster | Gets or sets whether the light casts shadows. |
bool isTurnedOn | Gets or sets whether the light is turned on. |
float outerAngle | Gets or sets the outer angle of the spot light. |
Vector3D position | Gets or sets the Position of the Light. |
float positionX | Gets or sets the X Position of the Light. |
float positionY | Gets or sets the Y Position of the Light. |
float positionZ | Gets or sets the Z Position of the Light. |
float renderDistance | Gets or sets the maximum render distance of the Light. |
Vector3D rotation | Gets or sets the Rotation of the Light. |
float rotationX | Gets or sets the X Rotation of the Light. |
float rotationY | Gets or sets the Y Rotation of the Light. |
float rotationZ | Gets or sets the Z Rotation of the Light. |
float shadowBias | Gets or sets the shadow bias of the light to help remove artefacts. |
float shadowFadeLength | Gets or sets the distance over which shadows are faded near the edges of the shadow map of the light. |
int shape | Gets or sets the shape of the area light.
|
float temperature | Gets or sets the temperature of the light in Kelvin. |
float timelineLength | Gets or sets the length over which the timeline of the light is cycled through in seconds. |
float timelineMaxAttenuationRadius | Gets or sets the maximum attenuation radius throughout the timeline of the light. |
float timelineMaxHeight | Gets or sets the maximum height of the rectangular area light throughout the timeline of the light. |
float timelineMaxIlluminance | Gets or sets the maximum illuminance of the area light throughout the timeline of the light. |
float timelineMaxInnerAngle | Gets or sets the maximum inner angle of the spot light throughout the timeline of the light. |
float timelineMaxIntensity | Gets or sets the maximum intensity of the point or spot light throughout the timeline of the light. |
float timelineMaxOuterAngle | Gets or sets the maximum outer angle of the spot light throughout the timeline of the light. |
float timelineMaxRadius | Gets or sets the maximum radius of the disk or sphere area light throughout the timeline of the light. |
float timelineMaxWidth | Gets or sets the maximum width of the rectangular area light throughout the timeline of the light. |
float timelineMinAttenuationRadius | Gets or sets the minimum attenuation radius throughout the timeline of the light. |
float timelineMinHeight | Gets or sets the minimum height of the rectangular area light throughout the timeline of the light. |
float timelineMinIlluminance | Gets or sets the minimum illuminance of the area light throughout the timeline of the light. |
float timelineMinInnerAngle | Gets or sets the minimum inner angle of the spot light throughout the timeline of the light. |
float timelineMinIntensity | Gets or sets the minimum intensity of the point or spot light throughout the timeline of the light. |
float timelineMinOuterAngle | Gets or sets the minimum outer angle of the spot light throughout the timeline of the light. |
float timelineMinRadius | Gets or sets the minimum radius of the disk or sphere area light throughout the timeline of the light. |
float timelineMinWidth | Gets or sets the minimum width of the rectangular area light throughout the timeline of the light. |
bool timelineMode | Gets or sets whether the light should use the timeline settings. |
int type | Gets or sets the type of the light.
|