more docs

www/mods/_multiplayer/gameOverScene.js

@@ -13,6 +13,10 @@ MATTIE.CmdManager.spectate = 'MATTIE_Spectate';
 MATTIE.TextManager.bornAnew = 'Be born anew';
 MATTIE.CmdManager.bornAnew = 'rebirth';
 
+/**
+ * @description the class for the game over screen scene.
+ * @class
+ */
 MATTIE.scenes.multiplayer.Scene_GameOver = function () {
 	this.initialize.apply(this, arguments);
 };

www/mods/_multiplayer/hostMenu.js

@@ -16,6 +16,7 @@ MATTIE.CmdManager.show = 'MATTIE_Show_Hide';
 /**
  * @description The scene for hosting a multiplayer game
  * @extends Scene_Base
+ * @class
  */
 MATTIE.scenes.multiplayer.host = function () {
 	this.initialize.apply(this, arguments);

www/mods/_multiplayer/joinMenu.js

@@ -14,6 +14,7 @@ MATTIE.CmdManager.reconnect = 'MATTIE_Reconnect';
 /**
  * @description The scene for hosting a multiplayer game
  * @extends Scene_Base
+ * @class
  */
 MATTIE.scenes.multiplayer.join = function () {
 	this.initialize.apply(this, arguments);

www/mods/_multiplayer/lobby.js

@@ -12,6 +12,7 @@ MATTIE.helpOncePerSession = false;
 /**
  * @description The scene for hosting a multiplayer game
  * @extends MATTIE.scenes.multiplayer.base
+ * @class
  */
 MATTIE.scenes.multiplayer.lobby = function () {
 	this.initialize.apply(this, arguments);

www/mods/_multiplayer/multiCombatMenu.js

@@ -215,6 +215,10 @@ Sprite_Actor.prototype.setActorHome = function (index) {
 	this.setHome(50 + xOffset, Graphics.boxHeight - MATTIE.multiplayer.multiCombat.minCharHeight - rowOffset - yOffset);
 };
 
+/**
+ * @description a window that displays the current number of alies in the fight with you.
+ * @class
+ */
 MATTIE.windows.multiplayer.multiCombat.AllyCount = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -483,6 +487,10 @@ Window_BattleActor.prototype.actor = function () {
 // SPRITE Net Ex Turn
 //-----------------------------------------------------------------------------
 
+/**
+ * @description a window that displays the extra turn pop up
+ * @class
+ */
 MATTIE.multiplayer.SpriteNetExTurn = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -511,6 +519,10 @@ MATTIE.multiplayer.SpriteNetExTurn.prototype.update = function () {
 // SPRITE Ready
 //-----------------------------------------------------------------------------
 
+/**
+ * @description a window that displays the ready popup in battle
+ * @class
+ */
 MATTIE.multiplayer.SpriteReady = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -539,6 +551,10 @@ MATTIE.multiplayer.SpriteReady.prototype.update = function () {
 // SPRITE Awaiting Allies
 //-----------------------------------------------------------------------------
 
+/**
+ * @description a window that displays the waiting popup in battle
+ * @class
+ */
 MATTIE.multiplayer.SpriteWaiting = function () {
 	this.initialize.apply(this, arguments);
 };

www/mods/_multiplayer/multiplayerMenu.js

@@ -13,6 +13,11 @@ MATTIE.CmdManager.return = 'MATTIE_return';
 MATTIE.CmdManager.newGame = 'MATTIE_New_Game';
 MATTIE.CmdManager.loadGame = 'MATTIE_Load_Game';
 
+/**
+ * @description a scene that extends scene base but loads my bitmap instead, this is not really needed and is just
+ * legacy code left over from when I didn't really understand the engine
+ * @class
+ */
 MATTIE.scenes.multiplayer.base = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -33,7 +38,10 @@ MATTIE.scenes.multiplayer.base.prototype.createBackground = function () {
 /**
  * main scene
  */
-
+/**
+ * @description a scene that displays the username input and the multiplayer host/join btns
+ * @class
+ */
 MATTIE.scenes.multiplayer.main = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -93,6 +101,10 @@ MATTIE.scenes.multiplayer.main.prototype.createBackground = function () {
 /**
  * main window
  */
+/**
+ * @description a window the main multiplayer join/host btns
+ * @class
+ */
 MATTIE.windows.multiplayer.Main = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -109,6 +121,10 @@ MATTIE.windows.multiplayer.Main.prototype.makeCommandList = function () {
 /**
  * main window
  */
+/**
+ * @description a window that displays the load/new game buttons when a multiplayer game is starting
+ * @class
+ */
 MATTIE.windows.multiplayer.StartWin = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -124,6 +140,10 @@ MATTIE.windows.multiplayer.StartWin.prototype.makeCommandList = function () {
 /**
  * new game win
  */
+/**
+ * @description a window that displays the load/new game buttons when a multiplayer game is starting.
+ * @class
+ */
 MATTIE.windows.multiplayer.NewGameWin = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -143,6 +163,7 @@ MATTIE.windows.multiplayer.NewGameWin.prototype.makeCommandList = function () {
  * // Scene_DevItems
  * @description a scene to spawn in items for dev
  * @extends Scene_Item
+ * @class
  */
 MATTIE.scenes.Scene_DropItem = function () {
 	this.initialize.apply(this, arguments);

www/mods/_multiplayer/netControllerV2/models/netActors.js

@@ -24,7 +24,10 @@ DataManager.extractSaveContents = function (contents) {
 		console.log('could not create local player');
 	}
 };
-/** a simple class containing the game actor and the assosiated dataActor id (for clean up) */
+/** 
+ * @description a simple class containing the game actor and the assosiated dataActor id (for clean up)
+ * @class
+ */
 MATTIE.multiplayer.NetActor = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -36,7 +39,10 @@ MATTIE.multiplayer.NetActor.prototype.initialize = function (gameActor, dataActo
 	this.baseActorId = baseActorId;
 };
 
-/** the wrapper class of an array of net actors */
+/**
+ * @description a wrapper class for an array of net actors
+ * @class
+ */
 MATTIE.multiplayer.NetActors = function () {
 	this.initialize.apply(this, arguments);
 };

www/mods/_multiplayer/netControllerV2/models/playerFollowerModel.js

@@ -4,6 +4,10 @@ MATTIE.menus.multiplayer = MATTIE.menus.multiplayer || {};
 MATTIE.scenes.multiplayer = MATTIE.scenes.multiplayer || {};
 MATTIE.windows.multiplayer = MATTIE.windows.multiplayer || {};
 
+/**
+ * @description a class that extends a game_follower for net players
+ * @class
+ */
 MATTIE.multiplayer.NetFollower = function () {
 	this.initialize.apply(this, arguments);
 };
@@ -65,6 +69,10 @@ MATTIE.multiplayer.NetFollower.prototype.chaseCharacter = function (character) {
 	}
 };
 
+/**
+ * @description a wrapper class for an array of netFollowers
+ * @class
+ */
 MATTIE.multiplayer.NetFollowers = function () {
 	this.initialize.apply(this, arguments);
 };

www/mods/_multiplayer/netControllerV2/playerRenderer.js

@@ -56,6 +56,10 @@ MATTIE.multiplayer.renderer._renderNetPlayers = function (target) {
 //
 // The sprite for displaying a character.
 
+/**
+ * @description a simple wrapper class for spriteChar to display net sprites
+ * @class
+ */
 MATTIE.multiplayer.NetSpriteChar = function () {
 	this.initialize.apply(this, arguments);
 };

www/mods/_multiplayer/spectateScene.js

@@ -11,6 +11,7 @@ MATTIE.multiplayer.spectate.init = Scene_Map.prototype.initialize;
  * Scene_Spectate
  * @description a scene for spectating after death
  * @extends Scene_Map
+ * @class
  */
 
 MATTIE.scenes.multiplayer.Scene_Spectate = function () {

www/mods/_multiplayer/startGameMenu.js

@@ -7,6 +7,10 @@ MATTIE.windows.multiplayer = MATTIE.windows.multiplayer || {};
  * start game scene
  */
 
+/**
+ * @description a scene to display when starting the game.
+ * @class
+ */
 MATTIE.scenes.multiplayer.startGame = function () {
 	this.initialize.apply(this, arguments);
 };

www/mods/commonLibs/_common/API_CORE/troopAPI.js

@@ -374,6 +374,7 @@ Game_Troop.prototype.meetsConditions = function (page) {
  * @param {int} xOffset, screen x offset for entire troop
  * @param {int} yOffset, screen y offset for entire troop
  * @returns {MATTIE.troopAPI.RuntimeTroop}
+ * @class
  * */
 MATTIE.troopAPI.RuntimeTroop = function () {
 	this.initialize.apply(this, arguments);