Skip to content

SunRaysEffect

Supported Class World & Effects

Renders dynamic rays from the sun.

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.

Inheritance

Object → Instance → PostEffect → SunRaysEffect

Nova inheritance: Instance → PostEffect → SunRaysEffect

Properties

Intensity Supported Property Determines the opacity of the sun rays.
Intensity: float

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

Roblox documentation

Spread Supported Property Determines how wide the sun rays will spread out.
Spread: float

Determines how wide the sun rays will spread out.

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.

Roblox documentation

Inherited members

Inherited from PostEffect: 9 properties, 36 methods, 7 events. They are documented on the base class page.

Roblox reference: SunRaysEffect

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.