API Reference

Class List

pc.ScriptRegistry

Extends: pc.EventHandler

Container for all Script Types that are available to this application

Summary

Methods

addAdd pc.ScriptType to registry.
getGet pc.ScriptType by name.
hasCheck if a pc.ScriptType with the specified name is in the registry.
listGet list of all pc.ScriptTypes from registry.
removeRemove pc.ScriptType.

Inherited

Methods

fireFire an event, all additional arguments are passed on to the event listener
hasEventTest if there are any handlers bound to an event name
offDetach an event handler from an event.
onAttach an event handler to an event
onceAttach an event handler to an event.

Details

Constructor

ScriptRegistry(app)

Create an instance of a pc.ScriptRegistry. Note: PlayCanvas scripts can access the Script Registry from inside the application with pc.Application#scripts pc.ADDRESS_REPEAT.

Parameters

apppc.ApplicationApplication to attach registry to.

Methods

add(script)

Add pc.ScriptType to registry. Note: when pc.createScript is called, it will add the pc.ScriptType to the registry automatically. If a script already exists in registry, and the new script has a `swap` method defined, it will perform code hot swapping automatically in async manner.

var PlayerController = pc.createScript('playerController');
// playerController Script Type will be added to pc.ScriptRegistry automatically
app.scripts.has('playerController') === true; // true

Parameters

scriptpc.ScriptTypeScript Type that is created using pc.createScript

Returns

Boolean True if added for the first time or false if script already exists

get(name)

Get pc.ScriptType by name.

var PlayerController = app.scripts.get('playerController');

Parameters

nameStringName of a pc.ScriptType.

Returns

pc.ScriptType The Script Type if it exists in the registry or null otherwise.

has(name)

Check if a pc.ScriptType with the specified name is in the registry.

if (app.scripts.has('playerController')) {
    // playerController is in pc.ScriptRegistry
}

Parameters

nameStringName of a pc.ScriptType

Returns

Boolean True if pc.ScriptType is in registry

list()

Get list of all pc.ScriptTypes from registry.

// logs array of all Script Type names available in registry
console.log(app.scripts.list().map(function(o) {
    return o.name;
}));

Returns

pc.ScriptType[] list of all pc.ScriptTypes in registry

remove(name)

Remove pc.ScriptType.

app.scripts.remove('playerController');

Parameters

nameStringName of a pc.ScriptType to remove

Returns

Boolean True if removed or False if already not in registry

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

nameObjectName 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

nameStringThe 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

nameStringName of the event to unbind
callbackpc.callbacks.HandleEventFunction to be unbound.
scopeObjectScope 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

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject 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

nameStringName of the event to bind the callback to
callbackpc.callbacks.HandleEventFunction that is called when event is fired. Note the callback is limited to 8 arguments.
scopeObjectObject to use as 'this' when the event is fired, defaults to current this

Returns

pc.EventHandler Self for chaining.