Functions for creating user scripts for the script component
Properties:
Name | Type | Description |
---|---|---|
legacy |
Boolean | If True, then engine will use legacy scripting system, defaults to true (subject to change) |
- Source:
Methods
(static) attribute(name, type, defaultValue, options)
Creates a script attribute for the current script. The script attribute can be accessed
inside the script instance like so 'this.attributeName' or outside a script instance like so 'entity.script.attributeName'.
Script attributes can be edited from the Attribute Editor of the PlayCanvas Editor like normal Components.
Parameters:
Name | Type | Description |
---|---|---|
name |
String | The name of the attribute |
type |
String | The type of the attribute. Can be one of the following: 'number', 'string', 'boolean', 'asset', 'entity', 'rgb', 'rgba', 'vector', 'enumeration', 'curve', 'colorcurve' |
defaultValue |
Object | The default value of the attribute |
options |
Object | Optional parameters for the attribute. Valid values are:
|
- Source:
Example
pc.script.attribute('speed', 'number', 5);
pc.script.attribute('message', 'string', "My message");
pc.script.attribute('enemyPosition', 'vector', [1,0,0]);
pc.script.attribute('spellType', 'enumeration', 0, {
enumerations: [{
name: "Fire",
value: 0
}, {
name: "Ice",
value: 1
}]
});
pc.script.attribute('enemy', 'entity');
pc.script.attribute('enemySpeed', 'curve');
pc.script.attribute('enemyPosition', 'curve', null, {
curves: ['x', 'y', 'z']
});
pc.script.attribute('color', 'colorcurve', null, {
type: 'rgba'
});
pc.script.create('scriptable', function (app) {
var Scriptable = function (entity) {
// store entity
this.entity = entity;
};
return Scriptable;
}
(static) create(name, callback)
Create a script resource object. A script file should contain a single call to pc.script.create and the callback should return a script object which will be
instantiated when attached to Entities.
Parameters:
Name | Type | Description |
---|---|---|
name |
String | The name of the script object. |
callback |
function | The callback function which is passed an {pc.Application} object, which is used to access Entities and Components, and should return the Type of the script resource to be instanced for each Entity. |
- Source:
Example
pc.script.create( function (app) {
var Scriptable = function (entity) {
// store entity
this.entity = entity;
// use app
app.components.model.addComponent(entity, {...});
};
return Scriptable;
}
(static) createLoadingScreen(callback)
Handles the creation of the loading screen of the application. A script can subscribe to
the events of a pc.Application to show a loading screen, progress bar etc. In order for this to work
you need to set the project's loading screen script to the script that calls this method.
Parameters:
Name | Type | Description |
---|---|---|
callback |
function | A function which can set up and tear down a customised loading screen. |
- Source:
Example
pc.script.createLoadingScreen(function (app) {
var showSplashScreen = function () { // }
var hideSplashScreen = function () { // }
var showProgress = function (progress) { // }
app.on("preload:start", showSplashScreen);
app.on("preload:progress", showProgress);
app.on("start", hideSplashScreen);
});