Kaboom.js changelog

Changelog History

Page 1

• v3000.0.0 Changes

  Game Objects

  • ➕ added scene graph, game objects are now stored in a tree-like structure and can have children with obj.add()

  const bean = add([
      sprite("bean"),
      pos(160, 120),
  ])
  
  const sword = bean.add([
      sprite("sword"),
      // transforms will be relative to parent bean object
      pos(20, 20),
      rotate(20),
  ])
  
  const hat = bean.add([
      sprite("hat"),
      // transforms will be relative to parent bean object
      pos(0, -10),
  ])
  
  // children will be moved alongside the parent
  bean.moveBy(100, 200)
  
  // children will be destroyed alongside the parent
  bean.destroy()
  

  • ➕ added GameObj#getAll() for recursively getting children game objects (get() only gets from direct children)
  • ⚡️ changed object update order from reversed to not reversed
  • (BREAK) removed GameObj#every() and GameObj#revery() in favor of obj.get().forEach()
  • (BREAK) renamed GameObj#_id to GameObj#id
  • (BREAK) addLevel() now returns a GameObj which has all individual grid objects as its children game objects, with LevelComp containing its previous methods

  Components

  • ➕ added collision support for rotate shapes and polygons
  • ➕ added Area#onCollideUpdate() and Area#onCollideEnd() events
  • ➕ added Area#onHover() and onHover() to register an event that runs once when an object(s) is hovered
  • ➕ added Area#onHoverEnd() and onHoverEnd() to register an event that runs once when an object(s) stopped being hovered
  • (BREAK) renamed onHover() to onHoverUpdate() (it registers an event that runs every frame when an object is hovered)
  • ➕ added Body#onFall() which fires when object starts falling
  • ➕ added Body#onPhysicsResolve() and Body#onBeforePhysicsResolve() to register events relating to collision resolution
  • ➕ added body({ stickToPlatform: false }) option to turn off object moving with platform
  • ➕ added doubleJump() component to enable double jump
  • (BREAK) removed Body#doubleJump() in favor of doubleJump() component
  • (BREAK) renamed Body#weight to Body#gravityScale
  • (BREAK) renamed Body#onFall() to Body#onFallOff() which triggers when object fall off a platform
  • (BREAK) removed solid() in favor of body({ isStatic: true })
  • (BREAK) defining gravity() is now required for enabling gravity, body() by default will only prevent objects from going through each other
  • (BREAK) renamed origin() to anchor(), so it won't mess up typescript in global context
  • (BREAK) anchor (previously origin) no longer controls text alignment, use align option instead
  • (BREAK) changed outview() to offscreen(), and uses a much more performant check for if object is offscreen
    • removed offset option in favor of a simpler distance option
    • renamed onExitView() and onEnterView() to onExitScreen() and onEnterScreen()
  • (BREAK) removed cleanup() component in favor of offscreen({ destroy: true })
  • ➕ added OpacityComp#fadeOut()
  • ➕ added fadeIn() component
  • stay() now accepts a list of scenes to stay for, like stay(["gameover", "menu"])

  🍱 Assets

  • ➕ added loadProgress() that returns a 0.0 - 1.0 that indicates current asset loading progress
  • ➕ added onLoadUpdate() to register a custom loading screen (see "loader" example)

  Font

  • ➕ added loadFont() to load .ttf, .otf, .woff2 or any font supported by browser FontFace
  • (BREAK) renamed previous loadFont() to loadBitmapFont()
  • (BREAK) removed built-in apl386, apl386o, sink, sinko (still available under examples/fonts)
  • ➕ added default font happy
  • 🔄 changed default font size to 36

  Drawing

  • 🛠 fixed visual artifacts on text rendering
  • ➕ added colors option to drawPolygon() that controls the color of each corner
  • ➕ added gradient option to drawRect() that specifies the start and end color
  • ➕ added option loadingScreen to kaboom() where you can turn off the default loading screen
  • ➕ added drawMasked() and drawSubtracted()
  • ➕ added pushRotateX(), pushRotateY() and pushRotateZ()
  • ➕ added pixelDensity option to kaboom()
  • 🔊 shader error logs now yields the correct line number

  Input

  • ➕ added virtual controls for mobile, enabled with virtualControls: true in kaboom()
  • ➕ added isVirtualButtonPressed(), isVirtualButtonDown(), isVirtualButtonReleased()
  • ➕ added onVirtualButtonPress(), onVirtualButtonDown(), onVirtualButtonRelease()
  • 🛠 fixed touches not treated as mouse
  • (BREAK) changed onTouchStart(), onTouchMove() and onTouchEnd() callback signature to (pos: Vec2, touch: Touch) => void (exposes the native Touch object)

  Misc

  • (BREAK) removed all deprecated functions in v2000.2
  • (BREAK) raised esbuild target to esnext
  • 🚚 moved type defs for global functions to import "kaboom/global"

  // if use global functions
  import "kaboom"
  import "kaboom/global" // required to load global types
  
  kaboom()
  
  // will have definition
  add()
  
  
  // if don't use global function
  import "kaboom"
  
  kaboom({ global: false })
  
  // type error, won't pollute global namespace if not manually import "kaboom/global"
  add()
  

  • ➕ added tween() for tweening, and a set of built-in easing functions in easings

  onMousePress(() => {
      tween(bean.pos.x, mousePos().x, 1, (val) => bean.pos.x = val, easings.easeOutBounce)
      tween(bean.pos.y, mousePos().y, 1, (val) => bean.pos.y = val, easings.easeOutBounce)
  })
  

  • (BREAK) changed all event handlers to return a EventController object instead of a function to cancel event
  • ➕ added Event and EventHandler

  // previous
  const cancel = onUpdate(() => { /* ... */ })
  cancel()
  
  // now, can do more stuff
  const ev = onUpdate(() => { /* ... */ })
  ev.paused = true
  ev.cancel()
  

  • timers can now be paused

  const timer = wait(4, () => { /* ... */ })
  timer.paused = true
  timer.resume()
  
  const timer = loop(1, () => { /* ... */ })
  timer.paused = true
  timer.resume()
  

  • kaboom() now automatically focuses the canvas
  • ➕ added quit() to end everything
  • ➕ added download(), downloadText(), downloadJSON(), downloadBlob()
  • ➕ added Recording#stop() to stop the recording and returns the video data as mp4 Blob
  • ➕ added debug.numFrames() to get the total number of frames elapsed
  • ➕ added onError() to handle error or even custom error screen
  • ➕ added onResize() to register an event that runs when canvas resizes
  • (BREAK) renamed cursor() to setCursor()
  • (BREAK) renamed fullscreen() to setFullscreen()
  • (BREAK) renamed isTouch() to isTouchScreen()
  • (BREAK) removed layers() in favor of parent game objects (see "layers" example)
  • (BREAK) removed load() event for components, use onLoad() in add() event
  • (BREAK) removed debug.objCount() in favor of getAll().length
  • ➕ added debug.numFrames() to get the current frame count

• v2001.0.0 Changes

  • brought back loadMark()
  • (BREAK) removed all deprecated functions in v2000.2
  • game objects can have children with obj.add() now which share the parent transform
  • (BREAK) raised esbuild target to esnext
  • ➕ added make() to make a game object without adding to the scene
  • ➕ added support for add() to add unattached game objects to the scene add(make([...comps]))
  • ➕ added colors option to drawPolygon() that controls the color of each corner
  • ➕ added gradient option to drawRect() that specifies the start and end color
  • ➕ added loadProgress() that returns a 0.0 - 1.0 that indicates current asset loading progress
  • ➕ added kaboom() option loadingScreen where you can turn off the default loading screen
  • ➕ added drawMasked() and drawSubtracted()
  • (BREAK) removed layers() in favor of parent game objects (see "layers" demo)
  • ➕ added pushRotateX(), pushRotateY() and pushRotateZ()
  • ➕ added pixelDensity option to kaboom()
  • ➕ added support for non bitmap fonts
  • (BREAK) rename loadFont() to loadBitmapFont()
  • ➕ added loadFont() to load .ttf, .otf, .woff2 or any font supported by browser FontFace
  • (BREAK) origin no longer controls text alignment, use align option instead
  • ➕ added quit() to end everything
  • 🔊 shader error logs now yields the correct line number
  • ⚡️ changed object update order from reversed to not reversed
  • ➕ added download(), downloadText(), downloadJSON(), downloadBlob()
  • ➕ added Recording#stop() to stop the recording and returns the video data as mp4 Blob
  • ➕ added debug.numFrames() to get the total number of frames elapsed
  • 🛠 fixed visual artifacts on text
  • ➕ added onError() to handle error or even custom error screen
  • ➕ added onLoading() to register a custom loading screen (see "loader" example)
  • 🛠 fixed touches not treated as mouse
  • (BREAK) changed onTouchStart(), onTouchMove() and onTouchEnd() callback signature to (pos: Vec2, touch: Touch) => void (exposes the native Touch object)
  • ➕ added onResize() to register an event that runs when canvas resizes
  • (BREAK) GameObj#_id has been renamed to GameObj#id
  • (BREAK) removed load() event for components, use onLoad() in add() event
  • (BREAK) renamed Body#onFall() to Body#onFallOff() which triggers when object fall off a platform, added Body#onFall() which fires when object starts falling
  • (BREAK) addLevel() now returns a GameObj which has all individual grid objects as its children game objects, with LevelComp containing its previous methods
  • (BREAK) defining gravity() is now required for enabling gravity, body() by default will only prevent objects from going through each other, removed solid() in favor of body({ isStatic: true })
  • (BREAK) renamed Body#weight to Body#gravityScale
  • (BREAK) removed GameObj#every() and GameObj#revery() in favor of obj.get().forEach()
  • ➕ added GameObj#getAll() for recursively getting children game objects (get() only gets from direct children)
  • ➕ added Area#onCollisionActive() and Area#onCollisionEnd() events
  • ✂ removed debug.objCount() in favor of getAll().length
  • ➕ added debug.numFrames() to get the current frame count
  • (BREAK) renamed cursor() to setCursor()
  • (BREAK) renamed fullscreen() to setFullscreen()
  • 🚚 moved type defs for global functions to import "kaboom/global"
  • (BREAK) removed apl386 and apl386o as default fonts, default font changed to sink,, and added a default font size of 16

• v2000.2.6 Changes

  • 🛠 fixed text always being wrapped if updated
  • 🛠 fixed text comp properties letterSpacing, charSpacing, transform, styles not being exposed

• v2000.2.5 Changes

  • 🛠 fixed updating font property on gameobj not updating the text font

• v2000.2.4 Changes

  • 🛠 fixed focus() not properly exported
  • 🗄 deprecated focus() in favor of canvas.focus() due to name collision

• v2000.2.3 Changes

  • 🛠 fixed kaboom.d.ts completely messed up

• v2000.2.2 Changes

  • 🛠 fixed doc for TextCompOpt#styles and DrawTextOpt#styles

• v2000.2.1 Changes

  • 🛠 fixed updates not running at all when kaboom({ debug: false })

• v2000.2.0 Changes

  • ➕ added formatText() and drawFormattedText()
  • ➕ added charSpacing and lineSpacing in TextCompOpt and DrawTextOpt
  • ➕ added optional transitions argument in state() to define allowed transitions
  • ➕ added StateComp#onStateTransition to register event for specific transitions
  • ➕ added syntax to style a piece of text "this is a [styled].wavy text" and style option in TextCompOpt and DrawTextOpt to define the styles with CharTransformFunc
  • 🗄 deprecated dir() in favor of Vec2.fromAngle()
  • 🛠 fixed onTouchEnd() fired on touchmove
  • ➕ added outview() component to control behavior when object leaves visible area
  • 🗄 deprecated cleanup(delay?: number) in favor of cleanup(opt?: CleanupOpt)
  • 🗄 deprecated mouseWorldPos() in favor of toWorld(mousePos())
  • 🗄 deprecated rng() in favor of new RNG()
  • ➕ added classes Vec2, Color, Mat4, Timer, Quad, RNG, Line, Rect, Circle
  • ➕ added deprecation warning
  • 🛠 fixed letterbox view mode
  • 👍 allow non-stretch letterbox
  • 🛠 fixed mouse position malfunction in fullscreen, stretch and letterbox mode

• v2000.1.8 Changes

  • 🛠 fixed Color#eq() not giving correct result

• 1
• 2
• 3
• Next ›
• Last »