class Autorun

package tracker

extends Entity

@:directlyUsed@:build(ceramic.macros.EntityMacro.buildForCompletion())@:autoBuild(ceramic.macros.EntityMacro.buildForCompletion())@:build(tracker.macros.EventsMacro.build())@:autoBuild(tracker.macros.EventsMacro.build())

Available on all targets

Events

@:dox(show)reset():Void

Static variables

@:value(null)staticcurrent:Autorun = null

Static methods

staticinlineunobserve():Void

Ensures current autorun won't be affected by the code after this call. reobserve() should be called to restore previous state.

staticinlinereobserve():Void

Resume observing values and resume affecting current autorun scope. This should be called after an unobserve() call.

staticunobserved(func:() ‑> Void):Void

Executes the given function synchronously and ensures the current autorun scope won't be affected

staticgetAutorunArray():Array<Autorun>

staticrecycleAutorunArray(array:Array<Autorun>):Void

staticinlinegetArrayOfAutorunArrays():Array<Array<Autorun>>

staticinlinerecycleArrayOfAutorunArrays(array:Array<Array<Autorun>>):Void

Constructor

new(onRun:() ‑> Void, ?afterRun:() ‑> Void)

Initialize a new autorun.

Parameters:

onRun

The callback that will be executed and used to compute implicit bindings

afterRun

(optional) A callback run right after onRun, not affecting implicit bindings. Useful when generating side effects without messing up binding dependencies.

Variables

@:value(false)read onlyinvalidated:Bool = false

Methods

run():Void

inlineinvalidate():Void

bindToAutorunArray(autorunArray:Array<Autorun>):Void

unbindFromAllAutorunArrays():Void

Inherited Events

Defined by Entity

@:dox(show)dispose(entity:Entity):Void

@:dox(show)destroy(entity:Entity):Void

Inherited Variables

Defined by Entity

read onlyhasData:Bool

data:Dynamic

@:value(null)id:String = null

read onlydestroyed:Bool

read onlydisposed:Bool

@:value(null)read onlyautoruns:Array<Autorun> = null

@editablecomponents:ReadOnlyMap<String, Component>

Public components mapping. Contain components created separately with component() or macro-based components as well.

scriptContent:ScriptContent

Available with script plugin

script:Script

Available with script plugin

Inherited Methods

Defined by Entity

dispose():Void

Schedules destroy, at the end of the current frame.

unbindEvents():Void

Remove all events handlers from this entity.

autorun(run:() ‑> Void, ?afterRun:() ‑> Void):Autorun

Creates a new Autorun instance with the given callback associated with the current entity.

Parameters:

run

The run callback

Returns:

The autorun instance

tween(?easing:Easing, duration:Float, fromValue:Float, toValue:Float, update:(Float, Float) ‑> Void):Tween

className():String

inlineclearComponents():Void

component<C>(?name:String, ?component:Null<C>):C

hasComponent(name:String):Bool

removeComponent(name:String):Void