Primitive Class Flow.LensFlare
Represents a global lens flare (not to be confused with the lens flare object).
Functions
LensFlare(Pitch, Yaw, Color.) | Create a LensFlare object. |
LensFlare:GetSunSpriteID() | Get this lens flare's sun sprite ID. |
LensFlare:GetPitch() | Get this lens flare's pitch angle in degrees. |
LensFlare:GetYaw() | Get this lens flare's yaw angle in degrees. |
LensFlare:GetColor() | Get the lens flare's color. |
LensFlare:GetEnabled() | Get this lens flare's enabled status. |
LensFlare:SetSunSpriteID(New) | Set this lens flare's sun sprite ID. |
LensFlare:SetPitch(New) | Set this lens flare's pitch angle. |
LensFlare:SetYaw(New) | Set this lens flare's yaw angle. |
LensFlare:SetColor(New) | Set this lens flare's color. |
Functions
- LensFlare(Pitch, Yaw, Color.)
-
Create a LensFlare object.
Parameters:
- Pitch float angle in degrees.
- Yaw float angle in degrees.
- Color. Color
Returns:
-
LensFlare
A new LensFlare object.
- LensFlare:GetSunSpriteID()
-
Get this lens flare's sun sprite ID.
Returns:
-
int
Sprite ID.
- LensFlare:GetPitch()
-
Get this lens flare's pitch angle in degrees.
Returns:
-
float
Pitch angle in degrees.
- LensFlare:GetYaw()
-
Get this lens flare's yaw angle in degrees.
Returns:
-
float
Yaw angle in degrees.
- LensFlare:GetColor()
- Get the lens flare's color.
- LensFlare:GetEnabled()
-
Get this lens flare's enabled status.
Returns:
-
bool
Enabled status. true: enabled, false: disabled
- LensFlare:SetSunSpriteID(New)
-
Set this lens flare's sun sprite ID.
Parameters:
- New int sun sprite ID.
- LensFlare:SetPitch(New)
-
Set this lens flare's pitch angle.
Parameters:
- New float pitch angle in degrees.
- LensFlare:SetYaw(New)
-
Set this lens flare's yaw angle.
Parameters:
- New float yaw angle in degrees.
- LensFlare:SetColor(New)
-
Set this lens flare's color.
Parameters:
- New Color color.