Properties
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
[NotReplicated]
|
A numerical representation (in hours) of the current time of day used by |
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. |
float
|
Ambient light that is derived from the environment |
float
|
Specular light derived from environment |
float
|
The exposure compensation value |
Color3
|
A |
float
|
The depth from the |
float
|
The depth from the |
float
|
The geographic latitude, in degrees, of the scene, influencing the result of |
bool
|
Toggles voxel-based dynamic lighting for the game |
Color3
|
The lighting hue applied to outdoor areas. |
bool
[Deprecated]
|
Determines whether outlines are enabled or disabled in a place |
Color3
[NotReplicated]
[Deprecated]
|
This is supposed to change the color of player shadows, but currently doesn’t do anything. |
float
|
Controls how blurry the shadows are |
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
|
A 24 hour string representation of the current time of day used by |
bool
|
Determines if an |
string
[ReadOnly]
[NotReplicated]
|
A read-only string representing the class this |
int
[ReadOnly]
[NotReplicated]
[Deprecated]
|
The cost of saving the instance using data persistence. |
string
|
A non-unique identifier of the |
Instance
[NotReplicated]
|
Determines the hierarchical parent of the |
bool
|
A deprecated property that used to protect |
bool
[Hidden]
[NotReplicated]
[Deprecated]
|
string
[ReadOnly]
[NotReplicated]
[Deprecated]
|
Functions
double
|
Returns the number of minutes that have passed after midnight for the purposes of lighting. |
Vector3
|
Returns a |
float
|
Returns the moon’s current phase |
Vector3
|
Returns a |
void
|
Sets |
double
[Deprecated]
|
void
[Deprecated]
|
void
|
This function destroys all of an |
Instance
|
Create a copy of an object and all its descendants, ignoring objects that are not |
void
|
Sets the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first ancestor of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first child of the |
Instance
|
Returns the first child of the |
Instance
|
Variant
|
Returns the attribute which has been assigned to the given name |
RBXScriptSignal
|
Returns an event that fires when the given attribute changes |
Dictionary
|
Returns a dictionary of string → variant pairs for each of the |
Objects
|
Returns an array containing all of the |
string
[NotBrowsable]
|
Returns a coded string of the |
Array
[CustomLuaState]
|
Returns an array containing all of the descendants of the instance |
string
|
Returns a string describing the |
RBXScriptSignal
|
Get an event that fires when a given property of an object changes. |
bool
[CustomLuaState]
|
Returns true if an |
bool
|
Returns true if an |
bool
|
Returns true if an |
void
[Deprecated]
|
Sets the object’s Parent to nil, and does the same for all its descendants. |
void
|
Sets the attribute with the given name to the given value |
Instance
[CustomLuaState]
[CanYield]
|
Returns the child of the |
Objects
[Deprecated]
|
Returns an array of the object’s children. |
Instance
[Deprecated]
|
void
[Deprecated]
|
Instance
[Deprecated]
|
Objects
[Deprecated]
|
bool
[Deprecated]
[CustomLuaState]
|
bool
[Deprecated]
|
void
[Deprecated]
|
Events
RBXScriptSignal
|
This event fires when a |
RBXScriptSignal
|
Fires when the |
RBXScriptSignal
|
Fires whenever an attribute is changed on the |
RBXScriptSignal
|
Fired immediately after a property of an object changes. |
RBXScriptSignal
|
Fires when an object is parented to this |
RBXScriptSignal
|
Fires when a child is removed from this |
RBXScriptSignal
|
Fires when a descendant is added to the |
RBXScriptSignal
|
Fires immediately before a descendant of the |
RBXScriptSignal
[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.