API:Class/Lighting

Service: This class is a service. It is a top-level singleton which can be obtained with the GetService method.
Uncreatable: This object cannot be created with Instance.new.

Lighting icon.pngLighting : Object Icon.pngInstance

The Lighting service controls all of the environmental variables in a map, including the colors of light, time of day, angle of celestial bodies, etc.
The Lighting service was commonly used for storage since scripts did not run and models weren't rendered. However, ServerStorage and ReplicatedStorage should now be used for this purpose instead.

Properties

PropertiesmemberhiddenProperties [toggle]

Color3Ambient

Changes the hue of the indoor lighting in the Workspace.

|RMD member="API:Class/Lighting/Ambient"|Changes the hue of the indoor lighting in the Workspace.|/RMD|
floatBrightness

Represents the intensity of the place's illumination.

|RMD member="API:Class/Lighting/Brightness"|Represents the intensity of the place's illumination.|/RMD|
floatClockTime

A float that describes how many hours have elapsed into the current scene's day.

|RMD member="API:Class/Lighting/ClockTime"|A float that describes how many hours have elapsed into the current scene's day.|/RMD|
Color3ColorShift_Bottom

The hue which is represented when light reflects off the bottom surface of a rendered object.

|RMD member="API:Class/Lighting/ColorShift_Bottom"|The hue which is represented when light reflects off the bottom surface of a rendered object.|/RMD|
Color3ColorShift_Top

The hue which is represented when light reflects off the top surface of a rendered object.

|RMD member="API:Class/Lighting/ColorShift_Top"|The hue which is represented when light reflects off the top surface of a rendered object.|/RMD|
Color3FogColor

A Color3 value that changes the hue of distance fog.

|RMD member="API:Class/Lighting/FogColor"| A Color3 value that changes the hue of distance fog.|/RMD|
floatFogEnd

The distance at which the fog completely blocks your vision. This distance is relative to the camera's position, and is measured in studs.

|RMD member="API:Class/Lighting/FogEnd"|The distance at which the fog completely blocks your vision. This distance is relative to the camera's position, and is measured in studs.|/RMD|
floatFogStart

The distance at which the fog gradient begins. This distance is relative to the camera's position, and is measured in studs.

|RMD member="API:Class/Lighting/FogStart"|The distance at which the fog gradient begins. This distance is relative to the camera's position, and is measured in studs.|/RMD|
floatGeographicLatitude

Controls where the sun is in the sky by controlling which way the "Earth" is tilted on ROBLOX, affecting the result of the TimeOfDay property.

|RMD member="API:Class/Lighting/GeographicLatitude"|Controls where the sun is in the sky by controlling which way the "Earth" is tilted on ROBLOX, affecting the result of the TimeOfDay property.|/RMD|
boolGlobalShadows

Toggles dynamic lighting for the place. If set to true, dynamic lighting will be enabled.

|RMD member="API:Class/Lighting/GlobalShadows"| Toggles dynamic lighting for the place. If set to true, dynamic lighting will be enabled.|/RMD|
Color3OutdoorAmbient

Changes the hue of the outdoor lighting in the Workspace.

|RMD member="API:Class/Lighting/OutdoorAmbient"| Changes the hue of the outdoor lighting in the Workspace.|/RMD|
boolOutlines

Allows you to enable or disable all outlines in a place.

|RMD member="API:Class/Lighting/Outlines"| Allows you to enable or disable all outlines in a place.|/RMD|
stringTimeOfDay

The sky's current phase based on a string representation of a 24 hour clock.

|RMD member="API:Class/Lighting/TimeOfDay"|The sky's current phase based on a string representation of a 24 hour clock.|/RMD|
Color3ShadowColor [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Lighting/ShadowColor"|Deprecated. Do not use.|/RMD|
Changes the hue of the indoor lighting in the Workspace.
Represents the intensity of the place's illumination.
A float that describes how many hours have elapsed into the current scene's day.
The hue which is represented when light reflects off the bottom surface of a rendered object.
The hue which is represented when light reflects off the top surface of a rendered object.
A Color3 value that changes the hue of distance fog.
The distance at which the fog completely blocks your vision. This distance is relative to the camera's position, and is measured in studs.
The distance at which the fog gradient begins. This distance is relative to the camera's position, and is measured in studs.
Controls where the sun is in the sky by controlling which way the "Earth" is tilted on ROBLOX, affecting the result of the TimeOfDay property.
Toggles dynamic lighting for the place. If set to true, dynamic lighting will be enabled.
Changes the hue of the outdoor lighting in the Workspace.
Allows you to enable or disable all outlines in a place.
The sky's current phase based on a string representation of a 24 hour clock.
ShadowColor [deprecated]
Deprecated. Do not use.
Inherited from Object Icon.pngInstance:
boolArchivable

Determines if an object can be Clone or saved to file.

|RMD member="API:Class/Instance/Archivable"|Determines if an object can be Clone or saved to file.|/RMD|
stringClassName [readonly]

The unique name of this type of Instance.

|RMD member="API:Class/Instance/ClassName"|The unique name of this type of Instance.|/RMD|
stringName

A non-unique identifier for the object.

|RMD member="API:Class/Instance/Name"|A non-unique identifier for the object.|/RMD|
intDataCost [LocalUserSecurity] [deprecated] [readonly]

Deprecated. Do not use.

|RMD member="API:Class/Instance/DataCost"|Deprecated. Do not use.|/RMD|
boolRobloxLocked [PluginSecurity]

If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.

|RMD member="API:Class/Instance/RobloxLocked"|If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.|/RMD|
boolarchivable [deprecated] [hidden]

Deprecated in favor of Archivable.

|RMD member="API:Class/Instance/archivable"|Deprecated in favor of Archivable.|/RMD|
stringclassName [deprecated] [readonly]

Deprecated in favor of ClassName.

|RMD member="API:Class/Instance/className"|Deprecated in favor of ClassName.|/RMD|
Determines if an object can be Clone or saved to file.
ClassName [readonly]
The unique name of this type of Instance.
A non-unique identifier for the object.
DataCost [LocalUserSecurity] [deprecated] [readonly]
Deprecated. Do not use.
RobloxLocked [PluginSecurity]
If true, the object and its descendants cannot be indexed or edited by a Script or LocalScript and will throw an error if it is attempted.
archivable [deprecated] [hidden]
Deprecated in favor of Archivable.
className [deprecated] [readonly]
Deprecated in favor of ClassName.

Functions

FunctionsmemberhiddenFunctions [toggle]

doubleGetMinutesAfterMidnight ( )

The amount of minutes that have passed after midnight.

|RMD member="API:Class/Lighting/GetMinutesAfterMidnight"|The amount of minutes that have passed after midnight.|/RMD|
Vector3GetMoonDirection ( )

Returns a LookVector value of a CFrame directed at the current position of the moon.

|RMD member="API:Class/Lighting/GetMoonDirection"|Returns a LookVector value of a CFrame directed at the current position of the moon.|/RMD|
Vector3GetSunDirection ( )

Returns a LookVector value of a CFrame directed at the current position of the sun.

|RMD member="API:Class/Lighting/GetSunDirection"|Returns a LookVector value of a CFrame directed at the current position of the sun.|/RMD|
voidSetMinutesAfterMidnight ( double minutes )

Sets the amount of minutes that have passed after midnight.

|RMD member="API:Class/Lighting/SetMinutesAfterMidnight"|Sets the amount of minutes that have passed after midnight.|/RMD|
floatGetMoonPhase ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Lighting/GetMoonPhase"|Deprecated. Do not use.|/RMD|
doublegetMinutesAfterMidnight ( ) [deprecated]

Deprecated in favor of GetMinutesAfterMidnight.

|RMD member="API:Class/Lighting/getMinutesAfterMidnight"|Deprecated in favor of GetMinutesAfterMidnight.|/RMD|
voidsetMinutesAfterMidnight ( double minutes ) [deprecated]

Deprecated in favor of SetMinutesAfterMidnight.

|RMD member="API:Class/Lighting/setMinutesAfterMidnight"|Deprecated in favor of SetMinutesAfterMidnight.|/RMD|
The amount of minutes that have passed after midnight.
Returns a LookVector value of a CFrame directed at the current position of the moon.
Returns a LookVector value of a CFrame directed at the current position of the sun.
Sets the amount of minutes that have passed after midnight.
GetMoonPhase ( ) [deprecated]
Deprecated. Do not use.
getMinutesAfterMidnight ( ) [deprecated]
Deprecated in favor of GetMinutesAfterMidnight.
setMinutesAfterMidnight ( double minutes ) [deprecated]
Deprecated in favor of SetMinutesAfterMidnight.
Inherited from Object Icon.pngInstance:
voidClearAllChildren ( )

Removes all descendants of the object.

|RMD member="API:Class/Instance/ClearAllChildren"|Removes all descendants of the object.|/RMD|
Ref<Instance>FindFirstAncestor ( string name )

Returns the first ancestor whose Name is equal to name, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestor"|Returns the first ancestor whose Name is equal to name, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorOfClass ( string className )

Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorOfClass"|Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstAncestorWhichIsA"|Returns the first ancestor that inherits the class className, or nil if none can be found.|/RMD|
Ref<Instance>FindFirstChild ( string name, bool recursive = false )

Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.

|RMD member="API:Class/Instance/FindFirstChild"|Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.|/RMD|
Ref<Instance>FindFirstChildOfClass ( string className )

Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.

|RMD member="API:Class/Instance/FindFirstChildOfClass"|Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.|/RMD|
Ref<Instance>FindFirstChildWhichIsA ( string className, bool recursive = false )

Returns the first child that inherits the class className, or nil if none can be found.

|RMD member="API:Class/Instance/FindFirstChildWhichIsA"|Returns the first child that inherits the class className, or nil if none can be found.|/RMD|
array<Instance>GetChildren ( )

Returns an array of the object's children.

|RMD member="API:Class/Instance/GetChildren"|Returns an array of the object's children.|/RMD|
array<Instance>GetDescendants ( )

Returns an array containing all of the descendants of the instance.

|RMD member="API:Class/Instance/GetDescendants"|Returns an array containing all of the descendants of the instance.|/RMD|
stringGetFullName ( )

Returns a string which shows the object's ancestry chain.

|RMD member="API:Class/Instance/GetFullName"|Returns a string which shows the object's ancestry chain.|/RMD|
RBXScriptSignalGetPropertyChangedSignal ( string property )

Returns a signal that is fired when the specified property is changed on this object.

|RMD member="API:Class/Instance/GetPropertyChangedSignal"|Returns a signal that is fired when the specified property is changed on this object.|/RMD|
boolIsA ( string className )

Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.

|RMD member="API:Class/Instance/IsA"|Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.|/RMD|
boolIsAncestorOf ( Instance descendant )

Returns true if the object is an ancestor of the given descendant.

|RMD member="API:Class/Instance/IsAncestorOf"|Returns true if the object is an ancestor of the given descendant.|/RMD|
boolIsDescendantOf ( Instance ancestor )

Returns true if the object is a descendant of the given ancestor.

|RMD member="API:Class/Instance/IsDescendantOf"|Returns true if the object is a descendant of the given ancestor.|/RMD|
Ref<Instance>WaitForChild ( string childName, double timeOut )

Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.

|RMD member="API:Class/Instance/WaitForChild"|Yields the current thread until a child with the given name is found, then returns the child.

If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.|/RMD|

stringGetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]

Returns a coded string of the object's DebugId used internally by Roblox.

|RMD member="API:Class/Instance/GetDebugId"|Returns a coded string of the object's DebugId used internally by Roblox.|/RMD|
voidRemove ( ) [deprecated]

Deprecated. Do not use.

|RMD member="API:Class/Instance/Remove"|Deprecated. Do not use.|/RMD|
array<Instance>children ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/children"|Deprecated in favor of GetChildren.|/RMD|
voiddestroy ( ) [deprecated]

Deprecated in favor of Destroy.

|RMD member="API:Class/Instance/destroy"|Deprecated in favor of Destroy.|/RMD|
InstancefindFirstChild ( string name, bool recursive = false ) [deprecated]

Deprecated in favor of FindFirstChild.

|RMD member="API:Class/Instance/findFirstChild"|Deprecated in favor of FindFirstChild.|/RMD|
array<Instance>getChildren ( ) [deprecated]

Deprecated in favor of GetChildren.

|RMD member="API:Class/Instance/getChildren"|Deprecated in favor of GetChildren.|/RMD|
boolisA ( string className ) [deprecated]

Deprecated in favor of IsA.

|RMD member="API:Class/Instance/isA"|Deprecated in favor of IsA.|/RMD|
boolisDescendantOf ( Instance ancestor ) [deprecated]

Deprecated in favor of IsDescendantOf.

|RMD member="API:Class/Instance/isDescendantOf"|Deprecated in favor of IsDescendantOf.|/RMD|
Removes all descendants of the object.
Returns the first ancestor whose Name is equal to name, or nil if none can be found.
Returns the first ancestor whose ClassName is equal to className, or nil if none can be found.
Returns the first ancestor that inherits the class className, or nil if none can be found.
FindFirstChild ( string name, bool recursive = false )
Returns the first child found with the given name, or nil if no such child exists. If the optional recursive argument is true, recursively descends the hierarchy while searching rather than only searching the immediate object.
Returns the first Instance whose ClassName is equal to className, or nil, if no such object is found with that ClassName.
FindFirstChildWhichIsA ( string className, bool recursive = false )
Returns the first child that inherits the class className, or nil if none can be found.
Returns an array of the object's children.
Returns an array containing all of the descendants of the instance.
Returns a string which shows the object's ancestry chain.
Returns a signal that is fired when the specified property is changed on this object.
IsA ( string className )
Returns true if the object is an instance of the given class, or if the object's class inherits from the given class.
IsAncestorOf ( Instance descendant )
Returns true if the object is an ancestor of the given descendant.
Returns true if the object is a descendant of the given ancestor.
WaitForChild ( string childName, double timeOut )
Yields the current thread until a child with the given name is found, then returns the child. If the timeOut parameter is specified, this function will time out and return nil if timeOut seconds elapse without the child being found.
GetDebugId ( int scopeLength = 4 ) [PluginSecurity] [notbrowsable]
Returns a coded string of the object's DebugId used internally by Roblox.
Remove ( ) [deprecated]
Deprecated. Do not use.
children ( ) [deprecated]
Deprecated in favor of GetChildren.
destroy ( ) [deprecated]
Deprecated in favor of Destroy.
findFirstChild ( string name, bool recursive = false ) [deprecated]
Deprecated in favor of FindFirstChild.
getChildren ( ) [deprecated]
Deprecated in favor of GetChildren.
isA ( string className ) [deprecated]
Deprecated in favor of IsA.
isDescendantOf ( Instance ancestor ) [deprecated]
Deprecated in favor of IsDescendantOf.


Events

EventsmemberhiddenEvents [toggle]

LightingChanged ( bool skyboxChanged )

Fires when a property specific to Lighting is changed, or a Skybox is added or removed.

|RMD member="API:Class/Lighting/LightingChanged"|Fires when a property specific to Lighting is changed, or a Skybox is added or removed.|/RMD|
LightingChanged ( bool skyboxChanged )
Fires when a property specific to Lighting is changed, or a Skybox is added or removed.
Inherited from Object Icon.pngInstance:
Changed ( string property )

Fires after a property of the object changes.

|RMD member="API:Class/Instance/Changed"|Fires after a property of the object changes.|/RMD|
ChildAdded ( Instance child )

Fires when a child is added to the object.

|RMD member="API:Class/Instance/ChildAdded"|Fires when a child is added to the object.|/RMD|
ChildRemoved ( Instance child )

Fires when a child is removed from the object.

|RMD member="API:Class/Instance/ChildRemoved"|Fires when a child is removed from the object.|/RMD|
DescendantAdded ( Instance descendant )

Fires when a descendant is added to the object.

|RMD member="API:Class/Instance/DescendantAdded"|Fires when a descendant is added to the object.|/RMD|
DescendantRemoving ( Instance descendant )

Fires before a descendant of the object is removed.

|RMD member="API:Class/Instance/DescendantRemoving"|Fires before a descendant of the object is removed.|/RMD|
childAdded ( Instance child ) [deprecated]

Deprecated in favor of ChildAdded.

|RMD member="API:Class/Instance/childAdded"|Deprecated in favor of ChildAdded.|/RMD|
Changed ( string property )
Fires after a property of the object changes.
Fires when a child is added to the object.
Fires when a child is removed from the object.
DescendantAdded ( Instance descendant )
Fires when a descendant is added to the object.
Fires before a descendant of the object is removed.
childAdded ( Instance child ) [deprecated]
Deprecated in favor of ChildAdded.

|RMD member="API:Class/Lighting"|The Lighting service controls all of the environmental variables in a map, including the colors of light, time of day, angle of celestial bodies, etc.
The Lighting service was commonly used for storage since scripts did not run and models weren't rendered. However, ServerStorage and ReplicatedStorage should now be used for this purpose instead. |/RMD|