BBMOD_LensFlareElement

A constructor defined in BBMOD_LensFlareElement.gml

new BBMOD_LensFlareElement([_sprite[, _subimage[, _offset[, _scale[, _scaleByDistanceMin[, _scaleByDistanceMax[, _color[, _applyTint[, _angle[, _angleRelative[, _fadeOut[, _applyStarburst]]]]]]]]]]]])

Description

A single lens flare element (sprite).

Arguments

Name	Type	Description
_sprite	`Asset.GMSprite`	The sprite of the lens flare element. Defaults to `BBMOD_SprLensFlareGhost`.
_subimage	`Real`	The sprite subimage. Defaults to 0.
_offset	`Struct.BBMOD_Vec2`	The offset from the lights position on the screen, where `(0, 0)` is the light's position, `(0.5, 0.5)` is the screen center and `(1, 1)` is the lights position inverted around the screen center. Defaults to `(0, 0)` if `undefined`.
_scale	`Struct.BBMOD_Vec2`	The scale of the lens flare sprite. Defaults to `(1, 1)` if `undefined`.
_scaleByDistanceMin	`Struct.BBMOD_Vec2`	Scale multiplier when the lens flare's normalized distance from the light's position on screen is 0. Defaults to `(1, 1)` if `undefined`.
_scaleByDistanceMax	`Struct.BBMOD_Vec2`	Scale multiplier when the lens flare's normalized distance from the light's position on screen is 1. Defaults to `(1, 1)` if `undefined`.
_color	`Struct.BBMOD_Color`	The color of the lens flare. Defaults to BBMOD_C_WHITE if `undefined`.
_applyTint	`Bool`	If `true` then BBMOD_LensFlare.Tint is applied to `Color`. Defaults to `true`.
_angle	`Real`	The rotation of the lens flare. Defaults to 0.
_angleRelative	`Bool`	If `true` then the lens flare angle is relative to the direction to the light's position on screen. Defaults to `false`.
_fadeOut	`Bool`	Whether to fade out the lens flare on screen edges. Defaults to `false`.
_applyStarburst	`Bool`	Whether to apply starburst. Defaults to `false`.

Properties

Name	Description
Angle	The rotation of the lens flare. Default value is 0.
AngleRelative	If `true` then the lens flare angle is relative to the direction to the light's position on screen. Default value is `false`.
ApplyStarburst	Whether to apply starburst. Default value is `false`.
ApplyTint	If `true` then BBMOD_LensFlare.Tint is applied to `Color`. Default value is `true`.
Color	The color of the lens flare. Default value is BBMOD_C_WHITE.
FadeOut	Whether to fade out the lens flare on screen edges. Default value is `false`.
Offset	The offset from the lights position on the screen, where `(0, 0)` is the light's position, `(0.5, 0.5)` is the screen center and `(1, 1)` is the lights position inverted around the screen center. Default value is `(0, 0)`.
Scale	The scale of the lens flare sprite. Default value is to `(1, 1)`.
ScaleByDistanceMax	Scale multiplier when the lens flare's normalized distance from the light's position on screen is 1. Default value is `(1, 1)`.
ScaleByDistanceMin	Scale multiplier when the lens flare's normalized distance from the light's position on screen is 0. Default value is `(1, 1)`.
Sprite	The sprite of the lens flare element. Default value is `BBMOD_SprLensFlareGhost`.
Subimage	The sprite subimage. Default value is 0.

BBMOD_LensFlareElement

Description

Arguments

Properties

See also