PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

Lighting

Show deprecated

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

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

Determines whether outlines are enabled or disabled in a place.

float

ShadowSoftness

Technology

Technology

[NotScriptable]

A (temporary) non-scriptable property used to determine whether the lighting system is legacy or Future-Is-Bright

string

TimeOfDay

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

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]

The cost of saving the instance using data persistence.

Instance

Parent

Determines the hierarchical parent of the Instance.

bool

RobloxLocked

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

string

ClassName

[ReadOnly] [NotReplicated]

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

string

Name

A non-unique identifier of the Instance.

bool

Archivable

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

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

Inherited from Instance: Show Hide

Instance

FindFirstChild ( string name , bool recursive )

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

Array

GetDescendants ( )

[CustomLuaState]

Returns an array containing all of the descendants of the instance

Objects

GetChildren ( )

Returns an array containing all of the Instance's children.

void

Destroy ( )

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

RBXScriptSignal

GetPropertyChangedSignal ( string property )

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

string

GetFullName ( )

Returns a string describing the Instance's ancestry.

Instance

FindFirstChildWhichIsA ( string className , bool recursive )

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

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.

Instance

FindFirstChildOfClass ( string className )

Returns the first child of the Instance whose Instance/ClassName|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

FindFirstAncestorOfClass ( string className )

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

Instance

FindFirstAncestor ( string name )

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

bool

IsA ( string className )

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

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.

string

GetDebugId ( int scopeLength )

[NotBrowsable]

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

Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where Archivable = true.

void

ClearAllChildren ( )

This function destroys all of an Instance's children.

Events

RBXScriptSignal

LightingChanged ( bool skyboxChanged )

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

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the Instance is removed.

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

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

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

Changed ( string property )

Fired immediately after a property of an object changes.