Reference API Roblox

Engine API

Website

Related

Reference API Roblox

Sky

Changes the default appearance of the experience's sky.

Memory categoryInstances

Member index 12

HistoryMember
553CelestialBodiesShown: bool
553MoonAngularSize: float
645MoonTextureId: ContentId
645SkyboxBk: ContentId
645SkyboxDn: ContentId
645SkyboxFt: ContentId
645SkyboxLf: ContentId
645SkyboxRt: ContentId
645SkyboxUp: ContentId
553StarCount: int
553SunAngularSize: float
645SunTextureId: ContentId
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

The Sky object, when placed inside Lighting, changes the default appearance of the experience's sky. This object's skybox is composed of six sides, like a cube. If you customize the skybox, the sun, moon, and other celestial objects remain visible unless you turn off the CelestialBodiesShown property. By adjusting the StarCount property, you can change how many stars appear in the sky at night.

This object can also be used as a cubemap for reflections in ViewportFrames, in which case only the Sky object's six Skybox[…] properties are used. For details, see Frames.

History 57

Members 12

CelestialBodiesShown

TypeDefault
booltrue

Sets whether the sun, moon, and stars will show.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

MoonAngularSize

TypeDefault
float11

The perceived angular size of the moon while using this skybox, in degrees.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

MoonTextureId

TypeDefault
ContentIdrbxasset://sky/moon.jpg

The texture of the moon while using this skybox.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

SkyboxBk

TypeDefault
ContentIdrbxasset://textures/sky/sky512_bk.tex

The URL link to a picture for the back surface of the sky.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

SkyboxDn

TypeDefault
ContentIdrbxasset://textures/sky/sky512_dn.tex

Asset ID for the bottom surface of the skybox.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

SkyboxFt

TypeDefault
ContentIdrbxasset://textures/sky/sky512_ft.tex

Asset ID for the front surface of the skybox.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

SkyboxLf

TypeDefault
ContentIdrbxasset://textures/sky/sky512_lf.tex

Asset ID for the left surface of the skybox.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

SkyboxRt

TypeDefault
ContentIdrbxasset://textures/sky/sky512_rt.tex

Asset ID for the right surface of the skybox.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

SkyboxUp

TypeDefault
ContentIdrbxasset://textures/sky/sky512_up.tex

Asset ID for the top surface of the skybox.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

StarCount

TypeDefault
int3000

How many stars are shown in the skybox. Only works if CelestialBodiesShown is true.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

SunAngularSize

TypeDefault
float21

The perceived angular size of the sun while using this skybox, in degrees.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 4

SunTextureId

TypeDefault
ContentIdrbxasset://sky/sun.jpg

The texture of the sun while using this skybox.

Thread safetyReadSafe
CategoryAppearance
Loaded/Savedtrue

History 5

Settings