forked from playcanvas/engine
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathscript-registry.js
More file actions
192 lines (161 loc) · 6.85 KB
/
script-registry.js
File metadata and controls
192 lines (161 loc) · 6.85 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
pc.extend(pc, function () {
/**
* @name pc.ScriptRegistry
* @class Container for all Script Types that are available to this application
* @description Create an instance of a pc.ScriptRegistry.
* Note: PlayCanvas scripts can access the Script Registry from inside the application with {@link pc.Application#scripts} {@link pc.ADDRESS_REPEAT}.
* @param {pc.Application} app Application to attach registry to.
*/
var ScriptRegistry = function (app) {
pc.events.attach(this);
this.app = app;
this._scripts = { };
this._list = [ ];
};
/**
* @function
* @name pc.ScriptRegistry#add
* @description Add {@link ScriptType} to registry.
* Note: when {@link pc.createScript} is called, it will add the {@link 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.
* @param {ScriptType} scriptType Script Type that is created using {@link pc.createScript}
* @returns {Boolean} True if added for the first time or false if script already exists
* @example
* var PlayerController = pc.createScript('playerController');
* // playerController Script Type will be added to pc.ScriptRegistry automatically
* app.scripts.has('playerController') === true; // true
*/
ScriptRegistry.prototype.add = function(script) {
var self = this;
if (this._scripts.hasOwnProperty(script.__name)) {
setTimeout(function() {
if (script.prototype.swap) {
// swapping
var old = self._scripts[script.__name];
var ind = self._list.indexOf(old);
self._list[ind] = script;
self._scripts[script.__name] = script;
self.fire('swap', script.__name, script);
self.fire('swap:' + script.__name, script);
} else {
console.warn('script registry already has \'' + script.__name + '\' script, define \'swap\' method for new script type to enable code hot swapping');
}
});
return false;
}
this._scripts[script.__name] = script;
this._list.push(script);
this.fire('add', script.__name, script);
this.fire('add:' + script.__name, script);
// for all components awaiting Script Type
// create script instance
setTimeout(function() {
if (! self._scripts.hasOwnProperty(script.__name))
return;
var components = self.app.systems.script._components;
var i, scriptInstance, attributes;
var scriptInstances = [ ];
var scriptInstancesInitialized = [ ];
for(i = 0; i < components.length; i++) {
// check if awaiting for script
if (components[i]._scriptsIndex[script.__name] && components[i]._scriptsIndex[script.__name].awaiting) {
if (components[i]._scriptsData && components[i]._scriptsData[script.__name])
attributes = components[i]._scriptsData[script.__name].attributes;
scriptInstance = components[i].create(script.__name, {
preloading: true,
ind: components[i]._scriptsIndex[script.__name].ind,
attributes: attributes
});
if (scriptInstance)
scriptInstances.push(scriptInstance);
}
}
// initialize attributes
for(i = 0; i < scriptInstances.length; i++)
scriptInstances[i].__initializeAttributes();
// call initialize()
for(i = 0; i < scriptInstances.length; i++) {
if (scriptInstances[i].enabled) {
scriptInstances[i]._initialized = true;
scriptInstancesInitialized.push(scriptInstances[i]);
if (scriptInstances[i].initialize)
scriptInstances[i].initialize();
}
}
// call postInitialize()
for(i = 0; i < scriptInstancesInitialized.length; i++) {
scriptInstancesInitialized[i]._postInitialized = true;
if (scriptInstancesInitialized[i].postInitialize)
scriptInstancesInitialized[i].postInitialize();
}
});
return true;
};
/**
* @function
* @name pc.ScriptRegistry#remove
* @description Remove {@link ScriptType}.
* @param {String} name Name of a {@link ScriptType} to remove
* @returns {Boolean} True if removed or False if already not in registry
* @example
* app.scripts.remove('playerController');
*/
ScriptRegistry.prototype.remove = function(script) {
var name = script;
if (typeof(script) === 'function')
name = script.__name;
if (! this._scripts.hasOwnProperty(name))
return false;
var item = this._scripts[name];
delete this._scripts[name];
var ind = this._list.indexOf(item);
this._list.splice(ind, 1);
this.fire('remove', name, item);
this.fire('remove:' + name, item);
return true;
};
/**
* @function
* @name pc.ScriptRegistry#get
* @description Get {@link ScriptType} by name.
* @param {String} name Name of a {@link ScriptType}.
* @returns {ScriptType} The Script Type if it exists in the registry or null otherwise.
* @example
* var PlayerController = app.scripts.get('playerController');
*/
ScriptRegistry.prototype.get = function(name) {
return this._scripts[name] || null;
};
/**
* @function
* @name pc.ScriptRegistry#has
* @description Check if a {@link ScriptType} with the specified name is in the registry.
* @param {String} name Name of a {@link ScriptType}
* @returns {Boolean} True if {@link ScriptType} is in registry
* @example
* if (app.scripts.has('playerController')) {
* // playerController is in pc.ScriptRegistry
* }
*/
ScriptRegistry.prototype.has = function(name) {
return this._scripts.hasOwnProperty(name);
};
/**
* @function
* @name pc.ScriptRegistry#list
* @description Get list of all {@link ScriptType}s from registry.
* @returns {ScriptType[]} list of all {@link ScriptType}s in registry
* @example
* // logs array of all Script Type names available in registry
* console.log(app.scripts.list().map(function(o) {
* return o.name;
* }));
*/
ScriptRegistry.prototype.list = function() {
return this._list;
};
return {
ScriptRegistry: ScriptRegistry
};
}());