Переглянути джерело

📝 Fix inconsistancies in the documentation of several pandora files

Pedro Schneider 3 роки тому
батько
коміт
712d3256ce

+ 8 - 3
pandora/game_objects/2d_objects/AnimatedSprite2D.js

@@ -24,6 +24,9 @@
  * Sprite2D and extends its functionality to automatically draw a series of sprites
  * to the screen forming an animation.
  * 
+ * ! All GameObjects need to be inside the tree to do anything (can be added as a child
+ * ! of another GameObject on the tree or as a root).
+ * 
  * @author Pedro Schneider
  * 
  * @class
@@ -31,7 +34,6 @@
 class AnimatedSprite2D extends Sprite2D
 {
     /**
-     * @constructor
      * Initializes as AnimatedSprite2D GameObject with the specified parameters.
      * 
      * @param {String} name                 name for this AnimatedSprite2D GameObject. 
@@ -39,6 +41,8 @@ class AnimatedSprite2D extends Sprite2D
      *                                      to the buffer.
      * @param {SpriteFrames} spriteFrames   data holding the animation in frames to be
      *                                      played by this GameObject.
+     * 
+     * @constructor
      */
     constructor(name, p5Image, spriteFrames)
     {
@@ -187,12 +191,13 @@ class AnimatedSprite2D extends Sprite2D
     }
 
     /**
-     * @override
      * Updates the current SpriteAnimation if its playing, and updates this
      * AnimatedSprite2D's P5Image to the current frame based on the current
      * SpriteAnimation.
      * 
      * @param {number} delta    number of seconds ellapsed since the last frame. 
+     * 
+     * @override
      */
     update(delta)
     {
@@ -205,7 +210,7 @@ class AnimatedSprite2D extends Sprite2D
                 this.timeSinceLastFrame = 0;
             }
         }
-        
+
         this.P5Image = this.getCurrentFrame();
         this._update(delta);
         for (let i = 0; i < this.children.length; i++)

+ 7 - 2
pandora/game_objects/2d_objects/Object2D.js

@@ -24,6 +24,9 @@
  * comprised of a position, a rotation in degrees and a scale. All parameters
  * of this transform are relative to the parent of this GameObject, if it has one.
  * 
+ * ! All GameObjects need to be inside the tree to do anything (can be added as a child
+ * ! of another GameObject on the tree or as a root).
+ * 
  * @author Pedro Schneider
  * 
  * @class
@@ -31,10 +34,11 @@
 class Object2D extends GameObject
 {
     /**
-     * @constructor
      * Initializes an empty Object2D GameObject.
      * 
      * @param {String} name name of the Object2D GameObject. 
+     * 
+     * @constructor
      */
     constructor(name)
     {
@@ -104,13 +108,14 @@ class Object2D extends GameObject
     }
 
     /**
-     * @override
      * Applies this Object2D's transform before calling this GameObject's _draw() callback
      * and recursively calls the same callback on all of it's children. This results in the
      * appearence of relative position.
      * 
      * @param {number} delta    number of seconds ellapsed since the last frame.
      * @param {p5.Graphics} db  secondary buffer to draw to.
+     * 
+     * @override
      */
     draw(delta, db)
     {

+ 7 - 2
pandora/game_objects/2d_objects/Shape2D.js

@@ -24,6 +24,9 @@
  * Object2D and extends its functionality to automatically draw a Shape on the
  * buffer, according to the data passed by a Shape component.
  * 
+ * ! All GameObjects need to be inside the tree to do anything (can be added as a child
+ * ! of another GameObject on the tree or as a root).
+ * 
  * @author Pedro Schneider
  * 
  * @class
@@ -31,12 +34,13 @@
 class Shape2D extends Object2D
 {
     /**
-     * @constructor
      * Initializes a Shape2D GameObject with the specified parameters.
      * 
      * @param {String} name         name for this Shape2D;
      * @param {SHAPES} shapeType    type of the shape for this Shape2D. 
      * @param {Shape} shape         dta for the shape of this Shape2D.
+     * 
+     * @constructor
      */
     constructor(name, shapeType = null, shape = null)
     {
@@ -54,13 +58,14 @@ class Shape2D extends Object2D
     }
 
     /**
-     * @override
      * Applies this Object2D's transform before calling this GameObject's _draw() callback
      * and recursively calls the same callback on all of it's children. Also draws a shape
      * on the buffer based on the data passed to this GameObject.
      * 
      * @param {number} delta    number in seconds ellapsed since the last frame.
      * @param {p5.Graphics} db  secondary buffer to draw to.
+     * 
+     * @override
      */
     draw(delta, db)
     {

+ 7 - 2
pandora/game_objects/2d_objects/Sprite2D.js

@@ -24,6 +24,9 @@
  * Object2D and extends its functionality to automatically draw a Sprite on the
  * buffer.
  * 
+ * ! All GameObjects need to be inside the tree to do anything (can be added as a child
+ * ! of another GameObject on the tree or as a root).
+ * 
  * @author Pedro Schneider
  * 
  * @class
@@ -31,11 +34,12 @@
 class Sprite2D extends Object2D
 {
     /**
-     * @constructor
      * Initializes a Sprite2D GameObject with the specified parameters.
      * 
      * @param {String} name         name for this Sprite2D. 
      * @param {p5.Image} p5Image    p5.Image to be drawn on the buffer.
+     * 
+     * @constructor
      */
     constructor(name, p5Image)
     {
@@ -45,13 +49,14 @@ class Sprite2D extends Object2D
     }
 
     /**
-     * @override
      * Applies this Object2D's transform before calling this GameObject's _draw() callback
      * and recursively calls the same callback on all of it's children. Also draws an image
      * on the buffer based on the data passed to this GameObject.
      * 
      * @param {number} delta    number in seconds ellapsed since the last frame.
      * @param {p5.Graphics} db  secondary buffer to draw to.
+     * 
+     * @override
      */
     draw(delta, db)
     {

+ 5 - 1
pandora/game_objects/AudioPlayer.js

@@ -23,6 +23,9 @@
  * The {@code AudioPlayer} class represents a GameObject that can playa p5.Audio
  * loaded from the AssetHandler.
  * 
+ * ! All GameObjects need to be inside the tree to do anything (can be added as a child
+ * ! of another GameObject on the tree or as a root).
+ * 
  * @author Pedro Schneider
  * 
  * @class
@@ -30,11 +33,12 @@
 class AudioPlayer extends GameObject
 {
     /**
-     * @constructor
      * Initializes an AudioPlayer GameObject with the given parameters.
      * 
      * @param {String} name         name for the AudioPlayer GameObject.
      * @param {p5.Audio} p5Audio    p5.Audio this AudioPlayer will play from.
+     * 
+     * @constructor
      */
     constructor(name, p5Audio = null)
     {

+ 11 - 5
pandora/game_objects/GameObject.js

@@ -34,10 +34,11 @@
 class GameObject
 {
     /**
-     * @constructor
      * Creates an empty GameObject, with default properties.
      * 
      * @param {String} name name of the new GameObject.
+     * 
+     * @constructor
      */
     constructor(name)
     {
@@ -59,6 +60,7 @@ class GameObject
 
     /**
      * Returns the list of children of this GameObject.
+     * 
      * @returns {Array} array containing a reference to all of this GameObject's
      *                  children.
      */
@@ -334,10 +336,11 @@ class GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * This function is called once when the GameObject is created and should declare
      * any and all signals the user wants for the GameObject.
+     * 
+     * @callback
      */
     _initSignals()
     {
@@ -345,10 +348,11 @@ class GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * This function is called once when the GameObject is added to the tree (as a child
      * of another GameObject or as a root).
+     * 
+     * @callback
      */
     _setup()
     {
@@ -356,12 +360,13 @@ class GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * This function is called once at the start of every frame and should be used for
      * any logic that doesn't have anything to do with drawing graphics to the screen buffer.
      * 
      * @param {number} delta    ellapsed seconds since the last frame. 
+     * 
+     * @callback
      */
     _update(delta)
     {
@@ -369,7 +374,6 @@ class GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * This function is called once at the start of every frame after all update() calls
      * have been completed and should be used for any logic that results in something
@@ -377,6 +381,8 @@ class GameObject
      * 
      * @param {number} delta    ellapsed seconds since the last frame. 
      * @param {p5.Graphics} db  secondary buffer to draw on. 
+     * 
+     * @callback
      */
     _draw(delta, db)
     {

+ 11 - 4
pandora/game_objects/Timer.js

@@ -23,6 +23,9 @@
  * The {@code Timer} class represents a Timer GameObject with the functionality
  * of emiting a signal after some amount of time passed.
  * 
+ * ! All GameObjects need to be inside the tree to do anything (can be added as a child
+ * ! of another GameObject on the tree or as a root).
+ * 
  * @author Pedro Schneider
  * 
  * @class
@@ -30,7 +33,6 @@
 class Timer extends GameObject
 {
     /**
-     * @constructor
      * Initializes a Timer GameObject with the given parameters.
      * 
      * @param {String} name         name for this Timer GameObject.
@@ -40,6 +42,8 @@ class Timer extends GameObject
      *                              when it enters the tree? Default is false.
      * @param {boolean} oneShot     should the timer run only once?
      *                              Default is false.
+     * 
+     * @constructor
      */
     constructor(name, duration = 1, autostart = false, oneShot = false)
     {
@@ -107,12 +111,13 @@ class Timer extends GameObject
     }
 
     /**
-     * @override
      * Updates the Timer and calls the onFinish() function if the timer ended.
      * Also recursively calls the update() function for all of this GameObject's
      * children.
      * 
      * @param {number} delta    time in seconds ellapsed since the last frame. 
+     * 
+     * @override
      */
     update(delta)
     {
@@ -128,11 +133,12 @@ class Timer extends GameObject
     }
 
     /**
-     * @override
      * Adds default signals for the Timer GameObject and serves as a caller
      * to the _initSignals() callback.
      * 
      * @signal timeout  emited once every time this timer is done.
+     * 
+     * @override
      */
     initSignals()
     {
@@ -141,10 +147,11 @@ class Timer extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time the Timer is done and can be used in
      * objects that inherit from Timer to add functinoality this event.
+     * 
+     * @callback
      */
     _onFinish()
     {

+ 13 - 5
pandora/game_objects/Tween.js

@@ -23,6 +23,9 @@
  * The {@code TweenData} class represents the data that a Tween GameObject needs to
  * interpolate a given property.
  * 
+ * ! All GameObjects need to be inside the tree to do anything (can be added as a child
+ * ! of another GameObject on the tree or as a root).
+ * 
  * @author Pedro Schneider
  * 
  * @class
@@ -30,7 +33,6 @@
 class TweenData
 {
     /**
-     * @constructor
      * Creates a TweenData Object with the specified parameters.
      * 
      * @param {Object} target                   Object that has the property to be interpolated.
@@ -45,6 +47,8 @@ class TweenData
      * @param {TRANS_TYPE} transType            transition type of the interpolation. 
      * @param {EASE_TYPE} easeType              easing type of the interpolation.
      * @param {number} delay                    delay in seconds for the interpolation to start. 
+     * 
+     * @constructor
      */
     constructor(target, property, propertyType, initVal, finalVal, duration, transType, easeType, delay)
     {
@@ -163,10 +167,11 @@ class TweenData
 class Tween extends GameObject
 {
     /**
-     * @constructor
      * Creates an empty Tween GameObject.
      * 
      * @param {String} name name of the Tween GameObject. 
+     * 
+     * @constructor
      */
     constructor(name)
     {
@@ -391,7 +396,6 @@ class Tween extends GameObject
     }
 
     /**
-     * @override
      * Adds default signals for the Tween GameObject and serves as a caller
      * to the _initSignals() callback.
      * 
@@ -403,6 +407,8 @@ class Tween extends GameObject
      * @signal tweenStarted         Emited once when one TweenData on this Tween
      *                              starts. Passes the started TweenData as a 
      *                              parameter.
+     * 
+     * @override
      */
     initSignals()
     {
@@ -413,10 +419,12 @@ class Tween extends GameObject
     }
 
     /**
-     * @override
      * Updates all TweenData added to this Tween and recursively calls the _update(delta)
      * callback for this GameObject and all of it's children.
-     * @param {*} delta 
+     * 
+     * @param {number} delta    number of ellapsed seconds since the last frame.
+     * 
+     * @override
      */
     update(delta)
     {

+ 2 - 1
pandora/game_objects/ui_objects/Button.js

@@ -32,11 +32,12 @@
 class Button extends UIObject
 {
     /**
-     * @constructor
      * Initializes an empty Button GameObject.
      * 
      * @param {String} name 
      * @param {String} label 
+     * 
+     * @constructor
      */
     constructor(name, label = "Button")
     {

+ 6 - 3
pandora/game_objects/ui_objects/CheckBox.js

@@ -32,13 +32,14 @@
 class CheckBox extends UIObject
 {
     /**
-     * @constructor
      * Initializes an empty CheckBox GameObject.
      * 
      * @param {String} name     name for the CheckBox GameObject. 
      * @param {String} label    label for the CheckBox GameObject.
      * @param {boolean} val     initial value for the CheckBox. True
      *                          for checked, false for unchecked.
+     * 
+     * @constructor
      */
     constructor(name, label = "checkbox", val = false)
     {
@@ -66,7 +67,6 @@ class CheckBox extends UIObject
     }
 
     /**
-     * @override
      * Defines default signals for UIObjects and serves as the caller to this UIObject's
      * _initSignals() callbacks. Also adds the extra onChaged signal for CheckBoxes.
      * 
@@ -94,6 +94,8 @@ class CheckBox extends UIObject
      * @signal dragLeave        emited once every time a dragged file leaves this UIObject's area.
      * 
      * @signal changed          emited once every time this UIObject's checkbox's value is changed.
+     * 
+     * @override
      */
     initSignals()
     {
@@ -128,9 +130,10 @@ class CheckBox extends UIObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time this UIObject's checkbox's value is changed.
+     * 
+     * @callback
      */
     _onChanged()
     {

+ 2 - 1
pandora/game_objects/ui_objects/ColorPicker.js

@@ -32,11 +32,12 @@
 class ColorPicker extends UIObject
 {
     /**
-     * @constructor
      * Initializes an empty ColorPicker with the specified parameters.
      * 
      * @param {String} name             name for the ColorPicker GameObject.
      * @param {p5.Color, String} color  default color for the ColorPicker
+     * 
+     * @constructor
      */
     constructor(name, color = "#FFFFFF")
     {

+ 6 - 3
pandora/game_objects/ui_objects/Input.js

@@ -32,12 +32,13 @@
 class Input extends UIObject
 {
     /**
-     * @constructor
      * Initializes an empty Input with the given parameters.
      * 
      * @param {String} name     name for the Input GameObject.
      * @param {String} value    default message inside the input box.
      * @param {String} type     type of the input box (e.g: "text", "password"). 
+     * 
+     * @constructor
      */
     constructor(name, value = "", type = "text")
     {
@@ -54,7 +55,6 @@ class Input extends UIObject
     }
 
     /**
-     * @override
      * Defines default signals for UIObjects and serves as the caller to this UIObject's
      * _initSignals() callbacks. Also adds the extra onChaged signal for CheckBoxes.
      * 
@@ -82,6 +82,8 @@ class Input extends UIObject
      * @signal dragLeave        emited once every time a dragged file leaves this UIObject's area.
      * 
      * @signal input            emited once every time and input is dettected.
+     * 
+     * @override
      */
     initSignals()
     {
@@ -116,9 +118,10 @@ class Input extends UIObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once everty this this UIObject's input is triggered i.e typing.
+     * 
+     * @callback
      */
     _onInput()
     {

+ 2 - 1
pandora/game_objects/ui_objects/Label.js

@@ -32,11 +32,12 @@
 class Label extends UIObject
 {
     /**
-     * @constructor
      * Initializes and empty Label with the specified parameters.
      * 
      * @param {String} name name for the Label GameObject. 
      * @param {String} text inner HTML text of the label.
+     * 
+     * @constructor
      */
     constructor(name, text = "Label")
     {

+ 6 - 3
pandora/game_objects/ui_objects/Radio.js

@@ -32,10 +32,11 @@
 class Radio extends UIObject
 {
     /**
-     * @constructor
      * Initializes an empty Radio.
      * 
      * @param {String} name name for the Radio GameObject. 
+     * 
+     * @constructor
      */
     constructor(name)
     {
@@ -119,7 +120,6 @@ class Radio extends UIObject
     }
 
     /**
-     * @override
      * Defines default signals for UIObjects and serves as the caller to this UIObject's
      * _initSignals() callbacks. Also adds the extra onChaged signal for CheckBoxes.
      * 
@@ -147,6 +147,8 @@ class Radio extends UIObject
      * @signal dragLeave        emited once every time a dragged file leaves this UIObject's area.
      * 
      * @signal changed          emited once every time this UIObject's radio button's value is changed.
+     * 
+     * @override
      */
     initSignals()
     {
@@ -181,9 +183,10 @@ class Radio extends UIObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time this UIObject's radio button's value is changed.
+     * 
+     * @callback
      */
     _onChanged()
     {

+ 6 - 3
pandora/game_objects/ui_objects/Select.js

@@ -32,10 +32,11 @@
 class Select extends UIObject
 {
     /**
-     * @constructor
      * Intializes an empty Select.
      * 
      * @param {String} name name for the Select GameObject.
+     * 
+     * @constructor
      */
     constructor(name)
     {
@@ -94,7 +95,6 @@ class Select extends UIObject
     // }
 
     /**
-     * @override
      * Defines default signals for UIObjects and serves as the caller to this UIObject's
      * _initSignals() callbacks. Also adds the extra onChaged signal for CheckBoxes.
      * 
@@ -122,6 +122,8 @@ class Select extends UIObject
      * @signal dragLeave        emited once every time a dragged file leaves this UIObject's area.
      * 
      * @signal changed          emited once every time this UIObject's select's value is changed.
+     * 
+     * @override
      */
     initSignals()
     {
@@ -156,9 +158,10 @@ class Select extends UIObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time this UIObject's select's value is changed.
+     * 
+     * @callback
      */
     _onChanged()
     {

+ 6 - 3
pandora/game_objects/ui_objects/Slider.js

@@ -32,7 +32,6 @@
 class Slider extends UIObject
 {
     /**
-     * @constructor
      * Initializes a Slider with the specified parameters.
      * 
      * @param {String} name     name for the Slider GameObject. 
@@ -40,6 +39,8 @@ class Slider extends UIObject
      * @param {number} max      maximum value on the slider.
      * @param {number} value    initial value for the slider.
      * @param {number} step     step value for the slider.
+     * 
+     * @constructor
      */
     constructor(name, min = 0, max = 100, value = 0, step = 0)
     {
@@ -56,7 +57,6 @@ class Slider extends UIObject
     }
 
     /**
-     * @override
      * Defines default signals for UIObjects and serves as the caller to this UIObject's
      * _initSignals() callbacks. Also adds the extra onChaged signal for CheckBoxes.
      * 
@@ -84,6 +84,8 @@ class Slider extends UIObject
      * @signal dragLeave        emited once every time a dragged file leaves this UIObject's area.
      * 
      * @signal changed          emited once every time this UIObject's slider's value is changed.
+     * 
+     * @override
      */
     initSignals()
     {
@@ -118,9 +120,10 @@ class Slider extends UIObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time this UIObject's slider's value is changed.
+     * 
+     * @callback
      */
     _onChanged()
     {

+ 38 - 20
pandora/game_objects/ui_objects/UIObject.js

@@ -33,10 +33,11 @@
 class UIObject extends GameObject
 {
     /**
-     * @constructor
      * Initializes an empty UIObject.
      * 
      * @param {String} name name for this UIObject. 
+     * 
+     * @constructor
      */
     constructor(name)
     {
@@ -227,11 +228,12 @@ class UIObject extends GameObject
     }
 
     /**
-     * @override
      * Adds a GameObject as a child of this UIObject, and parents the child's p5.Element
      * if they are a UIObject.
      * 
      * @param {GameObject} child 
+     * 
+     * @override
      */
     addChild(child)
     {
@@ -244,9 +246,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @override
      * Recursively marks this GameObject's and all of its children's
      * memory for garbage collection. Also removes this UIObject's p5.Element.
+     * 
+     * @override
      */
     destroy()
     {
@@ -261,7 +264,6 @@ class UIObject extends GameObject
     }
 
     /**
-     * @override
      * Defines default signals for UIObjects and serves as the caller to this UIObject's
      * _initSignals() callbacks.
      * 
@@ -287,6 +289,8 @@ class UIObject extends GameObject
      * @signal touchEnded       emited once every time a touch is regiestered over this UIObject.
      * @signal dragOver         emited once every time a file is dragged over this UIObject.
      * @signal dragLeave        emited once every time a dragged file leaves this UIObject's area.
+     * 
+     * @override
      */
     initSignals()
     {
@@ -308,15 +312,16 @@ class UIObject extends GameObject
     }
 
     /**
-     * @override
      * Updates this UIObject's p5.Element size, position and font size based
      * on the secondary buffer's size on the actual window. This gives the
      * impression that the HTML element is actually beeing drawn to the secondary
      * buffer instead of the main one.
      * ? is it possible to draw them directly to the secondary buffer?
      * 
-     * @param {number} delta 
-     * @param {p5.Graphics} db 
+     * @param {number} delta    number of ellapsed seconds since the last frame.
+     * @param {p5.Graphics} db  secondary buffer to draw to.
+     * 
+     * @override
      */
     draw(delta, db)
     {
@@ -497,9 +502,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a mouse button is pressed over this UIObject.
+     * 
+     * @callback
      */
     _onMousePressed()
     {
@@ -507,9 +513,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a mouse button in pressed twice over this UIObject.
+     * 
+     * @callback
      */
     _onDoubleClicked()
     {
@@ -517,10 +524,11 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a mouse wheel is scrolled over this UIObject.
      * 
+     * @callback
+     * 
      * @param {Object} event    contains data about the wheen scroll, with the deltaY
      *                          and deltaX property, containing data about the vertical
      *                          and horizontal scrolling, repsctively.
@@ -531,9 +539,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a mouse button is released over this UIObject.
+     * 
+     * @callback
      */
     _onMouseReleased()
     {
@@ -541,9 +550,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a mouse button is pressed and released over this UIObject.
+     * 
+     * @callback
      */
     _onMouseClicked()
     {
@@ -551,9 +561,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once everty time a mouse moves over this UIObject.
+     * 
+     * @callback
      */
     _onMouseMoved()
     {
@@ -561,9 +572,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a mouse moves onto this UIObject.
+     * 
+     * @callback
      */
     _onMouseOver()
     {
@@ -571,9 +583,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a mouse moves off the UIObject.
+     * 
+     * @callback
      */
     _onMouseOut()
     {
@@ -581,9 +594,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a touch is registered over this UIObject.
+     * 
+     * @callback
      */
     _onTouchStarted()
     {
@@ -591,9 +605,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a touch move is registered over this UIObject.
+     * 
+     * @callback
      */
     _onTouchMoved()
     {
@@ -601,9 +616,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a touch is registered over this UIObject.
+     * 
+     * @callback
      */
     _onTouchEnded()
     {
@@ -611,9 +627,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a file is dragged over this UIObject's area.
+     * 
+     * @callback
      */
     _onDragOver()
     {
@@ -621,9 +638,10 @@ class UIObject extends GameObject
     }
 
     /**
-     * @callback
      * ! This function should be overriden, it provides no default functionality.
      * Called once every time a dragged file leaves tis UIObject's area.
+     * 
+     * @callback
      */
     _onDragLeave()
     {

+ 3 - 2
pandora/handlers/GameHandler.js

@@ -214,7 +214,7 @@ const GameHandler = {
 
         // Updates the delta.
         this.delta = (millis() - this.prevMillis) / 1000;
-        
+
         // Updates all game objects on the tree.
         for (let i = 0; i < this.rootObjects.length; i++)
             this.rootObjects[i].update(this.delta);
@@ -263,9 +263,10 @@ const GameHandler = {
 }
 
 /**
- * @callback
  * This function is called once every time the browser window is resized. Here, its used to make the game
  * always ocupy the entire browser window.
+ * 
+ * @callback
  */
 function windowResized()
 {

+ 11 - 0
pandora/singletons/Easings.js

@@ -69,6 +69,7 @@ const Easings = {
 
     /**
      * Namespace to separate linear easing equations.
+     * 
      * @namespace
      */
     Linear:
@@ -91,6 +92,7 @@ const Easings = {
 
     /**
      * Namespace to separate quadratic easing equations.
+     * 
      * @namespace
      */
     Quad:
@@ -144,6 +146,7 @@ const Easings = {
 
     /**
      * Namespace to separate cubic easing equations.
+     * 
      * @namespace
      */
     Cubic:
@@ -197,6 +200,7 @@ const Easings = {
 
     /**
      * Namespace to separate quartic easing equations.
+     * 
      * @namespace
      */
     Quart:
@@ -250,6 +254,7 @@ const Easings = {
 
     /**
      * Namespace to separate quintic easing equations.
+     * 
      * @namespace
      */
     Quint:
@@ -303,6 +308,7 @@ const Easings = {
 
     /**
      * Namespace to separate senoidal easing equations.
+     * 
      * @namespace
      */
     Sine:
@@ -355,6 +361,7 @@ const Easings = {
 
     /**
      * Namespace to separate exponential easing equations.
+     * 
      * @namespace
      */
     Expo:
@@ -410,6 +417,7 @@ const Easings = {
 
     /**
      * Namespace to separate circular easing equations.
+     * 
      * @namespace
      */
     Circ:
@@ -463,6 +471,7 @@ const Easings = {
 
     /**
      * Namespace to separate elastic easing equations.
+     * 
      * @namespace
      */
     Elastic:
@@ -552,6 +561,7 @@ const Easings = {
 
     /**
      * Namespace to separate back easing equations.
+     * 
      * @namespace
      */
     Back:
@@ -608,6 +618,7 @@ const Easings = {
 
     /**
      * Namespace to separate bounce easing equations.
+     * 
      * @namespace
      */
     Bounce: