[ view source ]

class Entity

package ceramic

implements Lazy, Events

extended by App, Asset, Assets, Audio, AudioMixer, AutoTiler, BackgroundQueue, BitmapFont, Camera, Click, DoubleClick, EditText, FileWatcher, GifCapture, Group, Input, KeyBinding, KeyBindings, LongPress, ParticleEmitter, Renderer, Screen, Script, SelectText, Shader, Sound, SpineData, SpineMontage, State, StateMachineBase, System, Systems, Task, Texture, TextureAtlas, TextureAtlasPacker, TextureTilePacker, TilemapEditor, Timeline, TimelineTrack, Timelines, Tween, VisibleBounds, Visual, VisualArcadePhysics, VisualNapePhysics, VisualTransition, WatchDirectory, Context, DragDrop, ItalicText, TabFocus, Autorun, DynamicEvents, History, Model, SerializeModel, Project

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

Available on all targets

Events

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

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

Constructor

new()

Create a new entity

Variables

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

Methods

destroy():Void

Destroy this entity. This method is automatically protected from duplicate calls. That means calling multiple times an entity's destroy() method will run the destroy code only one time. As soon as destroy() is called, the entity is marked destroyed=true, even when calling destroy() method on a subclass (a macro is inserting a code to mark the object as destroyed at the beginning of every destroy() override function.

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