SunRaysEffect

Missing API Documentation

This API Class does not have any or complete API documentation. Please add API documentation if possible.

The SunRaysEffect class, added in version 0.243, inherits from PostEffect.

Two images, showing the sun without sun rays (left), and with sun rays (right).

The sun rays obstructing through a part.

Description[]

This class adds a halo around the sun that can be obstructed by BaseParts, however it will shine through transparent parts. Disappears when the sun is off-screen.

Properties

Intensity: float

This class member is missing documentation. Create or add to its subpage at Class:SunRaysEffect/Intensity.

Category: State.
Serialization: can save and load.
Thread safety: read safe

Spread: float

This class member is missing documentation. Create or add to its subpage at Class:SunRaysEffect/Spread.

Category: State.
Serialization: can save and load.
Thread safety: read safe

External links[]

SunRaysEffect in the Roblox Creator Documentation
SunRaysEffect in the Roblox API Reference