View source

class FlxTimerManager

package flixel.util

extends FlxBasic

import flixel.util.FlxTimer

@:directlyUsed

A simple manager for tracking and updating game timer objects. Normally accessed via the static FlxTimer.manager rather than being created separately.

Constructor

new()

Instantiates a new timer manager.

Methods

inlineclear():Void

Removes all the timers from the timer manager.

completeAll():Void

Immediately updates all active, non-infinite timers to their end points, repeatedly, until all their loops are finished, resulting in loopsLeft callbacks being run.

Available since

4.2.0

.

destroy():Void

Clean up memory.

forEach(func:FlxTimer ‑> Void):Void

Applies a function to all timers

Parameters:

func

A function that modifies one timer at a time

Available since

4.2.0

.

update(elapsed:Float):Void

Called by FlxG.plugins.update() before the game state has been updated. Cycles through timers and calls update() on each one.

Inherited Variables

Defined by FlxBasic

@:value(idEnumerator++)ID:Int = idEnumerator++

A unique ID starting from 0 and increasing by 1 for each subsequent FlxBasic that is created.

@:value(true)active:Bool = true

Controls whether update() is automatically called by FlxState/FlxGroup.

@:value(true)alive:Bool = true

Useful state for many game objects - "dead" (!alive) vs alive. kill() and revive() both flip this switch (along with exists, but you can override that).

camera:FlxCamera

Gets or sets the first camera of this object.

cameras:Array<FlxCamera>

This determines on which FlxCameras this object will be drawn. If it is null / has not been set, it uses the list of default draw targets, which is controlled via FlxG.camera.setDefaultDrawTarget as well as the DefaultDrawTarget argument of FlxG.camera.add.

read onlycontainer:Null<FlxContainer>

The parent containing this basic, typically if you check this recursively you should reach the state

Available since

5.7.0

.

@:value(true)exists:Bool = true

Controls whether update() and draw() are automatically called by FlxState/FlxGroup.

@:value(true)visible:Bool = true

Controls whether draw() is automatically called by FlxState/FlxGroup.

Inherited Methods

Defined by FlxBasic

draw():Void

Override this function to control how the object is drawn. Doing so is rarely necessary, but can be very useful.

getCameras():Array<FlxCamera>

The cameras that will draw this. Use this.cameras to set specific cameras for this object, otherwise the container's cameras are used, or the container's container and so on. If there is no container, say, if this is inside FlxGroups rather than a FlxContainer then the default draw cameras are returned.

Available since

5.7.0

.

kill():Void

Handy function for "killing" game objects. Use reset() to revive them. Default behavior is to flag them as nonexistent AND dead. However, if you want the "corpse" to remain in the game, like to animate an effect or whatever, you should override this, setting only alive to false, and leaving exists true.

revive():Void

Handy function for bringing game objects "back to life". Just sets alive and exists back to true. In practice, this function is most often called by FlxObject#reset().

toString():String