Class Component extends MessageDispatcher

A base class for custom components.

Methods

Component() constructor
Creates new Component instance.
onAdded(gameObject) method

Called when attached to GameObject.

Parameters
gameObject : GameObject — The owner of this component.
Returns
void
onRemoved(gameObject) method

Called when detached from GameObject.

Parameters
gameObject : GameObject — The owner of this component.
Returns
void
onUpdate() method
Called at every update.
onRender() method
Called after all updates have been executed but before DisplayObject's onRender. GameObject itself does not have onRender method so Component#onRender will not be called on GameObjects.
This method can be used to interpolate/extrapolate values when low Black#ups value is used.
removeFromParent() method
Detaches this Component from its parent GameObject.

Inherited Methods

on(name, callback, context) inherited method

Adds listener by given name and callback.

Parameters
name : string — Message name.
callback : function — Function to be called on message send.
context : * — Object to be used as this in callback function.
Returns
MessageBinding
off(names) inherited method

Removes all bindings by given message name.

Parameters
names : string — One or more message name.
Returns
void
once(name, callback, context) inherited method

Adds listener by given name and callback. Binding will be automatically removed after first execution.

Parameters
name : string — Message name.
callback : function — Function to be called on message send.
context : * — Object to be used as this in callback function.
Returns
MessageBinding
post(name, params) inherited method

Posts message with a given params.

Adding ~ character to the begging of the name will bubble message to the top of the tree.

Parameters
name : string — The name of a message
params : * — A list of params to send
Returns
void

Properties

gameObject : GameObject property
Returns owner of this component.
parent : GameObject | null property
Returns this Component owner GameObject.

Inherited Properties

stage : Stage | null inherited property
Returns the stage Game Object to which this belongs to or null if not added onto stage.
path : string | null inherited property
Returns string representing a url like path to this object in the display
tree.