We use cookies on this site to enhance your user experience

Lighting

Lighting

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

Name Type Description
Color3

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

float

The intensity of illumination in the place.

float

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

Color3

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

Color3

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

Color3

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

float

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

float

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

float

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

bool

Toggles voxel-based dynamic lighting for the game

Color3

The lighting hue applied to outdoor areas.

bool

Determines whether outlines are enabled or disabled in a place.

string

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

Inherited from Instance

Archivable ClassName DataCost Name Parent RobloxLocked

Functions

Name Type Description
double

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

Vector3

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

float

Returns the moon’s current phase.

Vector3

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

void

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

Inherited from Instance

ClearAllChildren Clone Destroy FindFirstAncestor FindFirstAncestorOfClass FindFirstAncestorWhichIsA FindFirstChild FindFirstChildOfClass FindFirstChildWhichIsA GetChildren GetDebugId GetDescendants GetFullName GetPropertyChangedSignal IsA IsAncestorOf IsDescendantOf WaitForChild

Events

Name Type Description

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

Inherited from Instance

AncestryChanged Changed ChildAdded ChildRemoved DescendantAdded DescendantRemoving