Lighting

Lighting
Not creatableThis class cannot be instantiated. ServiceThis class is a service.
Icon
Legacy IconsThese icon(s) are only a part of legacy Roblox Studio versions, or are unused as of the studio icons update.
Memory category	Instances
Inheritance
Instance Lighting

Lighting is responsible for all lighting aspects of the world, affecting how objects are rendered. This class cannot be instantiated.

Properties

Ambient: Color3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/Ambient.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Brightness: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/Brightness.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

ClockTime: float

• Not replicatedThis member is not replicated across the network boundary.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/ClockTime.

• Category: Data.
• Serialization: can load only.
• Thread safety: read safe

ColorShift_Bottom: Color3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/ColorShift_Bottom.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

ColorShift_Top: Color3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/ColorShift_Top.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

EnvironmentDiffuseScale: float

This class member is missing documentation. Create or add to its subpage at Class:Lighting/EnvironmentDiffuseScale.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

EnvironmentSpecularScale: float

This class member is missing documentation. Create or add to its subpage at Class:Lighting/EnvironmentSpecularScale.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

ExposureCompensation: float

This class member is missing documentation. Create or add to its subpage at Class:Lighting/ExposureCompensation.

• Category: Exposure.
• Serialization: can save and load.
• Thread safety: read safe

FogColor: Color3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/FogColor.

• Category: Fog.
• Serialization: can save and load.
• Thread safety: read safe

FogEnd: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/FogEnd.

• Category: Fog.
• Serialization: can save and load.
• Thread safety: read safe

FogStart: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/FogStart.

• Category: Fog.
• Serialization: can save and load.
• Thread safety: read safe

GeographicLatitude: float

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/GeographicLatitude.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

GlobalShadows: bool

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/GlobalShadows.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Intent: Intent

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/Intent.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

OutdoorAmbient: Color3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/OutdoorAmbient.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Outlines: bool

• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/Outlines.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Quality: Quality

• Not scriptableThis member cannot be accessed by Lua code.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/Quality.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

ShadowColor: Color3

• Not replicatedThis member is not replicated across the network boundary.
• DeprecatedThis member will be phased out and should be avoided while it is still available.

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/ShadowColor.

• Category: Appearance.
• Serialization: can load only.
• Thread safety: read safe

ShadowSoftness: float

This class member is missing documentation. Create or add to its subpage at Class:Lighting/ShadowSoftness.

• Category: Appearance.
• Serialization: can save and load.
• Thread safety: read safe

Technology: Technology

This class member is missing documentation. Create or add to its subpage at Class:Lighting/Technology.

• Category: Appearance.
• Read security: RobloxScriptSecurity.
• Write security: RobloxScriptSecurity.
• Serialization: can save and load.
• Thread safety: read safe

TimeOfDay: string

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/TimeOfDay.

• Category: Data.
• Serialization: can save and load.
• Thread safety: read safe

Methods

GetMinutesAfterMidnight(): double

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/GetMinutesAfterMidnight.

• Thread safety: safe

GetMoonDirection(): Vector3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/GetMoonDirection.

• Thread safety: safe

GetMoonPhase(): float

This method was intended to get a value indicating the current phase of the moon. Moon phases were never officially implemented, and this method will always return 0.75.

• Thread safety: unsafe

GetSunDirection(): Vector3

This API member has existing documentation in this page's Member list template.

This class member is missing documentation. Create or add to its subpage at Class:Lighting/GetSunDirection.

• Thread safety: safe

SetMinutesAfterMidnight(minutes: double): null

Parameters

Name	Type
minutes	double

• Thread safety: unsafe

getMinutesAfterMidnight(): double

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Use GetMinutesAfterMidnight instead.

• Thread safety: unsafe

setMinutesAfterMidnight(minutes: double): null

• DeprecatedThis member will be phased out and should be avoided while it is still available.

Parameters

Name	Type
minutes	double

Use SetMinutesAfterMidnight instead.

• Thread safety: unsafe

Events

LightingChanged(skyChanged: bool)

Parameters

Name	Type
skyChanged	bool

• Thread safety: unsafe

Removed members

Properties

• LegacyOutlines
• TempUseNewSkyRemovalBehaviour

External links

• Lighting in the Roblox Creator Documentation
• Lighting in the Roblox API Reference