RBX.lua.Lighting (Object)

From Legacy Roblox Wiki
Revision as of 21:27, 19 February 2012 by >Flurite
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search
This is a Game Service; it cannot be created with Instance.new - it must be obtained using the GetService method, or as a child of game.
Derived Classes
None
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. All scripts under Lighting will not run and models will not be shown in the 3D environment, which makes this service a common place for objects to be stored.
GetMinutesAfterMidnight( )
Returns double
Description: The amount of minutes that have passed after midnight.
Member of: Lighting
GetMoonDirection( )
Returns Vector3
Description: It returns the lookVector of the moon. If this lookVector was used in a CFrame, the BasePart would face the moon.
Member of: Lighting
GetMoonPhase( )
Returns float 0.75
Description: Returns 0.75.
Member of: Lighting
GetSunDirection( )
Returns Vector3 sun direction
Description: Returns a lookVector value of a CFrame directed at at the current position of the sun.
Member of: Lighting
SetMinutesAfterMidnight( number minutes )
Returns nil
Description: Sets the amount of minutes that have passed after midnight.
Member of: Lighting
Clone( )
Returns Instance
Description: Returns a clone of the object and its children, unless its Archivable property is false. The clone will have the same properties as the original object and the same descendants (except those with an Archivable property set to false). The clone's Parent will be nil.
Member of: Instance
FindFirstChild( string name, bool recursive = false )
Returns Instance
Description: Returns the first child found with a name of name. Returns nil if no such child exists. If the optional recursive argument is true, will recursively descend the hierarchy while searching rather than only searching the immediate object.
Member of: Instance
GetChildren( )
Returns table
Description: Returns a read-only table of the object's children.
Member of: Instance
GetDebugId( int scopeLength )
Returns string
Description: Returns a coded string of the object's DebugId used internally by Roblox.
Member of: Instance
GetFullName( )
Returns String path to object
Description: Returns a string with a dot (.) character separating a path of object hierarchy excluding "game".
Member of: Instance
IsA( string className )
Returns bool
Description: Returns true if the Instance is that class or a subclass.
Member of: Instance
IsAncestorOf( Instance descendant )
Returns boolean is ancestor
Description: Returns true if the object is an ancestor of descendant.
Member of: Instance
IsDescendantOf( Instance ancestor )
Returns bool
Description: Returns true if the object is an descendant of ancestor.
Member of: Instance
Destroy( )
Returns nil
Description: Sets the Parent property to nil, locks the Parent property, disconnects all connections and calls Destroy() on all children.
Member of: Instance
ClearAllChildren( )
Returns nil
Description: Removes all descendants of the Instance, but leaves the Instance itself.
Member of: Instance
Ambient
Type Color3
Description Changes the hue of the global lighting in the Workspace.
Member of Lighting
Brightness
Property Number
Description The greater the number, the greater the illumination of the place
Member of Lighting
ColorShift_Bottom
Property Color3 bottom color
Description The hue in which is represented when light reflects off the bottom surface of a rendered object.
Member of Lighting
ColorShift_Top
Property Color3 top color
Description The hue in which is represented when light reflects off the top surface of a rendered object.
Member of Lighting
GeographicLatitude
Property Number Latitude
Description The latitude which affects the result of the TimeOfDay property.
Member of Lighting
ShadowColor
Property Color3 ShadowColor
Description The colour of shadows. (Can be switched on through Roblox studio settings)
Member of Lighting
TimeOfDay
Property String time of day
Description Sky phase according to time in string, where 1 AM is "01:00:00", and 1 PM is "13:00:00".
Member of Lighting
FogColor
Property Color3 FogColor
Description A Color3 value that changes the hue of distance fog.
Member of Lighting
FogEnd
Property Int FogEnd
Description The distance at which fog completely blocks your vision. This distance is relative to the camera position. Units are in studs
Member of Lighting
FogStart
Property Int FogStart
Description The distance at which the fog gradient begins. This distance is relative to the camera position. Units are in studs.
Member of Lighting
Name
Type string
Description The name of the object, which is often used to identify it in the context of its parent. Note that names are not unique identifiers; multiple children of an object may share the same name. In a script where you want to access an object using a name, for example, game.Workspace["Brick"], the first object found with that name is that object. This "first object" can be found in the Explorer menu.Names are great for showing a very brief title or summary of an object.
Member of Instance
Parent
Type Instance
Description The hierarchical parent of the object. When no scripts hold references to an object, it will still be maintained as long as it's parent is set to an object which does have references to it, either by other objects or scripts. The toplevel DataModel object (the one referred to as the "game" by scripts) has no parent, but always has a reference held to it by the game engine, and exists for the duration of a session.
Member of Instance
Archivable
Type bool
Description Sets whether or not the object is saved when publishing or saving to file. Also sets whether or not the object is clonable.
Member of Instance
ClassName
Type string
Description A unique string per type of Instance. Should only be used as a unique identifier, as it does not reveal any information about nature of the type hierarchy the type is in. For this use, see IsA.
Member of Instance
RobloxLocked
Type bool
Description 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.
Member of Instance
DataCost
Type int
Description How much saving this instance with SaveInstance will add to DataComplexity
Member of Instance
LightingChanged ( Bool skyboxChanged )
Description Fires when a property of Lighting is changed, or a Skybox is added or removed.
Member of: Lighting
AncestryChanged ( Instance child, Instance parent )
Description Fired when an ancestor of the Instance the event which is a member of child has its parent changed to parent.
Member of: Instance
Changed ( Property property )
Description Fired whenever a property of the object changes.
Member of: Instance
ChildAdded ( Instance child )
Description Fired after a child is added.
Member of: Instance
ChildRemoved ( Instance child )
Description Fired when a child is removed from the object.
Member of: Instance
DescendantAdded ( Instance descendant )
Description Fired when a descendant is added to the object.
Member of: Instance
DescendantRemoving ( Instance descendant )
Description Fired when a descendant is being removed.
Member of: Instance