150 lines
4.2 KiB
JavaScript
150 lines
4.2 KiB
JavaScript
|
/*
|
||
|
|
* GDevelop JS Platform
|
||
|
|
* Copyright 2013-2016 Florian Rival (Florian.Rival@gmail.com). All rights reserved.
|
||
|
|
* This project is released under the MIT License.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @typedef BehaviorData Properties to set up a behavior.
|
||
|
|
* @property {string} name The name of the behavior (for getting from an object (object.getBehavior) for example)
|
||
|
|
* @property {string} type The behavior type. Used by GDJS to find the proper behavior to construct.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* RuntimeBehavior represents a behavior being used by a RuntimeObject.
|
||
|
|
*
|
||
|
|
* @class RuntimeBehavior
|
||
|
|
* @memberof gdjs
|
||
|
|
* @param {gdjs.RuntimeScene} runtimeScene The scene owning the object of the behavior
|
||
|
|
* @param {BehaviorData} behaviorData The properties used to setup the behavior
|
||
|
|
* @param {gdjs.RuntimeObject} owner The object owning the behavior
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior = function(runtimeScene, behaviorData, owner)
|
||
|
|
{
|
||
|
|
this.name = behaviorData.name || "";
|
||
|
|
this.type = behaviorData.type || "";
|
||
|
|
this._nameId = gdjs.RuntimeObject.getNameIdentifier(this.name);
|
||
|
|
this._activated = true;
|
||
|
|
this.owner = owner;
|
||
|
|
};
|
||
|
|
/**
|
||
|
|
* Get the name of the behavior.
|
||
|
|
* @return {string} The behavior's name.
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.getName = function() {
|
||
|
|
return this.name;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get the name identifier of the behavior.
|
||
|
|
* @return {number} The behavior's name identifier.
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.getNameId = function() {
|
||
|
|
return this._nameId;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Called at each frame before events. Call doStepPreEvents.<br>
|
||
|
|
* Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.
|
||
|
|
* @param {gdjs.RuntimeScene} runtimeScene The runtimeScene owning the object
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.stepPreEvents = function(runtimeScene) {
|
||
|
|
if ( this._activated ) {
|
||
|
|
var profiler = runtimeScene.getProfiler();
|
||
|
|
if (profiler) profiler.begin(this.name);
|
||
|
|
|
||
|
|
this.doStepPreEvents(runtimeScene);
|
||
|
|
|
||
|
|
if (profiler) profiler.end(this.name);
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Called at each frame after events. Call doStepPostEvents.<br>
|
||
|
|
* Behaviors writers: Please do not redefine this method. Redefine doStepPreEvents instead.
|
||
|
|
* @param {gdjs.RuntimeScene} runtimeScene The runtimeScene owning the object
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.stepPostEvents = function(runtimeScene) {
|
||
|
|
if ( this._activated ) {
|
||
|
|
var profiler = runtimeScene.getProfiler();
|
||
|
|
if (profiler) profiler.begin(this.name);
|
||
|
|
|
||
|
|
this.doStepPostEvents(runtimeScene);
|
||
|
|
|
||
|
|
if (profiler) profiler.end(this.name);
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* De/Activate the behavior
|
||
|
|
* @param {boolean} enable true to enable the behavior, false to disable it
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.activate = function(enable) {
|
||
|
|
if ( enable === undefined ) enable = true;
|
||
|
|
if ( !this._activated && enable ) {
|
||
|
|
this._activated = true;
|
||
|
|
this.onActivate();
|
||
|
|
}
|
||
|
|
else if ( this._activated && !enable ) {
|
||
|
|
this._activated = false;
|
||
|
|
this.onDeActivate();
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reimplement this to do extra work when the behavior is created (i.e: an
|
||
|
|
* object using it was created), after the object is fully initialized (so
|
||
|
|
* you can use `this.owner` without risk).
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.onCreated = function() {
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Return true if the behavior is activated
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.activated = function() {
|
||
|
|
return this._activated;
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reimplement this method to do extra work when the behavior is activated (after
|
||
|
|
* it has been deactivated, see `onDeActivate`).
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.onActivate = function() {
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Reimplement this method to do extra work when the behavior is deactivated.
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.onDeActivate = function() {
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method is called each tick before events are done.
|
||
|
|
* @param {gdjs.RuntimeScene} runtimeScene The runtimeScene owning the object
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.doStepPreEvents = function(runtimeScene) {
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method is called each tick after events are done.
|
||
|
|
* @param {gdjs.RuntimeScene} runtimeScene The runtimeScene owning the object
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.doStepPostEvents = function(runtimeScene) {
|
||
|
|
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This method is called when the owner of the behavior
|
||
|
|
* is being removed from the scene and is about to be destroyed/reused later,
|
||
|
|
*/
|
||
|
|
gdjs.RuntimeBehavior.prototype.onDestroy = function() {
|
||
|
|
|
||
|
|
};
|
||
|
|
|
||
|
|
gdjs.registerBehavior("", gdjs.RuntimeBehavior);
|