| Package | com.pblabs.engine.components |
| Class | public class AnimatedComponent |
| Inheritance | AnimatedComponent  EntityComponent Object |
| Implements | IAnimatedObject |
| Subclasses | AnimationController, AnimatorComponent, DisplayObjectRenderer, DisplayObjectScene |
| Property | Defined By | ||
|---|---|---|---|
 | isRegistered : Boolean [read-only]
Whether or not the component is currently registered with an entity. | EntityComponent | |
| name : String [read-only]
The name given to the component when it is added to an entity. | EntityComponent | |
| owner : IEntity
A reference to the entity that this component currently belongs to. | EntityComponent | |
| registerForUpdates : Boolean
Set to register/unregister for frame updates. | AnimatedComponent | ||
| updatePriority : Number = 0.0
The update priority for this component. | AnimatedComponent | ||
| Method | Defined By | ||
|---|---|---|---|
onFrame(deltaTime:Number):void
This method is called every frame by the ProcessManager on any objects
that have been added to it with the AddAnimatedObject method. | AnimatedComponent | ||
|
Registers the component with an entity. | EntityComponent | |
| reset():void
This is called by an entity on all of its components any time a component
is added or removed. | EntityComponent | |
| unregister():void
Unregisters the component from an entity. | EntityComponent | |
| Method | Defined By | ||
|---|---|---|---|
onAdd():void [override] | AnimatedComponent | ||
onRemove():void [override] | AnimatedComponent | ||
| onReset():void
This is called anytime a component is added or removed from the owner entity. | EntityComponent | |
| registerForUpdates | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesregisterForUpdates:BooleanSet to register/unregister for frame updates.
public function get registerForUpdates():Boolean public function set registerForUpdates(value:Boolean):void| updatePriority | property |
public var updatePriority:Number = 0.0The update priority for this component. Higher numbered priorities have OnFrame called before lower priorities.
| onAdd | () | method |
override protected function onAdd():void| onFrame | () | method |
public function onFrame(deltaTime:Number):voidThis method is called every frame by the ProcessManager on any objects that have been added to it with the AddAnimatedObject method.
Parameters
deltaTime:Number — The amount of time (in seconds) that has elapsed since
the last frame.
|
| onRemove | () | method |
override protected function onRemove():void