{{ message }}
Repository navigation
Expand file tree
/
Copy pathJsExtension.js
More file actions
507 lines (472 loc) · 15.9 KB
/
Copy pathJsExtension.js
File metadata and controls
507 lines (472 loc) · 15.9 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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
/**
* This is a declaration of an extension for GDevelop 5.
*
* ℹ️ Run `node import-GDJS-Runtime.js` (in newIDE/app/scripts) if you make any change
* to this extension file or to any other *.js file that you reference inside.
*
* The file must be named "JsExtension.js", otherwise GDevelop won't load it.
* ⚠️ If you make a change and the extension is not loaded, open the developer console
* and search for any errors.
*
* More information on https://github.com/4ian/GDevelop/blob/master/newIDE/README-extensions.md
*/
module.exports = {
createExtension: function(_, gd) {
const extension = new gd.PlatformExtension();
extension.setExtensionInformation(
'MyDummyExtension',
'My Dummy Extension',
'An example of a declaration of an extension',
'Florian Rival',
'MIT'
);
// Declare conditions, actions or expressions:
extension
.addCondition(
'MyNewCondition',
_('Dummy condition example'),
_(
'This is an example of a condition displayed in the events sheet. Will return true if the number is less than 10 and the length of the text is less than 5.'
),
_('Call the example condition with _PARAM0_ and _PARAM1_'),
_('Dummy Extension'),
'res/conditions/camera24.png',
'res/conditions/camera.png'
)
.addParameter('expression', _('Number 1'), '', false)
.addParameter('string', _('Text 1'), '', false)
.getCodeExtraInformation()
.setIncludeFile(
'Extensions/ExampleJsExtension/examplejsextensiontools.js'
)
.setFunctionName('gdjs.evtTools.exampleJsExtension.myConditionFunction');
extension
.addExpression(
'DummyExpression',
_('Dummy expression example'),
_('This is an example of an expression'),
_('Dummy Extension'),
'res/actions/camera.png'
)
.addParameter('expression', _('Maximum'), '', false)
.getCodeExtraInformation()
.setFunctionName('gdjs.random');
extension
.addStrExpression(
'DummyStrExpression',
_('Dummy string expression example'),
_('This is an example of an expression returning a string'),
_('Dummy Extension'),
'res/actions/camera.png'
)
.getCodeExtraInformation()
.setIncludeFile(
'Extensions/ExampleJsExtension/examplejsextensiontools.js'
)
.setFunctionName('gdjs.evtTools.exampleJsExtension.getString');
// Declare a behavior.
// Create a new gd.BehaviorJsImplementation object and implement the methods
// that are called to get and set the properties of the behavior.
// Everything that is stored inside the behavior is in "behaviorContent" and is automatically
// saved/loaded to JSON.
var dummyBehavior = new gd.BehaviorJsImplementation();
dummyBehavior.updateProperty = function(
behaviorContent,
propertyName,
newValue
) {
if (propertyName === 'My first property') {
behaviorContent.setStringAttribute('property1', newValue);
return true;
}
if (propertyName === 'My other property') {
behaviorContent.setBoolAttribute('property2', newValue === '1');
return true;
}
return false;
};
dummyBehavior.getProperties = function(behaviorContent) {
var behaviorProperties = new gd.MapStringPropertyDescriptor();
behaviorProperties.set(
'My first property',
new gd.PropertyDescriptor(
behaviorContent.getStringAttribute('property1')
)
);
behaviorProperties.set(
'My other property',
new gd.PropertyDescriptor(
behaviorContent.getBoolAttribute('property2') ? 'true' : 'false'
).setType('Boolean')
);
return behaviorProperties;
};
dummyBehavior.initializeContent = function(behaviorContent) {
behaviorContent.setStringAttribute('property1', 'Initial value 1');
behaviorContent.setBoolAttribute('property2', true);
};
extension
.addBehavior(
'DummyBehavior',
_('Dummy behavior for testing'),
'DummyBehavior',
_('This dummy behavior does nothing'),
'',
'CppPlatform/Extensions/topdownmovementicon.png',
'DummyBehavior',
dummyBehavior,
new gd.BehaviorsSharedData()
)
.setIncludeFile('Extensions/ExampleJsExtension/dummyruntimebehavior.js')
// You can optionally include more than one file when the behavior is used:
.addIncludeFile(
'Extensions/ExampleJsExtension/examplejsextensiontools.js'
);
// Declare another behavior, with shared data between the behaviors
// In addition to the usual behavior:
// Create a new gd.BehaviorSharedDataJsImplementation object and implement the methods
// that are called to get and set the properties of the shared data.
var dummyBehaviorWithSharedData = new gd.BehaviorJsImplementation();
dummyBehaviorWithSharedData.updateProperty = function(
behaviorContent,
propertyName,
newValue
) {
if (propertyName === 'My behavior property') {
behaviorContent.setStringAttribute('property1', newValue);
return true;
}
return false;
};
dummyBehaviorWithSharedData.getProperties = function(behaviorContent) {
var behaviorProperties = new gd.MapStringPropertyDescriptor();
behaviorProperties.set(
'My behavior property',
new gd.PropertyDescriptor(
behaviorContent.getStringAttribute('property1')
)
);
return behaviorProperties;
};
dummyBehaviorWithSharedData.initializeContent = function(behaviorContent) {
behaviorContent.setStringAttribute('property1', 'Initial value 1');
};
var sharedData = new gd.BehaviorSharedDataJsImplementation();
sharedData.updateProperty = function(
sharedContent,
propertyName,
newValue
) {
if (propertyName === 'My shared property') {
sharedContent.setStringAttribute('sharedProperty1', newValue);
return true;
}
return false;
};
sharedData.getProperties = function(sharedContent) {
var sharedProperties = new gd.MapStringPropertyDescriptor();
sharedProperties.set(
'My shared property',
new gd.PropertyDescriptor(
sharedContent.getStringAttribute('sharedProperty1')
)
);
return sharedProperties;
};
sharedData.initializeContent = function(behaviorContent) {
behaviorContent.setStringAttribute(
'sharedProperty1',
'Initial shared value 1'
);
};
extension
.addBehavior(
'DummyBehaviorWithSharedData',
_('Dummy behavior with shared data for testing'),
'DummyBehaviorWithSharedData',
_('This dummy behavior uses shared data and does nothing'),
'',
'CppPlatform/Extensions/topdownmovementicon.png',
'DummyBehaviorWithSharedData',
dummyBehaviorWithSharedData,
sharedData
)
.setIncludeFile(
'Extensions/ExampleJsExtension/dummywithshareddataruntimebehavior.js'
)
// You can optionally include more than one file when the behavior is used:
.addIncludeFile(
'Extensions/ExampleJsExtension/examplejsextensiontools.js'
);
// Declare an object.
// Create a new gd.ObjectJsImplementation object and implement the methods
// that are called to get and set the properties of the object, as well
// as the properties of the initial instances of this object
// Everything that is stored inside the object is in "content" and is automatically
// saved/loaded to JSON.
var dummyObject = new gd.ObjectJsImplementation();
dummyObject.updateProperty = function(
objectContent,
propertyName,
newValue
) {
if (propertyName === 'My first property') {
objectContent.property1 = newValue;
return true;
}
if (propertyName === 'My other property') {
objectContent.property2 = newValue === '1';
return true;
}
if (propertyName === 'My third property') {
objectContent.property3 = newValue;
return true;
}
if (propertyName === 'myImage') {
objectContent.myImage = newValue;
return true;
}
return false;
};
dummyObject.getProperties = function(objectContent) {
var objectProperties = new gd.MapStringPropertyDescriptor();
objectProperties.set(
'My first property',
new gd.PropertyDescriptor(objectContent.property1)
);
objectProperties.set(
'My other property',
new gd.PropertyDescriptor(
objectContent.property2 ? 'true' : 'false'
).setType('boolean')
);
objectProperties.set(
'My third property',
new gd.PropertyDescriptor(objectContent.property3.toString()).setType(
'number'
)
);
objectProperties.set(
'myImage',
new gd.PropertyDescriptor(objectContent.myImage)
.setType('resource')
.addExtraInfo('image')
.setLabel(
_("Image resource (won't be shown, just for demonstration purpose)")
)
);
return objectProperties;
};
dummyObject.setRawJSONContent(
JSON.stringify({
property1: 'Hello world',
property2: true,
property3: 123,
myImage: '',
})
);
dummyObject.updateInitialInstanceProperty = function(
objectContent,
instance,
propertyName,
newValue,
project,
layout
) {
if (propertyName === 'My instance property') {
instance.setRawStringProperty('instanceprop1', newValue);
return true;
}
if (propertyName === 'My other instance property') {
instance.setRawFloatProperty('instanceprop2', parseFloat(newValue));
return true;
}
return false;
};
dummyObject.getInitialInstanceProperties = function(
content,
instance,
project,
layout
) {
var instanceProperties = new gd.MapStringPropertyDescriptor();
instanceProperties.set(
'My instance property',
new gd.PropertyDescriptor(
instance.getRawStringProperty('instanceprop1')
)
);
instanceProperties.set(
'My other instance property',
new gd.PropertyDescriptor(
instance.getRawFloatProperty('instanceprop2').toString()
).setType('number')
);
return instanceProperties;
};
const object = extension
.addObject(
'DummyObject',
_('Dummy object for testing'),
_('This dummy object does nothing'),
'CppPlatform/Extensions/topdownmovementicon.png',
dummyObject
)
.setIncludeFile('Extensions/ExampleJsExtension/dummyruntimeobject.js')
.addIncludeFile(
'Extensions/ExampleJsExtension/dummyruntimeobject-pixi-renderer.js'
);
object
.addAction(
'MyMethod',
_('Display a dummy text in Developer console'),
_(
'Display a dummy text in Developer console. Open it with CTRL-SHIFT-J (Cmd-Alt-J on macOS).'
),
_('Display a dummy text for _PARAM0_, with params: _PARAM1_, _PARAM2_'),
'',
'res/conditions/camera24.png',
'res/conditions/camera.png'
)
.addParameter('object', _('Object'), 'DummyObject', false) // This parameter is mandatory for any object action/condition
.addParameter('expression', _('Number 1'), '', false)
.addParameter('string', _('Text 1'), '', false)
.getCodeExtraInformation()
.setFunctionName('myMethod');
return extension;
},
/**
* You can optionally add sanity tests that will check the basic working
* of your extension behaviors/objects by instanciating behaviors/objects
* and setting the property to a given value.
*
* If you don't have any tests, you can simply return an empty array like this:
* `runExtensionSanityTests: function(gd, extension) { return []; }`
*
* But it is recommended to create tests for the behaviors/objects properties you created
* to avoid mistakes.
*/
runExtensionSanityTests: function(gd, extension) {
const dummyBehavior = extension
.getBehaviorMetadata('MyDummyExtension::DummyBehavior')
.get();
const sharedData = extension
.getBehaviorMetadata('MyDummyExtension::DummyBehaviorWithSharedData')
.getSharedDataInstance();
return [
gd.ProjectHelper.sanityCheckBehaviorProperty(
dummyBehavior,
'My first property',
'Testing value'
),
gd.ProjectHelper.sanityCheckBehaviorsSharedDataProperty(
sharedData,
'My shared property',
'Testing value'
),
];
},
/**
* Register editors for objects.
*
* ℹ️ Run `node import-GDJS-Runtime.js` (in newIDE/app/scripts) if you make any change.
*/
registerEditorConfigurations: function(objectsEditorService) {
objectsEditorService.registerEditorConfiguration(
'MyDummyExtension::DummyObject',
objectsEditorService.getDefaultObjectJsImplementationPropertiesEditor()
);
},
/**
* Register renderers for instance of objects on the scene editor.
*
* ℹ️ Run `node import-GDJS-Runtime.js` (in newIDE/app/scripts) if you make any change.
*/
registerInstanceRenderers: function(objectsRenderingService) {
const RenderedInstance = objectsRenderingService.RenderedInstance;
const PIXI = objectsRenderingService.PIXI;
/**
* Renderer for instances of DummyObject inside the IDE.
*
* @extends RenderedInstance
* @class RenderedDummyObjectInstance
* @constructor
*/
function RenderedDummyObjectInstance(
project,
layout,
instance,
associatedObject,
pixiContainer,
pixiResourcesLoader
) {
RenderedInstance.call(
this,
project,
layout,
instance,
associatedObject,
pixiContainer,
pixiResourcesLoader
);
//Setup the PIXI object:
this._pixiObject = new PIXI.Text('This is a dummy object', {
align: 'left',
});
this._pixiObject.anchor.x = 0.5;
this._pixiObject.anchor.y = 0.5;
this._pixiContainer.addChild(this._pixiObject);
this.update();
}
RenderedDummyObjectInstance.prototype = Object.create(
RenderedInstance.prototype
);
/**
* Return the path to the thumbnail of the specified object.
*/
RenderedDummyObjectInstance.getThumbnail = function(
project,
resourcesLoader,
object
) {
return 'CppPlatform/Extensions/texticon24.png';
};
/**
* This is called to update the PIXI object on the scene editor
*/
RenderedDummyObjectInstance.prototype.update = function() {
// Read a property from the object
const property1Value = this._associatedObject
.getProperties(this.project)
.get('My first property')
.getValue();
this._pixiObject.text = property1Value;
// Read position and angle from the instance
this._pixiObject.position.x =
this._instance.getX() + this._pixiObject.width / 2;
this._pixiObject.position.y =
this._instance.getY() + this._pixiObject.height / 2;
this._pixiObject.rotation = RenderedInstance.toRad(
this._instance.getAngle()
);
// Custom size can be read in instance.getCustomWidth() and
// instance.getCustomHeight()
};
/**
* Return the width of the instance, when it's not resized.
*/
RenderedDummyObjectInstance.prototype.getDefaultWidth = function() {
return this._pixiObject.width;
};
/**
* Return the height of the instance, when it's not resized.
*/
RenderedDummyObjectInstance.prototype.getDefaultHeight = function() {
return this._pixiObject.height;
};
objectsRenderingService.registerInstanceRenderer(
'MyDummyExtension::DummyObject',
RenderedDummyObjectInstance
);
},
};
You can’t perform that action at this time.