littlejsengine 1.11.8 → 1.11.10

package/src/engineParticles.js

@@ -46,11 +46,11 @@ class ParticleEmitter extends EngineObject
      *  @param {Number} [particleConeAngle] - Cone for start particle angle
      *  @param {Number} [fadeRate]          - How quick to fade particles at start/end in percent of life
      *  @param {Number} [randomness]    - Apply extra randomness percent
-     *  @param {Boolean} [collideTiles] - Do particles collide against tiles
-     *  @param {Boolean} [additive]     - Should particles use additive blend
-     *  @param {Boolean} [randomColorLinear] - Should color be randomized linearly or across each component
+     *  @param {boolean} [collideTiles] - Do particles collide against tiles
+     *  @param {boolean} [additive]     - Should particles use additive blend
+     *  @param {boolean} [randomColorLinear] - Should color be randomized linearly or across each component
      *  @param {Number} [renderOrder] - Render order for particles (additive is above other stuff by default)
-     *  @param {Boolean}  [localSpace] - Should it be in local space of emitter (world space is default)
+     *  @param {boolean}  [localSpace] - Should it be in local space of emitter (world space is default)
      */
     constructor
     ( 
@@ -104,7 +104,7 @@ class ParticleEmitter extends EngineObject
         this.colorEndA   = colorEndA;
         /** @property {Color} - Color at end of life 2, randomized between end colors */
         this.colorEndB   = colorEndB;
-        /** @property {Boolean} - Should color be randomized linearly or across each component */
+        /** @property {boolean} - Should color be randomized linearly or across each component */
         this.randomColorLinear = randomColorLinear;
 
         // particle settings
@@ -130,11 +130,11 @@ class ParticleEmitter extends EngineObject
         this.fadeRate          = fadeRate;
         /** @property {Number} - Apply extra randomness percent */
         this.randomness        = randomness;
-        /** @property {Boolean} - Do particles collide against tiles */
+        /** @property {boolean} - Do particles collide against tiles */
         this.collideTiles      = collideTiles;
-        /** @property {Boolean} - Should particles use additive blend */
+        /** @property {boolean} - Should particles use additive blend */
         this.additive          = additive;
-        /** @property {Boolean} - Should it be in local space of emitter */
+        /** @property {boolean} - Should it be in local space of emitter */
         this.localSpace        = localSpace;
         /** @property {Number} - If non zero the particle is drawn as a trail, stretched in the direction of velocity */
         this.trailScale        = 0;
@@ -244,7 +244,7 @@ class Particle extends EngineObject
      * @param {Number}   sizeStart  - Size at start of life
      * @param {Number}   sizeEnd    - Size at end of life
      * @param {Number}   fadeRate   - How quick to fade in/out
-     * @param {Boolean}  additive   - Does it use additive blend mode
+     * @param {boolean}  additive   - Does it use additive blend mode
      * @param {Number}   trailScale - If a trail, how long to make it
      * @param {ParticleEmitter} [localSpaceEmitter] - Parent emitter if local space
      * @param {Function} [destroyCallback] - Callback when particle dies
@@ -266,7 +266,7 @@ class Particle extends EngineObject
         this.sizeEndDelta = sizeEnd - sizeStart;
         /** @property {Number} - How quick to fade in/out */
         this.fadeRate = fadeRate;
-        /** @property {Boolean} - Is it additive */
+        /** @property {boolean} - Is it additive */
         this.additive = additive;
         /** @property {Number} - If a trail, how long to make it */
         this.trailScale = trailScale;

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,33 @@ 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}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let headlessMode = false;
@@ -71,13 +73,13 @@ let headlessMode = false;
 // WebGL settings
 
 /** Enable webgl rendering, webgl can be disabled and removed from build (with some features disabled)
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let glEnable = true;
 
 /** Fixes slow rendering in some browsers by not compositing the WebGL canvas
- *  @type {Boolean}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let glOverlay = true;
@@ -92,7 +94,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 +103,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,26 +160,26 @@ 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}
+ *  @type {boolean}
  *  @default
  *  @memberof Settings */
 let touchInputEnable = true;
@@ -185,31 +187,31 @@ 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}
+ *  @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 +220,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 +247,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;
@@ -263,13 +265,13 @@ let medalDisplaySlideTime = .5;
 let medalDisplaySize = vec2(640, 80);
 
 /** Size of icon in medal display
- *  @type {Number}
+ *  @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 +285,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 +300,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 +340,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 +450,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; }
 
@@ -473,21 +475,21 @@ function setMedalDisplaySlideTime(time) { medalDisplaySlideTime = time; }
 function setMedalDisplaySize(size) { medalDisplaySize = size; }
 
 /** Set size of icon in medal display
- *  @param {Number} size
+ *  @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; }