API Reference

Class List

ScriptType

Extends: EventHandler

Represents the type of a script. It is returned by createScript. Also referred to as Script Type.

The type is to be extended using its JavaScript prototype. There is a list of methods that will be executed by the engine on instances of this type, such as:

initialize and postInitialize - are called (if defined) when a script is about to run for the first time - postInitialize will run after all initialize methods are executed in the same tick or enabling chain of actions.

update and postUpdate - are called (if defined) for enabled (running state) scripts on each tick.

swap - is called when a ScriptType that already exists in the registry gets redefined. If the new ScriptType has a swap method in its prototype, then it will be executed to perform hot- reload at runtime.

Summary

Static Properties

attributes

The interface to define attributes for Script Types.

scriptName

Name of a Script Type.

Static Methods

extend

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

Properties

app

The AppBase that the instance of this type belongs to.

enabled

True if the instance of this type is in running state.

entity

The Entity that the instance of this type belongs to.

Inherited

Methods

fire

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

hasEvent

Test if there are any handlers bound to an event name.

off

Detach an event handler from an event.

on

Attach an event handler to an event.

once

Attach an event handler to an event.

Details

Static Properties

attributes

The interface to define attributes for Script Types. Refer to ScriptAttributes.

scriptName

Name of a Script Type.

Static Methods

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

methodsobject

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

Constructor

ScriptType(args)

Create a new ScriptType instance.

Parameters

argsobject

The input arguments object.

args.appAppBase

The AppBase that is running the script.

args.entityEntity

The Entity that the script is attached to.

Properties

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.

Inherited

Methods

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

namestring

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

namestring

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

Parameters

namestring

Name of the event to unbind.

callbackHandleEventCallback

Function to be unbound.

scopeobject

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

namestring

Name of the event to bind the callback to.

callbackHandleEventCallback

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

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

namestring

Name of the event to bind the callback to.

callbackHandleEventCallback

Function that is called when event is fired. Note the callback is limited to 8 arguments.

scopeobject

Object to use as 'this' when the event is fired, defaults to current this.

Returns

EventHandler

Self for chaining.