extend(methods) 

Shorthand function to extend Script Type prototype with list of methods.

var PlayerController = pc.createScript('playerController');

PlayerController.extend({
    initialize: function () {
        // called once on initialize
    },
    update: function (dt) {
        // called each tick
    }
});

Parameters

methods

object

Object with methods, where key - is name of method, and value - is function.

ScriptType(args) 

Create a new ScriptType instance.

Parameters

args	object	The input arguments object.
args.app	AppBase	The AppBase that is running the script.
args.entity	Entity	The Entity that the script is attached to.

AppBaseapp 

The AppBase that the instance of this type belongs to.

booleanenabled 

True if the instance of this type is in running state. False when script is not running, because the Entity or any of its parents are disabled or the ScriptComponent is disabled or the Script Instance is disabled. When disabled no update methods will be called on each tick. initialize and postInitialize methods will run once when the script instance is in enabled state during app tick.

Entityentity 

The Entity that the instance of this type belongs to.

attr:[name] 

Fired when a specific script attribute has been changed.

PlayerController.prototype.initialize = function () {
    this.on('attr:speed', function (value, valueOld) {
        console.log('speed been changed from ' + valueOld + ' to ' + value);
    });
};

Parameters

value	object	New value.
valueOld	object	Old value.

attr 

Fired when any script attribute has been changed.

PlayerController.prototype.initialize = function () {
    this.on('attr', function (name, value, valueOld) {
        console.log(name + ' been changed from ' + valueOld + ' to ' + value);
    });
};

Parameters

name	string	Name of attribute.
value	object	New value.
valueOld	object	Old value.

destroy 

Fired when a script instance is destroyed and removed from component.

PlayerController.prototype.initialize = function () {
    this.on('destroy', function () {
        // no more part of an entity
        // good place to cleanup entity from destroyed script
    });
};

disable 

Fired when a script instance becomes disabled.

PlayerController.prototype.initialize = function () {
    this.on('disable', function () {
        // Script Instance is now disabled
    });
};

enable 

Fired when a script instance becomes enabled.

PlayerController.prototype.initialize = function () {
    this.on('enable', function () {
        // Script Instance is now enabled
    });
};

error 

Fired when a script instance had an exception. The script instance will be automatically disabled.

PlayerController.prototype.initialize = function () {
    this.on('error', function (err, method) {
        // caught an exception
        console.log(err.stack);
    });
};

Parameters

err	Error	Native JavaScript Error object with details of error.
method	string	The method of the script instance that the exception originated from.

state 

Fired when a script instance changes state to enabled or disabled.

PlayerController.prototype.initialize = function () {
    this.on('state', function (enabled) {
        console.log('Script Instance is now ' + (enabled ? 'enabled' : 'disabled'));
    });
};

Parameters

enabled

boolean

True if now enabled, False if disabled.

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	string	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

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.

const 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 handler functions, called 'test' with scope this

Parameters

name	string	Name of the event to unbind.
callback	HandleEventCallback	Function to be unbound.
scope	object	Scope that was used as the this when the event is fired.

Returns

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	HandleEventCallback	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

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	HandleEventCallback	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

EventHandler

Self for chaining.