Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SunRaysEffect

Renders dynamic rays from the sun.

Memory categoryInstances

Member index 2

HistoryMember
553Intensity: float
553Spread: float
inherited from PostEffect
553Enabled: bool
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 SunRaysEffect renders a halo of light around sun. The halo is shaped/blocked by world objects between the Workspace.CurrentCamera and the sun.

Like other post-processing effects, SunRaysEffect will only work while Enabled and when parented to Lighting or Workspace.CurrentCamera. Also, it may not render on low-end devices, and it may render differently depending on your Studio settings (see the Quality Level settings in Rendering → Performance).

For more details on this effect and others, see Post-Processing Effects.

History 9

Members 2

Intensity

TypeDefault
float0.25

Intensity determines the opacity of the sun rays. Values closer to 0 are less visible, while values closer to 1 become more visible.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Spread

TypeDefault
float1

Spread determines how wide the sun rays will spread across the sky. Its value should be set between 0 and 1 as values outside that range have undefined behavior.

Thread safetyReadSafe
CategoryState
Loaded/Savedtrue

History 4

Settings