MF_LensFlare
Allows a LensFlare component to mimic an object with a physical size in space. That is, it's brightness will change based on distance from the active camera. This is useful for explosions and rocket engine radiance.
Public Variables
flare : LensFlare
The LensFlare object to control.
beginActive : bool
The starting state of flare.
fadeTime : float
Time in seconds to fully fade in or out when controlled by MF_FxController.
scaleByDistance : bool
Will change brightness based on distance according to the brightnessCurve or defaultCurve.
scaleByHierarchy : bool
Will multiply brightness by the hierarchy scale.
maxDistance : float
When using scaleByDistance, the distance value at the right edge of the brightnessCurve or defaultCurve.
brightness : float
The brightness value at distance 0.
useCustomCurve : bool
Will cause calculations to use brightnessCurve instead of defaultCurve.
brightnessCurve : AnimationCurve
An user defined curve to control brightness falloff when using scaleByDistance.
multiplier : float
May be used by MF_FxController to apply a final multiplier to brightness.
Private Variables
defaultCurve : AnimationCurve
A supplied falloff curve that approximates a consistent apparent physical size when used with appropriate maxDistance values.
Allows a LensFlare component to mimic an object with a physical size in space. That is, it's brightness will change based on distance from the active camera. This is useful for explosions and rocket engine radiance.
Public Variables
flare : LensFlare
The LensFlare object to control.
beginActive : bool
The starting state of flare.
fadeTime : float
Time in seconds to fully fade in or out when controlled by MF_FxController.
scaleByDistance : bool
Will change brightness based on distance according to the brightnessCurve or defaultCurve.
scaleByHierarchy : bool
Will multiply brightness by the hierarchy scale.
maxDistance : float
When using scaleByDistance, the distance value at the right edge of the brightnessCurve or defaultCurve.
brightness : float
The brightness value at distance 0.
useCustomCurve : bool
Will cause calculations to use brightnessCurve instead of defaultCurve.
brightnessCurve : AnimationCurve
An user defined curve to control brightness falloff when using scaleByDistance.
multiplier : float
May be used by MF_FxController to apply a final multiplier to brightness.
Private Variables
defaultCurve : AnimationCurve
A supplied falloff curve that approximates a consistent apparent physical size when used with appropriate maxDistance values.