Refactor script reserved name code (playcanvas#2647)

willeastcott · web-flow · commit 63e235c21a3a · 2020-12-31T16:43:17.000Z
* Refactor script reserved name code.

* Fix component

* Use Set for reserved names

* Fix typo
diff --git a/src/framework/components/script/component.js b/src/framework/components/script/component.js
@@ -1,4 +1,4 @@
-import { createScript } from '../../../script/script.js';
+import { ScriptAttributes } from '../../../script/script-attributes.js';
 
 import { Component } from '../component.js';
 import { Entity } from '../../entity.js';
@@ -970,7 +970,7 @@ Object.defineProperty(ScriptComponent.prototype, 'scripts', {
                 // attributes
                 if (typeof value[key].attributes === 'object') {
                     for (var attr in value[key].attributes) {
-                        if (createScript.reservedAttributes[attr])
+                        if (ScriptAttributes.reservedNames.has(attr))
                             continue;
 
                         if (!script.__attributes.hasOwnProperty(attr)) {
diff --git a/src/script/script-attributes.js b/src/script/script-attributes.js
@@ -10,8 +10,6 @@ import { GraphNode } from '../scene/graph-node.js';
 
 import { Asset } from '../asset/asset.js';
 
-import { createScript } from './script.js';
-
 var components = ['x', 'y', 'z', 'w'];
 var vecLookup = [undefined, undefined, Vec2, Vec3, Vec4];
 
@@ -166,6 +164,12 @@ function ScriptAttributes(scriptType) {
     this.index = { };
 }
 
+ScriptAttributes.reservedNames = new Set([
+    'app', 'entity', 'enabled', '_enabled', '_enabledOld', '_destroyed',
+    '__attributes', '__attributesRaw', '__scriptType', '__executionOrder',
+    '_callbacks', 'has', 'get', 'on', 'off', 'fire', 'once', 'hasEvent'
+]);
+
 /**
  * @function
  * @name pc.ScriptAttributes#add
@@ -239,7 +243,7 @@ ScriptAttributes.prototype.add = function (name, args) {
         console.warn('attribute \'' + name + '\' is already defined for script type \'' + this.scriptType.name + '\'');
         // #endif
         return;
-    } else if (createScript.reservedAttributes[name]) {
+    } else if (ScriptAttributes.reservedNames.has(name)) {
         // #ifdef DEBUG
         console.warn('attribute \'' + name + '\' is a reserved attribute name');
         // #endif
diff --git a/src/script/script.js b/src/script/script.js
@@ -6,6 +6,16 @@ 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 */
 /**
  * @static
@@ -47,7 +57,7 @@ function createScript(name, app) {
         return null;
     }
 
-    if (createScript.reservedScripts[name])
+    if (reservedScriptNames.has(name))
         throw new Error('script name: \'' + name + '\' is reserved, please change script name');
 
     var scriptType = function (args) {
@@ -64,6 +74,14 @@ function createScript(name, app) {
     return scriptType;
 }
 
+// Editor uses this - migrate to ScriptAttributes.reservedNames and delete this
+var reservedAttributes = {};
+ScriptAttributes.reservedNames.forEach((value, value2, set) => {
+    reservedAttributes[value] = 1;
+});
+createScript.reservedAttributes = reservedAttributes;
+
+
 /* eslint-disable jsdoc/no-undefined-types */
 /* eslint-disable jsdoc/check-examples */
 /**
@@ -119,7 +137,7 @@ function registerScript(script, name, app) {
 
     name = name || script.__name || ScriptType.__getScriptName(script);
 
-    if (createScript.reservedScripts[name])
+    if (reservedScriptNames.has(name))
         throw new Error('script name: \'' + name + '\' is reserved, please change script name');
 
     script.__name = name;
@@ -131,32 +149,4 @@ function registerScript(script, name, app) {
     ScriptHandler._push(script);
 }
 
-// reserved scripts
-createScript.reservedScripts = [
-    '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'
-];
-var reservedScripts = { };
-var i;
-for (i = 0; i < createScript.reservedScripts.length; i++)
-    reservedScripts[createScript.reservedScripts[i]] = 1;
-createScript.reservedScripts = reservedScripts;
-
-
-// reserved script attribute names
-createScript.reservedAttributes = [
-    'app', 'entity', 'enabled', '_enabled', '_enabledOld', '_destroyed',
-    '__attributes', '__attributesRaw', '__scriptType', '__executionOrder',
-    '_callbacks', 'has', 'get', 'on', 'off', 'fire', 'once', 'hasEvent'
-];
-var reservedAttributes = { };
-for (i = 0; i < createScript.reservedAttributes.length; i++)
-    reservedAttributes[createScript.reservedAttributes[i]] = 1;
-createScript.reservedAttributes = reservedAttributes;
-
 export { createScript, registerScript };
