Lighting

Class fields

Field	XML type	Value
`Name`	string	Lighting
`ExplorerOrder`	string	3
`ExplorerImageIndex`	string	13
`summary`	string	Responsible for all lighting aspects of the world (affects how things are rendered).

Properties

Ambient

Color3

Field	XML type	Value
`Name`	string	Ambient
`summary`	string	The hue of the global lighting. Changing this changes the color tint of all objects in the Workspace.

Brightness

float

Field	XML type	Value
`Name`	string	Brightness
`summary`	string	How much global light each Part in the Workspace receives. Standard range is 0 to 1 (0 being little light), but can be increased all the way to 5 (colors start to be appear very different at this value).

ClockTime

float

Field	XML type	Value
`Name`	string	ClockTime

ColorShift_Bottom

Color3

Field	XML type	Value
`Name`	string	ColorShift_Bottom
`summary`	string	The hue of global lighting on the bottom surfaces of an object.

ColorShift_Top

Color3

Field	XML type	Value
`Name`	string	ColorShift_Top
`summary`	string	The hue of global lighting on the top surfaces of an object.

FogColor

Color3

Field	XML type	Value
`Name`	string	FogColor
`summary`	string	A Color3 value that changes the hue of distance fog.

FogEnd

float

Field	XML type	Value
`Name`	string	FogEnd
`summary`	string	The distance at which fog completely blocks your vision. This distance is relative to the camera position. Units are in studs

FogStart

float

Field	XML type	Value
`Name`	string	FogStart
`summary`	string	The distance at which the fog gradient begins. This distance is relative to the camera position. Units are in studs.

GeographicLatitude

float

Field	XML type	Value
`Name`	string	GeographicLatitude
`summary`	string	The latitude position the level is placed at. This affects sun position. <a href="http://wiki.roblox.com/index.php/GeographicLatitude" target="_blank">More info</a>

GlobalShadows

bool

Field	XML type	Value
`Name`	string	GlobalShadows
`summary`	string	Flag enabling shadows from sun and moon in the place

OutdoorAmbient

Color3

Field	XML type	Value
`Name`	string	OutdoorAmbient
`summary`	string	Effective ambient value for outdoors, effectively shadow color outdoors (requires GlobalShadows enabled)

Outlines

bool

Field	XML type	Value
`Name`	string	Outlines
`summary`	string	Flag enabling or disabling outlines on parts and terrain

ShadowColor

Color3

Field	XML type	Value
`Name`	string	ShadowColor
`summary`	string	Color the shadows appear as. Shadows are drawn mostly for characters, but depending on the lighting will also show for Parts in the Workspace. Rendering settings can also affect if shadows are drawn.

TimeOfDay

string

Field	XML type	Value
`Name`	string	TimeOfDay
`summary`	string	A string that represent the current time of day. Time is in 24-hour clock format "XX::YY:ZZ", where X is hour, Y is minute, and Z is seconds.

Functions

GetMinutesAfterMidnight

() → double

Field	XML type	Value
`Name`	string	GetMinutesAfterMidnight
`summary`	string	The number of minutes that the current time is past midnight. If currently at midnight, returns 0. Will return decimal values if not at an exact minute.

GetMoonDirection

() → Vector3

Field	XML type	Value
`Name`	string	GetMoonDirection
`summary`	string	Returns the lookVector (Vector3) of the moon. If this lookVector was used in a CFrame, the Part would face the moon.

GetMoonPhase

() → float

Field	XML type	Value
`Name`	string	GetMoonPhase
`summary`	string	Currently always returns 0.75. MoonPhase cannot be edited.

GetSunDirection

() → Vector3

Field	XML type	Value
`Name`	string	GetSunDirection
`summary`	string	Returns the lookVector (Vector3) of the sun. If this lookVector was used in a CFrame, the Part would face the moon.

SetMinutesAfterMidnight

(minutes: double) → void

Field	XML type	Value
`Name`	string	SetMinutesAfterMidnight
`summary`	string	Sets the time to be a certain number of minutes after midnight. This works with integer and decimal values.

getMinutesAfterMidnight

() → double

Field	XML type	Value
`Name`	string	getMinutesAfterMidnight

setMinutesAfterMidnight

(minutes: double) → void

Field	XML type	Value
`Name`	string	setMinutesAfterMidnight

Events

LightingChanged

(skyboxChanged: bool) → void

Field	XML type	Value
`Name`	string	LightingChanged
`summary`	string	Fired whenever a property of Lighting is changed, or a skybox is added or removed. Skyboxes are of type 'Sky' and should be parented directly to lighting.