View source

typedef FlickerTweenOptions

package flixel.tweens.misc

import flixel.tweens.misc.FlickerTween

Available on all platforms

Special tween options for flicker tweens

Available since

5.7.0

.

Fields

@:optionaloptionaltype:Null<FlxTweenType>

* Tween type - bit field of `FlxTween`'s static type constants.

@:optionaloptionaltweenFunction:Null<FlickerTween ‑> Bool>

* An optional custom flicker function, defaults to * `function (tween) { return (tween.time / tween.period) % 1 > tween.ratio; }`

@:optionaloptionalstartDelay:Null<Float>

* Seconds to wait until starting this tween, `0` by default.

@:optionaloptionalratio:Null<Float>

* The amount of time the object will show, compared to the total duration, The default is `0.5`, * meaning equal times visible and invisible.

@:optionaloptionalonUpdate:Null<TweenCallback>

* Optional update callback function.

@:optionaloptionalonStart:Null<TweenCallback>

* Optional start callback function.

@:optionaloptionalonComplete:Null<TweenCallback>

* Optional complete callback function.

@:optionaloptionalloopDelay:Null<Float>

* Seconds to wait between loops of this tween, `0` by default.

@:optionaloptionalendVisibility:Null<Bool>

* Whether the object will show after the tween, defaults to `true`

@:optionaloptionalease:Null<EaseFunction>

* Optional easer function (see `FlxEase`).