v2.2.1: Phaser compatibility fixes

Changelog

Fixed

• Fixed compatibility with newer versions of Phaser.
  The plugin now has a peer dependency on Phaser 3.60 or newer, but will likely still work with older versions

All commits

• Explicitly import phaser but exclude from bundle fe8b263
• Update dependencies and fix build e5d2f0e
• Update phaser and fix errors ed487b7
• Merge pull request #39 from 16patsle/dependabot/npm_and_yarn/json5-2.2.3 a2af262
• Bump json5 from 2.2.0 to 2.2.3 a306045
• Merge pull request #38 from 16patsle/dependabot/npm_and_yarn/ecstatic-and-http-server--removed 0ac8378
• Merge pull request #37 from 16patsle/dependabot/npm_and_yarn/marked-4.2.2 714a542
• Bump marked from 3.0.7 to 4.2.2 a6f671c
• Bump ecstatic and http-server b6d0a3b
• Merge pull request #36 from 16patsle/dependabot/npm_and_yarn/markdown-it-and-markdownlint-cli2-13.0.1 5fb3966
• Bump markdown-it and markdownlint-cli2 ba286f0
• Merge pull request #35 from 16patsle/dependabot/npm_and_yarn/minimatch-3.1.2 eed33f6
• Bump minimatch from 3.0.4 to 3.1.2 ae964a4
• Merge pull request #34 from 16patsle/dependabot/npm_and_yarn/loader-utils-1.4.2 7567dec
• Bump loader-utils from 1.4.0 to 1.4.2 f7bb617
• Merge pull request #33 from 16patsle/dependabot/npm_and_yarn/terser-5.14.2 029772e
• Bump terser from 5.9.0 to 5.14.2 d4e45b3
• Merge pull request #32 from 16patsle/dependabot/npm_and_yarn/async-2.6.4 9190d82
• Merge pull request #31 from 16patsle/dependabot/npm_and_yarn/minimist-1.2.6 49d9a05
• Bump async from 2.6.3 to 2.6.4 728f7c0
• Bump minimist from 1.2.5 to 1.2.6 b86624a
• Merge pull request #29 from 16patsle/dependabot/npm_and_yarn/follow-redirects-1.14.8 0ca3648
• Bump follow-redirects from 1.13.1 to 1.14.8 b8e5844
• Revert "Disable postbuild since it doesn't work on Windows" 7aa0de9
• Update generated docs 12fc71a

v2.2.0...v2.2.1

v2.2.0: A bit of updating and documentation improvements

Changelog

Changed

• Remove bulletID from the Bullet class. While technically a minor breaking change,
  this property did not serve a purpose and would not have been used by anyone.
• Add named exports to modules. The default exports are still there, with the exception of validateConfig.
• Rework how stuff is exported, resulting in cleaner docs.
• Improve documentation descriptions across the board.
• Link Phaser types in the docs directly to the official docs, using a TypeDoc plugin.
• Update existing links to the Phaser docs to point to the new docs.
• Tweak build configuration, resulting in a noticeable reduction in size even in the minified builds.

Fixed

• Fixed missing pluginKey parameter possibly causing problems in Phaser 3.54 and later.
• Change type of Weapon#bulletKilltype to actually be the KillType enum (instead of number).
• Use the declare keyword to narrow type of bullet body.
• Fixed various minor errors in the docs.

All commits

• Format code f7d0376
• Disable postbuild since it doesn't work on Windows c22bd25
• Merge pull request #27 from 16patsle/dependabot/npm_and_yarn/lodash-4.17.21 0927935
• Merge pull request #26 from 16patsle/dependabot/npm_and_yarn/glob-parent-5.1.2 dbfc7f7
• Bump lodash from 4.17.20 to 4.17.21 55881f1
• Bump glob-parent from 5.1.1 to 5.1.2 85e05ec
• Merge pull request #25 from 16patsle/update-and-fix e79e3a2
• Regenerate docs fcf3b47
• Update changelog b5c418e
• Change type of internal _bulletKillType to also be KillType a4dd686
• Ignore typedoc plugin on npm publish e86e401
• Add doc comment tags on event emits 66b70b2
• Regenerate docs 664bfaf
• Set bulletKillType to be of type KillType 7de797e
• Add links and expand descriptions in doc comments eb4a983
• Convert @ default to @ defaultValue d4cd443
• Fix wrong quote and remove TODO e05080d
• Add doc description to Bullet.lifespan ed90f21
• Remove bulletID since it isn't really used 6657c0f
• Improve documentation in Bullet dee32cf
• Improve documentation in WeaponPlugin and Weapon 48bef97
• Use named imports and exports 1fc4a8a
• Optimize and fix babel config ec3f44f
• Format code f8efbbc
• Regenerate docs c6b8c7a
• Export helper objects in Weapon 19b203e
• Fix typo ec27371
• Regenerate docs 0cadfc1
• Remove unnecessary exclude in typedoc config 04f4f1c
• Fix exporting of consts/events + add named exports 50c6fec
• Regenerate docs 36da33f
• Convert old doc URL to the new one 1978957
• Add typedoc plugin for linking to Phaser docs 5afc364
• Remove .nojekyll generation, now added automatically 48d01f5
• Regenerate docs 52909a6
• Fix typedoc entrypoint and revert to default theme 6a2e03e
• Update method of declaring physics body for type for bullets a774b11
• Add pluginKey parameter to WeaponPlugin constructor 0888403
• Fix typedoc entrypoint 2492053
• Update dependencies f1dc535
• Update generated docs 34c556c

v2.1.0...v2.2.0

v2.1.0: Nothing should change

If everything worked fine before, nothing should change. If nothing worked, it hopefully does now.

Changelog

Changed

• Improved instructions in README.
• Added a module entrypoint in package.json, pointing to what was formerly
  the main entrypoint.
• The main entrypoint no longer points to a module, but the normal bundle.
• Updated dependencies, which made the bundle a bit smaller.

Fixed

• The main entrypoint no longer uses ESNext syntax.

All commits

• Run lint as test 4d533ee
• Update .npmignore df79c85
• Update changelog 57ff367
• Rework instructions in readme 1fbce28
• Rework module entrypoints c4b3e05
• Fix eslint errors and warnings d9fda29
• Set webpack target for each config 0cc61dd
• Rename and fix webpack config 7c9afc6
• Regenerate package lock file fcbb5d5
• Fix eslint errors 6302f48
• Regenerate docs cb18440
• Rename eslint config to signify it being commonjs 98e2230
• Upgrade dependencies and update configs 5b8ca55
• Various layout and other fixes in readme and changelog d162c88
• Add markdownlint 16e9596
• Merge pull request #23 from 16patsle/dependabot/npm_and_yarn/highlight.js-9.18.5 82195b2
• Merge pull request #24 from 16patsle/dependabot/npm_and_yarn/ini-1.3.7 0917124
• Bump ini from 1.3.5 to 1.3.7 8713034
• Bump highlight.js from 9.18.1 to 9.18.5 bc51e0e
• Merge pull request #22 from 16patsle/dependabot/npm_and_yarn/http-proxy-1.18.1 98d4ee8
• Bump http-proxy from 1.18.0 to 1.18.1 8e4d8d0
• Merge pull request #21 from 16patsle/dependabot/npm_and_yarn/elliptic-6.5.3 252fbd4
• Bump elliptic from 6.5.2 to 6.5.3 8acfdee
• Merge pull request #20 from 16patsle/dependabot/npm_and_yarn/lodash-4.17.19 449edc7
• Bump lodash from 4.17.15 to 4.17.19 c3f45f9
• Update generated docs 07e72ad

v2.0.1...v2.1.0

v2.0.1: A few fixes

Changelog

Changed

• The package.json now specifies that the package type is "module", for theoretically better future support.
• validateConfig now imports Weapon as a type import, since it only ever uses it as a type
• Moved core-js to devDependencies, as it's only used at build time. Having it as a dependency causes it to be installed by npm when consuming the package, and if you pipe the plugin's source files through babel with useBuiltins enabled, it would resolve core-js separately from your own code, causing it to be bundled twice.

Fixed

• Firing bullets when tracking a sprite with rotation set to 0. Due to an oversight the plugin checked for falsy values to check for the existence of rotation, rather than checking if it was a number.

v2.0.0: Version 2.0 in TypeScript

Read the announcement post for more information

Changelog

Added

• Config checks for trackRotation and bulletInheritSpriteSpeed when following a Sprite without a body or a custom object.
• Added other build targets, including a legacy build transpiled to ES5 and a modern build supporting the last 2 versions of the major browsers.
  The default build targets browsers supporting ES modules, and can be used together with the legacy build if you want to utilize the
  module/nomodule pattern.
• JavaScript source files (compiled from TypeScript) are available in out/ after build. Use these if you prefer to consume the plugin's source
  files directly (through a bundler), but prefer to not set up TypeScript compilation yourself.
• Proper docs generated by TypeDoc.

Changed

• Ported plugin to TypeScript
• Changed exports, the plugin object is now accessible as a named export, or as WeaponPlugin.WeaponPlugin as a browser global.
• The built files now include the necessary polyfills (based on target browsers).
• Constants previously available at consts have been split ut into consts.KillType, consts.Angle and consts.FrameType. They're also available as named exports from consts.js.
• weapon.fire() and similar functions return undefined when no bullet is fired.
• Weapon now extends EventEmitter directly. Event listeners are now added by using weapon.on instead of weapon.eventEmitter.on.
• Events are available as constants from the events export, similar to how Phaser has done it for a while. You can optionally use these when adding event listener, so weapon.on('fire', eventHandler) becomes weapon.on(events.WEAPON_FIRE, eventHandler).

Fixed

• Fixed several bugs and edge cases, helped by TypeScript
• weapon.forEach now properly only passes the bullet and any custom args to the callback function.
• Fixed many minor errors in the documentation comments.

Removed

• Prebuilt files from git. Get them from npm or the releases page, or build them yourself.

v1.0.2: This time including the builds

(Other than including the updated builds, this release is the same as 1.0.1)

• Add updated builds 444cb4e

v1.0.1...v1.0.2

v1.0.1: A bugfix

• Add changelog 1e6e875
• Merge pull request #16 from milk-shake/bugfix/event-emitter-not-a-function 67c63c6
• fix: fix eventEmitter being called instead of eventEmitter.emit 189455e

v1.0.0...v1.0.1

Version 1.0.0, finally!

This plugin is now at v1.0.0, which means it's ready for general use. It supports everything the original Phaser CE plugin did! Therefore the plugin can be considered mostly complete, though any bugs you discover will still be fixed. At some point there will probably be a documentation website up as well, but in the meantime you'll have to make good use of the inline JSDocs and the examples.

Beta 1

This is the first beta. The functionality is working, but there's probably bugs and the API is not final. Please consider testing it out if you like the work we've put into this and would like to help shape the future of this project.

To install:

npm install phaser3-weapon-plugin@beta // if you use npm
yarn add phaser3-weapon-plugin@beta // for yarn users

Then you load the plugin as a scene plugin, see instructions in the readme.