RBX.lua.Sky (Object): Difference between revisions

From Legacy Roblox Wiki
Jump to navigationJump to search
>Mindraker
>Wyoming
New layout and description.
Line 1: Line 1:
{{CatUp|Class reference}}
__NOTOC__ {{CatUp|Class reference}}
__NOTOC__


Sky is an object that makes the sky section of your choice the picture of your choice. Just like a simple cube, the sky object has 6 sides. Make each side the same picture... or make it look like a room. The default skybox (if no "Sky" object is present in the [[Lighting]]) is a blue sky with clouds. The Moon, Sun, and other main sky decals will always be present even if the SkyBox decals differ from the default. The skybox decals are just regular decals that any user can upload. The default decals can be found under the Roblox textures folder. If you visit a place with another SkyBox you can find the texture at "C:\Documents and Settings\All Users\Application Data\ROBLOX\Cache", the roblox Cache files.
<div class="tabber">
<div class="tabbertab" title="Info">
{| cellspacing=2 cellpadding=4 border=0 width=100%


==Functions==
|style="vertical-align:top"|{{:Object:Sky}}
The Sky object only incorporates the global functions.
|style="vertical-align:top"|{{LeftNoticeStart}}


==Properties==
The Sky object is an object, when placed inside [[Lighting]], will change the appearance of the game's sky. This allows for a custom sky to be used as opposed to the [[Roblox]] default sky. The Skybox is composed of six sides, much like that of a cube. If the skybox is changed/customised, the Sun and other objects in the sky will remain visible, unless you turn off the Sky object's [[CelestialBodiesShown (Property)|CelestialBodiesShown]] property, which will remove the Sun, Moon, and stars from the sky. The recommended picture dimensions for a Skybox side are 512x512 pixels. By adjusting the [[StarCount (Property)|StarCount]] property of the Sky object, you can change how many stars will appear in the sky at night.
In addition to the Global properties, the Sky also uses these.
*[[CelestialBodiesShown (Property)|CelestialBodiesShown]]
*[[SkyboxBk (Property)|SkyboxBk]]
*[[SkyboxDn (Property)|SkyboxDn]]
*[[SkyboxFt (Property)|SkyboxFt]]
*[[SkyboxLf (Property)|SkyboxLf]]
*[[SkyboxRt (Property)|SkyboxRt]]
*[[SkyboxUp (Property)|SkyboxUp]]
*[[StarCount (Property)|StarCount]]


==Events==
'''See Also'''
The Sky object only incorporates the global events.
*[[Decals]]
*[[How to make changes to the skybox]]


== See Also ==
|}
 
|}
*[[How to make changes to the skybox]]
</div>
*[[Decals|How to Upload Decals]]
<div class="tabbertab" title="Methods">
{{:Clone (Function)}}
{{:FindFirstChild (Function)}}
{{:GetChildren (Function)}}
{{:GetFullName (Function)}}
{{:IsA (Function)}}
{{:IsAncestorOf (Function)}}
{{:IsDescendantOf (Function)}}
{{:Remove (Function)}}
</div>
<div class="tabbertab" title="Properties">
{{:Name (Property)}}
{{:Parent (Property)}}
{{:Archivable (Property)}}
{{:ClassName (Property)}}
{{:CelestialBodiesShown (Property)}}
{{:SkyboxDn (Property)}}
{{:SkyboxUp (Property)}}
{{:SkyboxLf (Property)}}
{{:SkyboxRt (Property)}}
{{:SkyboxFt (Property)}}
{{:SkyboxBk (Property)}}
{{:StarCount (Property)}}
</div>
<div class="tabbertab" title="Events">
{{:AncestryChanged (Event)}}
{{:Changed (Event)/property}}
{{:ChildAdded (Event)}}
{{:ChildRemoved (Event)}}
{{:DescendantAdded (Event)}}
{{:DescendantRemoving (Event)}}
</div>
</div>


[[Category:ROBLOX Lua Objects]]
[[Category:ROBLOX Lua Objects]]

Revision as of 16:45, 27 August 2010

[]
Sky
Sky (extends Instance)
method Clone
method FindFirstChild
method GetChildren
method GetDebugId
method GetFullName
method IsA
method IsAncestorOf
method IsDescendantOf
method Destroy
method ClearAllChildren
property CelestialBodiesShown
property SkyboxBk
property SkyboxDn
property SkyboxFt
property SkyboxLf
property SkyboxRt
property SkyboxUp
property StarCount
property Name
property Parent
property Archivable
property ClassName
property RobloxLocked
property DataCost
event AncestryChanged
event Changed
event ChildAdded
event ChildRemoved
event DescendantAdded
event DescendantRemoving

The Sky object is an object, when placed inside Lighting, will change the appearance of the game's sky. This allows for a custom sky to be used as opposed to the Roblox default sky. The Skybox is composed of six sides, much like that of a cube. If the skybox is changed/customised, the Sun and other objects in the sky will remain visible, unless you turn off the Sky object's CelestialBodiesShown property, which will remove the Sun, Moon, and stars from the sky. The recommended picture dimensions for a Skybox side are 512x512 pixels. By adjusting the StarCount property of the Sky object, you can change how many stars will appear in the sky at night.

See Also

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
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
Remove( )
Returns nil
Description: Sets the Parent property to nil and calls Remove() on all children.
Member of: Instance
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
CelestialBodiesShown
Property Bool
Description If true, the sun, moon, and stars will show.
Member of Sky
SkyboxDn
Property Content Content
Description The URL asset link to a picture for the Bottom surface of the sky.
Member of Sky
SkyboxUp
Property Content Content
Description The URL link to a picture for the top surface of the sky.
Member of Sky
SkyboxLf
Property Content Content
Description The URL link to a picture for the left surface of the sky.
Member of Sky
SkyboxRt
Property Content Content
Description The URL link to a picture for the right surface of the sky.
Member of Sky
SkyboxFt
Property Content Content
Description The URL link to a picture for the front surface of the skybox.
Member of Sky
SkyboxBk
Property Content Content
Description The URL link to a picture for the back surface of the sky.
Member of Sky
StarCount
Property Number
Description How many stars are shown in the skybox, too many stars may cause severe lag. Only works if CelestialBodiesShown is true.
Member of Sky
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