Component(system, entity) 

Base constructor for a Component

Parameters

system	pc.ComponentSystem	The ComponentSystem used to create this Component
entity	pc.Entity	The Entity that this Component is attached to

Booleanenabled 

Enables or disables the component.

pc.Entityentity 

The Entity that this Component is attached to

pc.ComponentSystemsystem 

The ComponentSystem used to create this Component

fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8]) 

Fire an event, all additional arguments are passed on to the event listener

obj.fire('test', 'This is the message');

Parameters

name	Object	Name of event to fire
arg1	*	First argument that is passed to the event handler
arg2	*	Second argument that is passed to the event handler
arg3	*	Third argument that is passed to the event handler
arg4	*	Fourth argument that is passed to the event handler
arg5	*	Fifth argument that is passed to the event handler
arg6	*	Sixth argument that is passed to the event handler
arg7	*	Seventh argument that is passed to the event handler
arg8	*	Eighth argument that is passed to the event handler

Returns

pc.EventHandler Self for chaining.

hasEvent(name) 

Test if there are any handlers bound to an event name

obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false

Parameters

name

String

The name of the event to test

Returns

Boolean true if the object has handlers bound to the specified event name.

off([name], [callback], [scope]) 

Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

var handler = function () {
};
obj.on('test', handler);

obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all hander functions, called 'test' with scope this

Parameters

name	String	Name of the event to unbind
callback	pc.callbacks.HandleEvent	Function to be unbound.
scope	Object	Scope that was used as the this when the event is fired

Returns

pc.EventHandler Self for chaining.

on(name, callback, [scope]) 

Attach an event handler to an event

obj.on('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console

Parameters

name	String	Name of the event to bind the callback to
callback	pc.callbacks.HandleEvent	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	Object	Object to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.

once(name, callback, [scope]) 

Attach an event handler to an event. This handler will be removed after being fired once.

obj.once('test', function (a, b) {
    console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled

Parameters

name	String	Name of the event to bind the callback to
callback	pc.callbacks.HandleEvent	Function that is called when event is fired. Note the callback is limited to 8 arguments.
scope	Object	Object to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.