littlejsengine 1.11.9 → 1.11.13

package/src/engineSettings.js

@@ -16,7 +16,7 @@
 let cameraPos = vec2();
 
 /** Scale of camera in world space
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let cameraScale = 32;
@@ -38,31 +38,34 @@ let canvasMaxSize = vec2(1920, 1080);
 let canvasFixedSize = vec2();
 
 /** Use nearest neighbor scaling algorithm for canvas for more pixelated look
- *  @type {Boolean}
+ *  - Must be set before startup to take effect
+ *  - If enabled sets css image-rendering:pixelated
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let canvasPixelated = true;
 
 /** Disables texture filtering for crisper pixel art
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let tilesPixelated = true;
 
 /** Default font used for text rendering
- *  @type {String}
+ *  @type {string}
  *  @default
  *  @memberof Settings */
 let fontDefault = 'arial';
 
 /** Enable to show the LittleJS splash screen be shown on startup
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let showSplashScreen = false;
 
 /** Disables all rendering, audio, and input for servers
- *  @type {Boolean}
+ *  - Must be set before startup to take effect
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let headlessMode = false;
@@ -71,13 +74,15 @@ let headlessMode = false;
 // WebGL settings
 
 /** Enable webgl rendering, webgl can be disabled and removed from build (with some features disabled)
- *  @type {Boolean}
+ *  - Must be set before startup to take effect
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let glEnable = true;
 
 /** Fixes slow rendering in some browsers by not compositing the WebGL canvas
- *  @type {Boolean}
+ *  - Must be set before startup to take effect
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let glOverlay = true;
@@ -92,7 +97,7 @@ let glOverlay = true;
 let tileSizeDefault = vec2(16);
 
 /** How many pixels smaller to draw tiles to prevent bleeding from neighbors
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let tileFixBleedScale = 0;
@@ -101,55 +106,55 @@ let tileFixBleedScale = 0;
 // Object settings
 
 /** Enable physics solver for collisions between objects
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let enablePhysicsSolver = true;
 
 /** Default object mass for collision calculations (how heavy objects are)
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let objectDefaultMass = 1;
 
 /** How much to slow velocity by each frame (0-1)
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let objectDefaultDamping = 1;
 
 /** How much to slow angular velocity each frame (0-1)
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let objectDefaultAngleDamping = 1;
 
 /** How much to bounce when a collision occurs (0-1)
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let objectDefaultElasticity = 0;
 
 /** How much to slow when touching (0-1)
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let objectDefaultFriction = .8;
 
 /** Clamp max speed to avoid fast objects missing collisions
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let objectMaxSpeed = 1;
 
 /** How much gravity to apply to objects along the Y axis, negative is down
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let gravity = 0;
 
 /** Scales emit rate of particles, useful for low graphics mode (0 disables particle emitters)
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let particleEmitRateScale = 1;
@@ -158,58 +163,59 @@ let particleEmitRateScale = 1;
 // Input settings
 
 /** Should gamepads be allowed
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let gamepadsEnable = true;
 
 /** If true, the dpad input is also routed to the left analog stick (for better accessability)
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let gamepadDirectionEmulateStick = true;
 
 /** If true the WASD keys are also routed to the direction keys (for better accessability)
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let inputWASDEmulateDirection = true;
 
 /** True if touch input is enabled for mobile devices
  *  - Touch events will be routed to mouse events
- *  @type {Boolean}
+ *  - Must be set before startup to take effect
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let touchInputEnable = true;
 
 /** True if touch gamepad should appear on mobile devices
  *  - Supports left analog stick, 4 face buttons and start button (button 9)
- *  - Must be set by end of gameInit to be activated
- *  @type {Boolean}
+ *  - Must be set before startup to take effect
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let touchGamepadEnable = false;
 
 /** True if touch gamepad should be analog stick or false to use if 8 way dpad
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let touchGamepadAnalog = true;
 
 /** Size of virtual gamepad for touch devices in pixels
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let touchGamepadSize = 99;
 
 /** Transparency of touch gamepad overlay
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let touchGamepadAlpha = .3;
 
 /** Allow vibration hardware if it exists
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let vibrateEnable = true;
@@ -218,25 +224,25 @@ let vibrateEnable = true;
 // Audio settings
 
 /** All audio code can be disabled and removed from build
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let soundEnable = true;
 
 /** Volume scale to apply to all sound, music and speech
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let soundVolume = .3;
 
 /** Default range where sound no longer plays
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let soundDefaultRange = 40;
 
 /** Default range percent to start tapering off sound (0-1)
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let soundDefaultTaper = .7;
@@ -245,13 +251,13 @@ let soundDefaultTaper = .7;
 // Medals settings
 
 /** How long to show medals for in seconds
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let medalDisplayTime = 5;
 
 /** How quickly to slide on/off medals in seconds
- *  @type {Number}
+ *  @type {number}
  *  @default
  *  @memberof Settings */
 let medalDisplaySlideTime = .5;
@@ -262,14 +268,8 @@ let medalDisplaySlideTime = .5;
  *  @memberof Settings */
 let medalDisplaySize = vec2(640, 80);
 
-/** Size of icon in medal display
- *  @type {Number}
- *  @default
- *  @memberof Settings */
-let medalDisplayIconSize = 50;
-
 /** Set to stop medals from being unlockable (like if cheats are enabled)
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let medalsPreventUnlock = false;
@@ -283,7 +283,7 @@ let medalsPreventUnlock = false;
 function setCameraPos(pos) { cameraPos = pos; }
 
 /** Set scale of camera in world space
- *  @param {Number} scale
+ *  @param {number} scale
  *  @memberof Settings */
 function setCameraScale(scale) { cameraScale = scale; }
 
@@ -298,37 +298,37 @@ function setCanvasMaxSize(size) { canvasMaxSize = size; }
 function setCanvasFixedSize(size) { canvasFixedSize = size; }
 
 /** Use nearest neighbor scaling algorithm for canvas for more pixelated look
- *  @param {Boolean} pixelated
+ *  @param {boolean} pixelated
  *  @memberof Settings */
 function setCanvasPixelated(pixelated) { canvasPixelated = pixelated; }
 
 /** Disables texture filtering for crisper pixel art
- *  @param {Boolean} pixelated
+ *  @param {boolean} pixelated
  *  @memberof Settings */
 function setTilesPixelated(pixelated) { tilesPixelated = pixelated; }
 
 /** Set default font used for text rendering
- *  @param {String} font
+ *  @param {string} font
  *  @memberof Settings */
 function setFontDefault(font) { fontDefault = font; }
 
 /** Set if the LittleJS splash screen be shown on startup
- *  @param {Boolean} show
+ *  @param {boolean} show
  *  @memberof Settings */
 function setShowSplashScreen(show) { showSplashScreen = show; }
 
 /** Set to disable rendering, audio, and input for servers
- *  @param {Boolean} headless
+ *  @param {boolean} headless
  *  @memberof Settings */
 function setHeadlessMode(headless) { headlessMode = headless; }
 
 /** Set if webgl rendering is enabled
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setGlEnable(enable) { glEnable = enable; }
 
 /** Set to not composite the WebGL canvas
- *  @param {Boolean} overlay
+ *  @param {boolean} overlay
  *  @memberof Settings */
 function setGlOverlay(overlay) { glOverlay = overlay; }
 
@@ -338,107 +338,107 @@ function setGlOverlay(overlay) { glOverlay = overlay; }
 function setTileSizeDefault(size) { tileSizeDefault = size; }
 
 /** Set to prevent tile bleeding from neighbors in pixels
- *  @param {Number} scale
+ *  @param {number} scale
  *  @memberof Settings */
 function setTileFixBleedScale(scale) { tileFixBleedScale = scale; }
 
 /** Set if collisions between objects are enabled
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setEnablePhysicsSolver(enable) { enablePhysicsSolver = enable; }
 
 /** Set default object mass for collision calculations
- *  @param {Number} mass
+ *  @param {number} mass
  *  @memberof Settings */
 function setObjectDefaultMass(mass) { objectDefaultMass = mass; }
 
 /** Set how much to slow velocity by each frame
- *  @param {Number} damp
+ *  @param {number} damp
  *  @memberof Settings */
 function setObjectDefaultDamping(damp) { objectDefaultDamping = damp; }
 
 /** Set how much to slow angular velocity each frame
- *  @param {Number} damp
+ *  @param {number} damp
  *  @memberof Settings */
 function setObjectDefaultAngleDamping(damp) { objectDefaultAngleDamping = damp; }
 
 /** Set how much to bounce when a collision occur
- *  @param {Number} elasticity
+ *  @param {number} elasticity
  *  @memberof Settings */
 function setObjectDefaultElasticity(elasticity) { objectDefaultElasticity = elasticity; }
 
 /** Set how much to slow when touching
- *  @param {Number} friction
+ *  @param {number} friction
  *  @memberof Settings */
 function setObjectDefaultFriction(friction) { objectDefaultFriction = friction; }
 
 /** Set max speed to avoid fast objects missing collisions
- *  @param {Number} speed
+ *  @param {number} speed
  *  @memberof Settings */
 function setObjectMaxSpeed(speed) { objectMaxSpeed = speed; }
 
 /** Set how much gravity to apply to objects along the Y axis
- *  @param {Number} newGravity
+ *  @param {number} newGravity
  *  @memberof Settings */
 function setGravity(newGravity) { gravity = newGravity; }
 
 /** Set to scales emit rate of particles
- *  @param {Number} scale
+ *  @param {number} scale
  *  @memberof Settings */
 function setParticleEmitRateScale(scale) { particleEmitRateScale = scale; }
 
 /** Set if gamepads are enabled
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setGamepadsEnable(enable) { gamepadsEnable = enable; }
 
 /** Set if the dpad input is also routed to the left analog stick
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setGamepadDirectionEmulateStick(enable) { gamepadDirectionEmulateStick = enable; }
 
 /** Set if true the WASD keys are also routed to the direction keys
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setInputWASDEmulateDirection(enable) { inputWASDEmulateDirection = enable; }
 
 /** Set if touch input is allowed
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setTouchInputEnable(enable) { touchInputEnable = enable; }
 
 /** Set if touch gamepad should appear on mobile devices
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setTouchGamepadEnable(enable) { touchGamepadEnable = enable; }
 
 /** Set if touch gamepad should be analog stick or 8 way dpad
- *  @param {Boolean} analog
+ *  @param {boolean} analog
  *  @memberof Settings */
 function setTouchGamepadAnalog(analog) { touchGamepadAnalog = analog; }
 
 /** Set size of virtual gamepad for touch devices in pixels
- *  @param {Number} size
+ *  @param {number} size
  *  @memberof Settings */
 function setTouchGamepadSize(size) { touchGamepadSize = size; }
 
 /** Set transparency of touch gamepad overlay
- *  @param {Number} alpha
+ *  @param {number} alpha
  *  @memberof Settings */
 function setTouchGamepadAlpha(alpha) { touchGamepadAlpha = alpha; }
 
 /** Set to allow vibration hardware if it exists
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setVibrateEnable(enable) { vibrateEnable = enable; }
 
 /** Set to disable all audio code
- *  @param {Boolean} enable
+ *  @param {boolean} enable
  *  @memberof Settings */
 function setSoundEnable(enable) { soundEnable = enable; }
 
 /** Set volume scale to apply to all sound, music and speech
- *  @param {Number} volume
+ *  @param {number} volume
  *  @memberof Settings */
 function setSoundVolume(volume)
 {
@@ -448,22 +448,22 @@ function setSoundVolume(volume)
 }
 
 /** Set default range where sound no longer plays
- *  @param {Number} range
+ *  @param {number} range
  *  @memberof Settings */
 function setSoundDefaultRange(range) { soundDefaultRange = range; }
 
 /** Set default range percent to start tapering off sound
- *  @param {Number} taper
+ *  @param {number} taper
  *  @memberof Settings */
 function setSoundDefaultTaper(taper) { soundDefaultTaper = taper; }
 
 /** Set how long to show medals for in seconds
- *  @param {Number} time
+ *  @param {number} time
  *  @memberof Settings */
 function setMedalDisplayTime(time) { medalDisplayTime = time; }
 
 /** Set how quickly to slide on/off medals in seconds
- *  @param {Number} time
+ *  @param {number} time
  *  @memberof Settings */
 function setMedalDisplaySlideTime(time) { medalDisplaySlideTime = time; }
 
@@ -472,22 +472,17 @@ function setMedalDisplaySlideTime(time) { medalDisplaySlideTime = time; }
  *  @memberof Settings */
 function setMedalDisplaySize(size) { medalDisplaySize = size; }
 
-/** Set size of icon in medal display
- *  @param {Number} size
- *  @memberof Settings */
-function setMedalDisplayIconSize(size) { medalDisplayIconSize = size; }
-
 /** Set to stop medals from being unlockable
- *  @param {Boolean} preventUnlock
+ *  @param {boolean} preventUnlock
  *  @memberof Settings */
 function setMedalsPreventUnlock(preventUnlock) { medalsPreventUnlock = preventUnlock; }
 
 /** Set if watermark with FPS should be shown
- *  @param {Boolean} show
+ *  @param {boolean} show
  *  @memberof Debug */
 function setShowWatermark(show) { showWatermark = show; }
 
 /** Set key code used to toggle debug mode, Esc by default
- *  @param {String} key
+ *  @param {string} key
  *  @memberof Debug */
 function setDebugKey(key) { debugKey = key; }

package/src/engineTileLayer.js

@@ -13,7 +13,7 @@
 'use strict';
 
 /** The tile collision layer grid, use setTileCollisionData and getTileCollisionData to access
- *  @type {Array} 
+ *  @type {Array<number>} 
  *  @memberof TileCollision */
 let tileCollision = [];
 
@@ -35,7 +35,7 @@ function initTileCollision(size)
 
 /** Set tile collision data for a given cell in the grid
  *  @param {Vector2} pos
- *  @param {Number}  [data]
+ *  @param {number}  [data]
  *  @memberof TileCollision */
 function setTileCollisionData(pos, data=0)
 {
@@ -44,7 +44,7 @@ function setTileCollisionData(pos, data=0)
 
 /** Get tile collision data for a given cell in the grid
  *  @param {Vector2} pos
- *  @return {Number}
+ *  @return {number}
  *  @memberof TileCollision */
 function getTileCollisionData(pos)
 {
@@ -55,7 +55,7 @@ function getTileCollisionData(pos)
  *  @param {Vector2}      pos
  *  @param {Vector2}      [size=(0,0)]
  *  @param {EngineObject} [object]
- *  @return {Boolean}
+ *  @return {boolean}
  *  @memberof TileCollision */
 function tileCollisionTest(pos, size=vec2(), object)
 {
@@ -136,17 +136,17 @@ function tileCollisionRaycast(posStart, posEnd, object)
 class TileLayerData
 {
     /** Create a tile layer data object, one for each tile in a TileLayer
-     *  @param {Number}  [tile]      - The tile to use, untextured if undefined
-     *  @param {Number}  [direction] - Integer direction of tile, in 90 degree increments
-     *  @param {Boolean} [mirror]    - If the tile should be mirrored along the x axis
+     *  @param {number}  [tile]      - The tile to use, untextured if undefined
+     *  @param {number}  [direction] - Integer direction of tile, in 90 degree increments
+     *  @param {boolean} [mirror]    - If the tile should be mirrored along the x axis
      *  @param {Color}   [color]     - Color of the tile */
     constructor(tile, direction=0, mirror=false, color=new Color)
     {
-        /** @property {Number}  - The tile to use, untextured if undefined */
+        /** @property {number}  - The tile to use, untextured if undefined */
         this.tile      = tile;
-        /** @property {Number}  - Integer direction of tile, in 90 degree increments */
+        /** @property {number}  - Integer direction of tile, in 90 degree increments */
         this.direction = direction;
-        /** @property {Boolean} - If the tile should be mirrored along the x axis */
+        /** @property {boolean} - If the tile should be mirrored along the x axis */
         this.mirror    = mirror;
         /** @property {Color}   - Color of the tile */
         this.color     = color;
@@ -175,7 +175,7 @@ class TileLayer extends EngineObject
     *  @param {Vector2}  [size=tileCollisionSize] - World space size
     *  @param {TileInfo} [tileInfo]    - Tile info for layer
     *  @param {Vector2}  [scale=(1,1)] - How much to scale this layer when rendered
-    *  @param {Number}   [renderOrder] - Objects are sorted by renderOrder
+    *  @param {number}   [renderOrder] - Objects are sorted by renderOrder
     */
     constructor(position, size=tileCollisionSize, tileInfo=tile(), scale=vec2(1), renderOrder=0)
     {
@@ -187,7 +187,7 @@ class TileLayer extends EngineObject
         this.context = this.canvas.getContext('2d');
         /** @property {Vector2} - How much to scale this layer when rendered */
         this.scale = scale;
-        /** @property {Boolean} - If true this layer will render to overlay canvas and appear above all objects */
+        /** @property {boolean} - If true this layer will render to overlay canvas and appear above all objects */
         this.isOverlay = false;
 
         // init tile data
@@ -210,7 +210,7 @@ class TileLayer extends EngineObject
     /** Set data at a given position in the array 
      *  @param {Vector2}       layerPos - Local position in array
      *  @param {TileLayerData} data     - Data to set
-     *  @param {Boolean}       [redraw] - Force the tile to redraw if true */
+     *  @param {boolean}       [redraw] - Force the tile to redraw if true */
     setData(layerPos, data, redraw=false)
     {
         if (layerPos.arrayCheck(this.size))
@@ -263,7 +263,7 @@ class TileLayer extends EngineObject
 
     /** Call to start the redraw process
      *  - This can be used to manually update small parts of the level
-     *  @param {Boolean} [clear] - Should it clear the canvas before drawing */
+     *  @param {boolean} [clear] - Should it clear the canvas before drawing */
     redrawStart(clear=false)
     {
         // save current render settings
@@ -307,7 +307,7 @@ class TileLayer extends EngineObject
      *  This can be used to clear out tiles when they are destroyed
      *  Tiles can also be redrawn if inside a redrawStart/End block
      *  @param {Vector2} layerPos 
-     *  @param {Boolean} [clear] - should the old tile be cleared out
+     *  @param {boolean} [clear] - should the old tile be cleared out
      */
     drawTileData(layerPos, clear=true)
     {
@@ -325,7 +325,7 @@ class TileLayer extends EngineObject
         {
             ASSERT(mainContext == this.context, 'must call redrawStart() before drawing tiles');
             const pos = layerPos.add(vec2(.5));
-            const tileInfo = tile(d.tile, s, this.tileInfo.textureIndex);
+            const tileInfo = tile(d.tile, s, this.tileInfo.textureIndex, this.tileInfo.padding);
             drawTile(pos, vec2(1), tileInfo, d.color, d.direction*PI/2, d.mirror);
         }
     }
@@ -333,8 +333,8 @@ class TileLayer extends EngineObject
     /** Draw directly to the 2D canvas in world space (bypass webgl)
      *  @param {Vector2}  pos
      *  @param {Vector2}  size
-     *  @param {Number}   angle
-     *  @param {Boolean}  mirror
+     *  @param {number}   angle
+     *  @param {boolean}  mirror
      *  @param {Function} drawFunction */
     drawCanvas2D(pos, size, angle, mirror, drawFunction)
     {
@@ -354,8 +354,8 @@ class TileLayer extends EngineObject
      *  @param {Vector2}  [size=(1,1)]
      *  @param {TileInfo} [tileInfo]
      *  @param {Color}    [color=(1,1,1,1)]
-     *  @param {Number}   [angle=0]
-     *  @param {Boolean}  [mirror=0] */
+     *  @param {number}   [angle=0]
+     *  @param {boolean}  [mirror=0] */
     drawTile(pos, size=vec2(1), tileInfo, color=new Color, angle, mirror)
     {
         this.drawCanvas2D(pos, size, angle, mirror, (context)=>
@@ -382,7 +382,7 @@ class TileLayer extends EngineObject
      *  @param {Vector2} pos
      *  @param {Vector2} [size=(1,1)]
      *  @param {Color}   [color=(1,1,1,1)]
-     *  @param {Number}  [angle=0] */
+     *  @param {number}  [angle=0] */
     drawRect(pos, size, color, angle) 
     { this.drawTile(pos, size, undefined, color, angle); }
 }