[ view source ]

class KeyBindings

package ceramic

extends Entity

implements Component

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

Available on all targets

Constructor

`new()`

Variables

`@:keepentity:Entity`

`@:value(null)read onlyinitializerName:String = null`

Methods

`bind(accelerator:Array<KeyAcceleratorItem>, ?callback:() ‑> Void):KeyBinding`

Inherited Events

Defined by Entity

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

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

Inherited Variables

Defined by Entity

`@:value(null)id:String = null`

`read onlydestroyed:Bool`

`read onlydisposed:Bool`

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

`components: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`

Start a tween associated with this entity.

Parameters:

`easing`	The easing to use
`duration`	The duration of the tween
`fromValue`	The start value of the tween
`toValue`	The end value of the tween
`update`	An update function called at each iteration of the tween

Returns:

The instance of the created Tween object

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

Start an eager tween associated with this entity. This is the same as a regular tween, except that it will start updating itself using current frame's delta time instead of next frame like in a regular tween.

Parameters:

`easing`	The easing to use
`duration`	The duration of the tween
`fromValue`	The start value of the tween
`toValue`	The end value of the tween
`update`	An update function called at each iteration of the tween

Returns:

The instance of the created Tween object

[ view source ]

class KeyBindings

package ceramic

extends Entity

implements Component

Constructor

`new()`

Variables

`@:keepentity:Entity`

`@:value(null)read onlyinitializerName:String = null`

Methods

`bind(accelerator:Array<KeyAcceleratorItem>, ?callback:() ‑> Void):KeyBinding`

Inherited Events

Defined by Entity

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

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

Inherited Variables

Defined by Entity

`@:value(null)id:String = null`

`read onlydestroyed:Bool`

`read onlydisposed:Bool`

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

`components:ReadOnlyMap<String, Component>`

`scriptContent:ScriptContent`

`script:Script`

Inherited Methods

Defined by Entity

`dispose():Void`

`unbindEvents():Void`

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

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

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

`className():String`

`inlineclearComponents():Void`

`@:value({ hasField : false })component<C>(?name:String, ?component:Null<C>, hasField:Bool = false):C`

`hasComponent(name:String):Bool`

`removeComponent(name:String):Void`