PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar
  1. API Reference
  2. Lighting

Lighting

Show deprecated
Hide content
  1. apireference
  2. lighting

Lighting

Show deprecated
The Lighting service controls the environmental lighting in a game. It includes a range of adjustable properties that can be used to change how lighting appears and interacts with other objects.

Developers can change the color and appearance of lighting in their place using properties such as Lighting/Ambient and Lighting/OutdoorAmbient.

In addition to controlling environmental lighting, the Lighting service also configures any fog in the game using the Lighting/FogColor, Lighting/FogStart and Lighting/FogEnd properties.

Lighting, along with Workspace/CurrentCamera, is one of the two places where PostEffects such as the SunRaysEffect and BlurEffect are displayed once parented to.

Notes

  • Lighting only controls environmental lighting and not dynamic light objects such as the PointLight
  • Prior to the introduction of ServerStorage and ReplicatedStorage lighting was used for storage. This behavior is not supported and should not be used in new work

Properties

Color3

Ambient

The lighting hue applied to areas that are occluded from the sky, such as indoor areas
float

Brightness

The intensity of illumination in the place.
float

ClockTime

[NotReplicated]

A numerical representation (in hours) of the current time of day used by Lighting.
Color3

ColorShift_Bottom

The hue represented in light reflected in the opposite surfaces to those facing the sun or moon.
Color3

ColorShift_Top

The hue represented in light reflected from surfaces facing the sun or moon.
float

EnvironmentDiffuseScale

Ambient light that is derived from the environment
float

EnvironmentSpecularScale

Specular light derived from environment
float

ExposureCompensation

The exposure compensation value
Color3

FogColor

A DataType/Color3 value giving the hue of Lighting’s fog.
float

FogEnd

The depth from the Workspace/CurrentCamera, in studs, at which fog will be completely opaque.
float

FogStart

The depth from the Workspace/CurrentCamera, in studs, at which fog begins to show.
float

GeographicLatitude

The geographic latitude, in degrees, of the scene, influencing the result of Lightings time on the position of the sun and moon.
bool

GlobalShadows

Toggles voxel-based dynamic lighting for the game
Color3

OutdoorAmbient

The lighting hue applied to outdoor areas.
bool

Outlines

[Deprecated]

Determines whether outlines are enabled or disabled in a place
Color3

ShadowColor

[NotReplicated] [Deprecated]

This is supposed to change the color of player shadows, but currently doesn’t do anything.
float

ShadowSoftness

Controls how blurry the shadows are
Technology

Technology

[NotScriptable]

A temporary non-scriptable property that determines the lighting system used to render the 3D world (e.g. legacy, Future Is Bright, shadow map).
string

TimeOfDay

A 24 hour string representation of the current time of day used by Lighting.

Inherited from Instance: Show Hide

bool

Archivable

Determines if an Instance can be cloned using /Instance/Clone or saved to file.
string

ClassName

[ReadOnly] [NotReplicated]

A read-only string representing the class this Instance belongs to
int

DataCost

[Hidden] [ReadOnly] [NotReplicated] [Deprecated]

The cost of saving the instance using data persistence.
string

Name

A non-unique identifier of the Instance
Instance

Parent

[NotReplicated]

Determines the hierarchical parent of the Instance
bool

RobloxLocked

[Hidden]

A deprecated property that used to protect CoreGui objects
bool

archivable

[Hidden] [NotReplicated] [Deprecated]
string

className

[ReadOnly] [NotReplicated] [Deprecated]

Functions

double

GetMinutesAfterMidnight ( )

Returns the number of minutes that have passed after midnight for the purposes of lighting.
Vector3

GetMoonDirection ( )

Returns a DataType/Vector3 representing the direction of the moon from the position 0, 0, 0.
float

GetMoonPhase ( )

Returns the moon’s current phase
Vector3

GetSunDirection ( )

Returns a DataType/Vector3 representing the direction of the sun from the position 0, 0, 0.
void

SetMinutesAfterMidnight ( double minutes )

Sets Lighting/TimeOfDay and Lighting/ClockTime to the given number of minutes after midnight
double

getMinutesAfterMidnight ( )

[Deprecated]
void

setMinutesAfterMidnight ( double minutes )

[Deprecated]

Inherited from Instance: Show Hide

void

ClearAllChildren ( )

This function destroys all of an Instance’s children.
Instance

Clone ( )

Create a copy of an object and all its descendants, ignoring objects that are not Instance/Archivable|Archivable
void

Destroy ( )

Sets the Instance/Parent property to nil, locks the Instance/Parent property, disconnects all connections and calls Destroy on all children.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the Instance whose Instance/Name is equal to the given name.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the Instance whose Instance/ClassName is equal to the given className.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the Instance found with the given name.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|ClassName is equal to the given className.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the Instance for whom Instance/IsA returns true for the given className.
Instance

FindFirstDescendant ( string name )

Actor

GetActor ( )

Variant

GetAttribute ( string attribute )

Returns the attribute which has been assigned to the given name
RBXScriptSignal

GetAttributeChangedSignal ( string attribute )

Returns an event that fires when the given attribute changes
Dictionary

GetAttributes ( )

Returns a dictionary of string → variant pairs for each of the Instance|Instance’s attributes
Objects

GetChildren ( )

Returns an array containing all of the Instance’s children.
string

GetDebugId ( int scopeLength )

[NotBrowsable]

Returns a coded string of the Instances DebugId used internally by Roblox.
Array

GetDescendants ( )

[CustomLuaState]

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

GetFullName ( )

Returns a string describing the Instance’s ancestry.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
bool

IsA ( string className )

[CustomLuaState]

Returns true if an Instance’s class matches or inherits from a given class
bool

IsAncestorOf ( Instance descendant )

Returns true if an Instance is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an Instance is a descendant of the given ancestor.
void

Remove ( )

[Deprecated]

Sets the object’s Parent to nil, and does the same for all its descendants.
void

SetAttribute ( string attribute , Variant value )

Sets the attribute with the given name to the given value
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]

Returns the child of the Instance with the given name. If the child does not exist, it will yield the current thread until it does.
Objects

children ( )

[Deprecated]

Returns an array of the object’s children.
Instance

clone ( )

[Deprecated]
void

destroy ( )

[Deprecated]
Instance

findFirstChild ( string name , bool recursive )

[Deprecated]
Objects

getChildren ( )

[Deprecated]
bool

isA ( string className )

[Deprecated] [CustomLuaState]
bool

isDescendantOf ( Instance ancestor )

[Deprecated]
void

remove ( )

[Deprecated]

Events

RBXScriptSignal

LightingChanged ( bool skyChanged )

This event fires when a Lighting property is changed or a Sky is added or removed from Lighting.

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the Instance/Parent property of the object or one of its ancestors is changed.
RBXScriptSignal

AttributeChanged ( string attribute )

Fires whenever an attribute is changed on the Instance
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this Instance.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this Instance.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the Instance
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.
RBXScriptSignal

childAdded ( Instance child )

[Deprecated]

Code Samples

Day/Night Cycle

This code sample includes a simple day/night cycle script. The speed time goes at and the initial time can be changed using the TIME_SPEED and START_TIME parameters.

local Lighting = game:GetService("Lighting")

-- constants
local TIME_SPEED = 60 -- 1 min = 1 hour
local START_TIME = 9 -- 9am
--

local minutesAfterMidnight = START_TIME * 60
local waitTime = 60 / TIME_SPEED

while true do
	minutesAfterMidnight = minutesAfterMidnight + 1

	Lighting:SetMinutesAfterMidnight(minutesAfterMidnight)

	wait(waitTime)
end
Atmosphere PointLight