API Reference

Class List

pc.ScriptRegistry

Extends: pc.EventHandler

Container for all Script Types that are available to this application.

Summary

Methods

add

Add pc.ScriptType to registry.

get

Get pc.ScriptType by name.

has

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

list

Get list of all pc.ScriptTypes from registry.

remove

Remove pc.ScriptType.

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

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.Application

Application 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
console.log(app.scripts.has('playerController')); // outputs true

Parameters

scripttypeof(pc.ScriptType)

Script 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

namestring

Name of a pc.ScriptType.

Returns

typeof(pc.ScriptType)

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

has(nameOrType)

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

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

Parameters

nameOrTypestring, typeof(pc.ScriptType)

The name or type of 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

typeof(pc.ScriptType)[]

list of all pc.ScriptTypes in registry.

remove(nameOrType)

Remove pc.ScriptType.

app.scripts.remove('playerController');

Parameters

nameOrTypestring, typeof(pc.ScriptType)

The name or type of pc.ScriptType.

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

nameobject

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

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

Parameters

namestring

Name of the event to unbind.

callbackpc.callbacks.HandleEvent

Function to be unbound.

scopeobject

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

namestring

Name of the event to bind the callback to.

callbackpc.callbacks.HandleEvent

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

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

namestring

Name of the event to bind the callback to.

callbackpc.callbacks.HandleEvent

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

pc.EventHandler

Self for chaining.