Script name throws error

CaseyDeCoder · February 24, 2021, 11:12am

Last time I was in Playcanvas writing some boilerplate code, I wrote a scripts called move.

var Move = pc.createScript('move');

Which threw an error. Without any additional changes, I changed it to this

var Move = pc.createScript('new');

parsed the script, and everything ran like butter.

I was wondering if there is any way of knowing what names are acceptable. This already had me in a knot because I was looking at my move script for half an hour trying to figure out what was going wrong, until I found out it was just this name alone.

External libraries include Basis and Ammo.

Gabriel_Dobrzynski · February 24, 2021, 11:14am

Do you want first person movement?

LeXXik · February 24, 2021, 11:25am

Welcome to PlayCanvas!

Hmm, I don’t think it is documented. We should probably add it to the User Manual. For now, you can find the reserved names in the source code here:

github.com

playcanvas/engine/blob/e7115594f5356373bc7d01b08e2f25a896927b54/src/script/script.js#L11


import { EventHandler } from '../core/event-handler.js';

import { ScriptHandler } from '../resources/script.js';

import { script } from '../framework/script.js';
import { Application } from '../framework/application.js';

import { ScriptAttributes } from './script-attributes.js';
import { ScriptType } from './script-type.js';

const reservedScriptNames = new Set([
    'system', 'entity', 'create', 'destroy', 'swap', 'move',
    'scripts', '_scripts', '_scriptsIndex', '_scriptsData',
    'enabled', '_oldState', 'onEnable', 'onDisable', 'onPostStateChange',
    '_onSetEnabled', '_checkState', '_onBeforeRemove',
    '_onInitializeAttributes', '_onInitialize', '_onPostInitialize',
    '_onUpdate', '_onPostUpdate',
    '_callbacks', 'has', 'get', 'on', 'off', 'fire', 'once', 'hasEvent'
]);

/* eslint-disable jsdoc/no-undefined-types */

yaustar · February 24, 2021, 11:28am

There should have been an error message saying that the name is reserved and that the script should be changed.

CaseyDeCoder · February 24, 2021, 1:35pm

Thanks!

CaseyDeCoder · February 24, 2021, 1:39pm

Right, I’m just now figuring out how Playcanvas works, including the console. I’ve got plenty of experience in Unity and done some simple React back in the day but I’m still adjusting. I found the console now (seems obvious in hindsight), so it’s my bad!

yaustar · February 24, 2021, 1:43pm

Yep, the browser is effectively your debugging tool. You can add breakpoints, execute code in the console etc. Some extra docs here: https://developer.playcanvas.com/en/user-manual/scripting/debugging/

You may also find this megathread helpful too: https://twitter.com/yaustar/status/1359518687066284035