Add module:Celestial, refactor

Author: una-ada

js/main.js

@@ -10,6 +10,7 @@ import DOMRenderer from "./modules/DOMRenderer.js";
 import Physics from "./modules/Physics.js";
 import GameData from "./modules/GameData.js";
 
+/*----- Initialize -----------------------------------------------------------*/
 const model = new GameData(),
   view = new DOMRenderer(model),
   physics = new Physics(model),

js/modules/Celestial.js

@@ -0,0 +1,42 @@
+/**
+ * @file    Celestial game objects.
+ * @author  Una Ada <una@anarchy.website>
+ * @version 2021.06.02
+ */
+
+/*----- Imports --------------------------------------------------------------*/
+import { Point, Vector } from "./Utils.js";
+
+/*----- Classes --------------------------------------------------------------*/
+/** @module Celestial - Celestial game objects. */
+export default class Celestial {
+	/**
+	 * Create a new celestial game object.
+	 * @arg {Object} options Optional parameters.
+	 * @arg {string} [options.name="Unnamed Celestial"] Display name.
+	 * @arg {Point} [options.position] Position coordinates in meters.
+	 * @arg {Vector} [options.velocity] Velocity vector in meters/second.
+	 * @arg {Vector} [options.acceleration] Acceleration vector in meters/second^2
+	 * @arg {number} [options.mass=0] Mass in kilograms.
+   * @arg {number} [options.size=0] Width or diameter in meters.
+   * @arg {ImageData} [options.texture] The texture for rendering.
+	 */
+	constructor(options) {
+		/*----- Metadata ---------------------------------------------------------*/
+		this.name = options.name || "Unnamed Celestial";
+    /** @var {number} birth Creation timestamp. */
+		this.birth = +new Date();
+
+    /*----- Physics ----------------------------------------------------------*/
+		this.position = options.positions || new Point(0, 0);
+		this.velocity = options.velocity || new Vector(0, 0);
+		this.mass = options.mass || 0;
+		/** @TODO Add HitBox class */
+		this.hitBox = null;
+
+    /*----- Rendering --------------------------------------------------------*/
+		this.size = options.size || 0;
+		this.texture = options.texture || null;
+
+	}
+}

js/modules/DOMRenderer.js

@@ -8,11 +8,12 @@
 import GameData from "./GameData.js";
 import Renderer from "./Renderer.js";
 
+/*----- Classes --------------------------------------------------------------*/
 /** @module DOMRenderer - Manages the game view (DOM). */
 export default class extends Renderer {
   /**
    * Initialize a DOM-based renderer.
-   * @param {GameData} model - A game model instance.
+   * @arg {GameData} model - A game model instance.
    */
   constructor(model) {
     super(model);

js/modules/Game.js

@@ -5,21 +5,25 @@
  */
 
 /*----- Imports --------------------------------------------------------------*/
+import Celestial from "./Celestial.js";
 import GameData from "./GameData.js";
 import Renderer from "./Renderer.js";
 
+/*----- Classes --------------------------------------------------------------*/
 /** @module Game - Manages the game controller. */
 export default class Game {
   /**
    * Initialize a game controller.
-   * @param {GameData} model - A game model instance.
-   * @param {Renderer} view - A game view instance.
+   * @arg {GameData} model - A game model instance.
+   * @arg {Renderer} view - A game view instance.
    */
   constructor(model, view) {
     /** @var {GameData} model - Reference to the game's model */
     this.model = model;
     /** @var {Renderer} view - Reference to the game's view */
     this.view = view;
+    
+    let test = new Celestial({name: "Fuck"});
   }
 
   /*----- Constants ----------------------------------------------------------*/
@@ -34,7 +38,7 @@ export default class Game {
   /*----- Event Handlers -----------------------------------------------------*/
   /**
    * Handle mouse down events
-   * @param {MouseEvent} e - Mouse down event
+   * @arg {MouseEvent} e - Mouse down event
    */
   handleMouseDown(e) {
     let mouse = this.model.mouse;
@@ -44,7 +48,7 @@ export default class Game {
   }
   /**
    * Handle mouse up events
-   * @param {MouseEvent} e - Mouse up event
+   * @arg {MouseEvent} e - Mouse up event
    */
   handleMouseUp(e) {
     let mouse = this.model.mouse;
@@ -53,7 +57,7 @@ export default class Game {
   }
   /**
    * Handle mouse move events
-   * @param {MouseEvent} e - Mouse move event
+   * @arg {MouseEvent} e - Mouse move event
    */
   handleMouseMove(e) {
     this.model.mouse.position.update(e.pageX, e.pageY);

js/modules/GameData.js

@@ -7,6 +7,7 @@
 /*----- Imports --------------------------------------------------------------*/
 import { Point, Vector } from "./Utils.js";
 
+/*----- Classes --------------------------------------------------------------*/
 /** @module GameData - Manages the game model. */
 export default class {
   /** Initialize a game model. */

js/modules/Physics.js

@@ -4,6 +4,7 @@
  * @version 2021.06.01
  */
 
+/*----- Classes --------------------------------------------------------------*/
 /** @module Physics - Manages the physics simulation. */
 export default class {
   /** Initialize physics engine. */

js/modules/Renderer.js

@@ -7,19 +7,20 @@
 /*----- Imports --------------------------------------------------------------*/
 import GameData from "./GameData.js";
 
+/*----- Classes --------------------------------------------------------------*/
 /** @module Renderer - Superclass for managing game view. */
 export default class {
   /**
    * Initialize base rendering functions.
-   * @param {GameData} model - A game model instance.
+   * @arg {GameData} model - A game model instance.
    */
   constructor(model) {
     /** @var {GameData} model - Reference to the game's model. */
     this.model = model;
   }
   /**
    * Sets the view container
-   * @param {HTMLElement} el - Element to set as view container.
+   * @arg {HTMLElement} el - Element to set as view container.
    */
   setContainer(el) {
     el.id = `gravity-${this.model.id}`;

js/modules/Utils.js

@@ -4,12 +4,13 @@
  * @version 2021.06.02
  */
 
+/*----- Classes --------------------------------------------------------------*/
 /** A single point in cartesian coordinated. */
 export class Point {
   /**
    * Create a single point.
-   * @param {number} x - The point's x coordinate.
-   * @param {number} y - The point's y coordinate.
+   * @arg {number} x - The point's x coordinate.
+   * @arg {number} y - The point's y coordinate.
    */
   constructor(x, y) {
     /** @var {number} Point#x - The point's x coordinate. */
@@ -19,8 +20,8 @@ export class Point {
   }
   /**
    * Update coordinates.
-   * @param {number} x - New x coordinate.
-   * @param {number} y - New y coordinate.
+   * @arg {number} x - New x coordinate.
+   * @arg {number} y - New y coordinate.
    */
   update(x, y) {
     this.x = x;
@@ -31,8 +32,8 @@ export class Point {
 export class Vector extends Point {
   /**
    * Create a 2-dimensional vector.
-   * @param {number} x - The vector's x length.
-   * @param {number} y - The vector's y length.
+   * @arg {number} x - The vector's x length.
+   * @arg {number} y - The vector's y length.
    */
   constructor(x, y) {
     super(x, y);