excalibur 0.28.3 → 0.28.4

package/LICENSE.md

@@ -1,25 +1,25 @@
-BSD 2-Clause License
-
-Copyright (c) 2013, Erik Onarheim
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+BSD 2-Clause License
+
+Copyright (c) 2013, Erik Onarheim
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,134 +1,134 @@
-![Logo](/assets/logo.png?raw=true)
-
-[![Appveyor status](https://img.shields.io/appveyor/ci/eonarheim/excalibur/main.svg)](https://ci.appveyor.com/project/eonarheim/excalibur)
-[![Coverage Status](https://coveralls.io/repos/github/excaliburjs/Excalibur/badge.svg?branch=main)](https://coveralls.io/github/excaliburjs/Excalibur?branch=main)
-[![npm version](https://img.shields.io/npm/v/excalibur.svg)](https://www.npmjs.com/package/excalibur)
-[![npm downloads](https://img.shields.io/npm/dt/excalibur.svg)](https://www.npmjs.com/package/excalibur)
-[![NuGet version](https://img.shields.io/nuget/v/Excalibur.svg)](https://www.nuget.org/packages/Excalibur/)
-
-![Sweep Stacks](http://excaliburjs.com/assets/images/homepage-xp.png)
-
-Excalibur is a free game engine written in TypeScript for making 2D games in HTML5 canvas. Our goal is to make it easier for you to create 2D HTML/JS games, whether you're new to game development or you're an experienced game developer. We take care of all of the boilerplate engine code, cross-platform targeting (using [browserstack](http://browserstack.com/) 😎), and more! Use as much or as little as you need!
-
-Excalibur is an open source project licensed under the 2-clause BSD license (this means you can use it in commercial projects!). It's free and always will be. We welcome any feedback or contributions! If you make something with Excalibur, please [let us know](https://github.com/excaliburjs/Excalibur/discussions?discussions_q=category%3A%22Show+and+tell%22)!
-
-# Get Started
-
-Our user documentation is at https://excaliburjs.com/docs (and you can contribute to the docs at https://github.com/excaliburjs/excaliburjs.github.io)
-
-- Follow our [Installation](https://excaliburjs.com/docs/installation) guide to learn how to install Excalibur.
-- Follow our [Getting Started](https://excaliburjs.com/docs/getting-started) guide if you're looking to get started.
-- Learn what [Features](https://excaliburjs.com/docs) are available for you to leverage in your games.
-- View the [1.0 Release roadmap](https://github.com/excaliburjs/Excalibur/issues/1161) to see what's coming next.
-
-:exclamation: **_Note:_** Excalibur is still in version 0.x, which means this project and its associated plugins may be a little rough around the edges. We try to minimize API changes, but breaking changes **will occur** in new released versions. Excalibur is a labor of love and the product of many hours of spare time. Thanks for checking it out!
-
-# API Reference
-
-Visit the [API Reference](https://excaliburjs.com/docs/api/edge) section for fully-annotated documentation of the API.
-
-# Questions
-
-- :question: Ask us anything in the [GitHub Discussions area](https://github.com/excaliburjs/Excalibur/discussions).
-- :bug: If you find a bug, report it on the [GitHub issues page](https://github.com/excaliburjs/Excalibur/issues) (please review our [guidelines for reporting bugs](https://github.com/excaliburjs/Excalibur/blob/main/.github/CONTRIBUTING.md#reporting-bugs)).
-- :mega: You can also follow us on Twitter [@excaliburjs](http://twitter.com/excaliburjs) or [read the blog](http://blog.excaliburjs.com).
-
-# Samples
-
-Compiled examples can be found [in the Excalibur Samples collection](http://excaliburjs.com/samples/).
-
-# Contributing
-
-Please read our [Contributing Guidelines](.github/CONTRIBUTING.md) and our [Code of Conduct](.github/CODE_OF_CONDUCT.md). Whether you've spotted a bug, have a question, or think of a new feature, we thank you for your help!
-
-## Mac
-
-Prerequisites
-* Docker for Mac https://docs.docker.com/desktop/mac/install/
-* In the root, run `docker-compose build` (setup build environment and installs dependencies, only needed once)
-* To run tests in watch mode `docker-compose run --rm dev npm run test:watch`
-* To run a build `docker-compose run --rm dev npm run all`
-
-# Writing Documentation
-
-We love when people help improve our documentation. You can contribute to the docs in [this repository](https://github.com/excaliburjs/excaliburjs.github.io).
-
-## Environment Setup
-
-The Excalibur.js team primarily uses [Visual Studio Code](http://code.visualstudio.com) as a platform agnostic editor to
-allow the widest contributions possible. However, you can always use your own preferred editor.
-
-## Testing
-
-[![Browserstack](/assets/browserstack-logo-150x34.png?raw=true)](http://browserstack.com/)
-
-Excalibur is committed to supporting the latest 2 versions of popular desktop and mobile browsers. We leverage [browserstack](http://browserstack.com/) automated testing to ensure that Excalibur is automatically tested as thoroughly as possible on all our supported platforms.
-
-### Prerequisites
-
-- **Required:** [Node.js](https://nodejs.org/) 14.x & npm 6.x
-- _Recommended:_ [Prettier plugin for VS Code](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
-- _Recommended:_ [ESLint plugin for VS Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
-
-After cloning the repository, run:
-
-```sh
-npm install
-```
-
-You can then run the npm tasks for various purposes:
-
-```bash
-# Run compilation, linting, and all unit & visual tests
-# Recommend to do this before finalizing pull requests
-npm run all
-
-# Run engine core compilation only
-# Useful for quick checks to ensure everything compiles
-npm run build
-
-# Run engine tests only (does not run compile task)
-# Useful to run tests ad-hoc
-npm test
-npm run test
-
-# Start Storybook-based sandbox
-# Used for creating interactive visual tests and examples for docs
-npm run sandbox
-
-# Compile API docs
-npm run apidocs
-
-# Build a nuget package and specify a version
-npm run nuget -- 1.1.1
-```
-
-# License
-
-Excalibur is open source and operates under the 2-clause BSD license:
-
-    BSD 2-Clause License
-
-    Copyright (c) 2014, Erik Onarheim
-    All rights reserved.
-
-    Redistribution and use in source and binary forms, with or without
-    modification, are permitted provided that the following conditions are met:
-
-    * Redistributions of source code must retain the above copyright notice, this
-      list of conditions and the following disclaimer.
-
-    * Redistributions in binary form must reproduce the above copyright notice,
-      this list of conditions and the following disclaimer in the documentation
-      and/or other materials provided with the distribution.
-
-    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+![Logo](/assets/logo.png?raw=true)
+
+[![Appveyor status](https://img.shields.io/appveyor/ci/eonarheim/excalibur/main.svg)](https://ci.appveyor.com/project/eonarheim/excalibur)
+[![Coverage Status](https://coveralls.io/repos/github/excaliburjs/Excalibur/badge.svg?branch=main)](https://coveralls.io/github/excaliburjs/Excalibur?branch=main)
+[![npm version](https://img.shields.io/npm/v/excalibur.svg)](https://www.npmjs.com/package/excalibur)
+[![npm downloads](https://img.shields.io/npm/dt/excalibur.svg)](https://www.npmjs.com/package/excalibur)
+[![NuGet version](https://img.shields.io/nuget/v/Excalibur.svg)](https://www.nuget.org/packages/Excalibur/)
+
+![Sweep Stacks](http://excaliburjs.com/assets/images/homepage-xp.png)
+
+Excalibur is a free game engine written in TypeScript for making 2D games in HTML5 canvas. Our goal is to make it easier for you to create 2D HTML/JS games, whether you're new to game development or you're an experienced game developer. We take care of all of the boilerplate engine code, cross-platform targeting (using [browserstack](http://browserstack.com/) 😎), and more! Use as much or as little as you need!
+
+Excalibur is an open source project licensed under the 2-clause BSD license (this means you can use it in commercial projects!). It's free and always will be. We welcome any feedback or contributions! If you make something with Excalibur, please [let us know](https://github.com/excaliburjs/Excalibur/discussions?discussions_q=category%3A%22Show+and+tell%22)!
+
+# Get Started
+
+Our user documentation is at https://excaliburjs.com/docs (and you can contribute to the docs at https://github.com/excaliburjs/excaliburjs.github.io)
+
+- Follow our [Installation](https://excaliburjs.com/docs/installation) guide to learn how to install Excalibur.
+- Follow our [Getting Started](https://excaliburjs.com/docs/getting-started) guide if you're looking to get started.
+- Learn what [Features](https://excaliburjs.com/docs) are available for you to leverage in your games.
+- View the [1.0 Release roadmap](https://github.com/excaliburjs/Excalibur/issues/1161) to see what's coming next.
+
+:exclamation: **_Note:_** Excalibur is still in version 0.x, which means this project and its associated plugins may be a little rough around the edges. We try to minimize API changes, but breaking changes **will occur** in new released versions. Excalibur is a labor of love and the product of many hours of spare time. Thanks for checking it out!
+
+# API Reference
+
+Visit the [API Reference](https://excaliburjs.com/docs/api/edge) section for fully-annotated documentation of the API.
+
+# Questions
+
+- :question: Ask us anything in the [GitHub Discussions area](https://github.com/excaliburjs/Excalibur/discussions).
+- :bug: If you find a bug, report it on the [GitHub issues page](https://github.com/excaliburjs/Excalibur/issues) (please review our [guidelines for reporting bugs](https://github.com/excaliburjs/Excalibur/blob/main/.github/CONTRIBUTING.md#reporting-bugs)).
+- :mega: You can also follow us on Twitter [@excaliburjs](http://twitter.com/excaliburjs) or [read the blog](http://blog.excaliburjs.com).
+
+# Samples
+
+Compiled examples can be found [in the Excalibur Samples collection](http://excaliburjs.com/samples/).
+
+# Contributing
+
+Please read our [Contributing Guidelines](.github/CONTRIBUTING.md) and our [Code of Conduct](.github/CODE_OF_CONDUCT.md). Whether you've spotted a bug, have a question, or think of a new feature, we thank you for your help!
+
+## Mac
+
+Prerequisites
+* Docker for Mac https://docs.docker.com/desktop/mac/install/
+* In the root, run `docker-compose build` (setup build environment and installs dependencies, only needed once)
+* To run tests in watch mode `docker-compose run --rm dev npm run test:watch`
+* To run a build `docker-compose run --rm dev npm run all`
+
+# Writing Documentation
+
+We love when people help improve our documentation. You can contribute to the docs in [this repository](https://github.com/excaliburjs/excaliburjs.github.io).
+
+## Environment Setup
+
+The Excalibur.js team primarily uses [Visual Studio Code](http://code.visualstudio.com) as a platform agnostic editor to
+allow the widest contributions possible. However, you can always use your own preferred editor.
+
+## Testing
+
+[![Browserstack](/assets/browserstack-logo-150x34.png?raw=true)](http://browserstack.com/)
+
+Excalibur is committed to supporting the latest 2 versions of popular desktop and mobile browsers. We leverage [browserstack](http://browserstack.com/) automated testing to ensure that Excalibur is automatically tested as thoroughly as possible on all our supported platforms.
+
+### Prerequisites
+
+- **Required:** [Node.js](https://nodejs.org/) 14.x & npm 6.x
+- _Recommended:_ [Prettier plugin for VS Code](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+- _Recommended:_ [ESLint plugin for VS Code](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+After cloning the repository, run:
+
+```sh
+npm install
+```
+
+You can then run the npm tasks for various purposes:
+
+```bash
+# Run compilation, linting, and all unit & visual tests
+# Recommend to do this before finalizing pull requests
+npm run all
+
+# Run engine core compilation only
+# Useful for quick checks to ensure everything compiles
+npm run build
+
+# Run engine tests only (does not run compile task)
+# Useful to run tests ad-hoc
+npm test
+npm run test
+
+# Start Storybook-based sandbox
+# Used for creating interactive visual tests and examples for docs
+npm run sandbox
+
+# Compile API docs
+npm run apidocs
+
+# Build a nuget package and specify a version
+npm run nuget -- 1.1.1
+```
+
+# License
+
+Excalibur is open source and operates under the 2-clause BSD license:
+
+    BSD 2-Clause License
+
+    Copyright (c) 2014, Erik Onarheim
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this
+      list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/STYLEGUIDE.md

@@ -1,136 +1,136 @@
-# Excalibur Style Guide
-
-## General Code:
-
-#### DO
-
-- Prefer readable code over shorter code
-- Prefer code locality over dynamism, code that is related should be near each other
-- Use modern ES features like `const` or `let`
-- Write tests for all new code
-- Provide JSDoc comments on all methods
-
-#### CONSIDER
-
-- Keeping methods short < 100 lines
-- Using the SOLID principles where possible ([the course by Mark Seemann is good](https://www.pluralsight.com/courses/encapsulation-solid))
-  - **S**ingle Responsibility Principle
-  - **O**pen-closed Principle
-  - **L**iskov substitution principle
-  - **I**nterface segregation principle
-  - **D**ependency inversion principle
-
-#### AVOID
-
-- Using `function()`
-
-#### DON’T
-
-- Use the `var` keyword
-
-## Classes:
-
-#### DO
-
-- Only name things with “Base” if they are an abstract class, or cannot be instantiated normally
-
-#### CONSIDER
-
--
-
-#### AVOID
-
-- Using inheritance, prefer composition when building up types
-- Using the singleton pattern, consider factory or an adapter pattern
-
-#### DON’T
-
-- Name things with a “Base” if they can be instantiated normally
-
-## Methods:
-
-#### DO
-
-- Have descriptive and verbose parameter names, especially for similar looking methods
-- Use JavaScript getters/setters for things that feel like properties, but have logic behind them
-- Use getters for things that should be strict `readonly` properties
-- Use properties for quantities that have no logic behind them
-- Use methods for commands, performing an action, or making queries
-- Prefer verbs like `show()` or `hide()` for booleans instead of properties like `.isVisible = true`
-  - Example: `isDebug` should be `enableDebug()`/`disableDebug()` or `toggleDebug() // returns current mode`
-
-#### CONSIDER
-
-- Consider `get` or `set` when needing to return non-trivial types or perform non-trivial calculation, for example `getConfiguration()`
-- Shorter descriptive names over longer names
-- Prefer less words over more where appropriate
-- Use option bags for parameters with interface typings, for example
-
-```typescript
-export interface EngineOptions { … }
-class Engine {
-    constructor(options?: EngineOptions) {
-       ...
-    }
-    ...
-}
-```
-
-#### AVOID
-
-- The words `get` or `set` for primitive types like `number` or `string`
-  Abbreviations for parameter names
-
-#### DON’T
-
-- Make parameter lists larger than 3 required parameters `someMethod(parm1, param2, param3, param4)`, use an option bag.
-
-## Interfaces:
-
-#### DO
-
-- Name with a verb suffix “-able” or "-like", for example `Updatable` or `Drawable` except in the case of option bag parameters
-
-#### CONSIDER
-
-- Keep interfaces short and simple, if they get too large can they be broken into **multiple** interfaces. See the **Interface Segregation Principle**
-
-### DON’T
-
-- Use an “I” prefix, do not use things like `IDrawable` should be `Drawable`
-
-## Enums
-
-#### DO
-
-- Use `number`ed or `string` enums, preferring `string` enums for more robust type support, robust refactorings, and debuggability at run-time
-
-```typescript
-export enum CollisionType {
-  /**
-   * Actors with the `PreventCollision` setting do not participate in any
-   * collisions and do not raise collision events.
-   */
-  PreventCollision = 'PreventCollision',
-  /**
-   * Actors with the `Passive` setting only raise collision events, but are not
-   * influenced or moved by other actors and do not influence or move other actors.
-   */
-  Passive = 'Passive',
-  /**
-   * Actors with the `Active` setting raise collision events and participate
-   * in collisions with other actors and will be push or moved by actors sharing
-   * the `Active` or `Fixed` setting.
-   */
-  Active = 'Active',
-  /**
-   * Actors with the `Fixed` setting raise collision events and participate in
-   * collisions with other actors. Actors with the `Fixed` setting will not be
-   * pushed or moved by other actors sharing the `Fixed`. Think of Fixed
-   * actors as "immovable/unstoppable" objects. If two `Fixed` actors meet they will
-   * not be pushed or moved by each other, they will not interact except to throw
-   * collision events.
-   */
-  Fixed = 'Fixed'
-}
-```
+# Excalibur Style Guide
+
+## General Code:
+
+#### DO
+
+- Prefer readable code over shorter code
+- Prefer code locality over dynamism, code that is related should be near each other
+- Use modern ES features like `const` or `let`
+- Write tests for all new code
+- Provide JSDoc comments on all methods
+
+#### CONSIDER
+
+- Keeping methods short < 100 lines
+- Using the SOLID principles where possible ([the course by Mark Seemann is good](https://www.pluralsight.com/courses/encapsulation-solid))
+  - **S**ingle Responsibility Principle
+  - **O**pen-closed Principle
+  - **L**iskov substitution principle
+  - **I**nterface segregation principle
+  - **D**ependency inversion principle
+
+#### AVOID
+
+- Using `function()`
+
+#### DON’T
+
+- Use the `var` keyword
+
+## Classes:
+
+#### DO
+
+- Only name things with “Base” if they are an abstract class, or cannot be instantiated normally
+
+#### CONSIDER
+
+-
+
+#### AVOID
+
+- Using inheritance, prefer composition when building up types
+- Using the singleton pattern, consider factory or an adapter pattern
+
+#### DON’T
+
+- Name things with a “Base” if they can be instantiated normally
+
+## Methods:
+
+#### DO
+
+- Have descriptive and verbose parameter names, especially for similar looking methods
+- Use JavaScript getters/setters for things that feel like properties, but have logic behind them
+- Use getters for things that should be strict `readonly` properties
+- Use properties for quantities that have no logic behind them
+- Use methods for commands, performing an action, or making queries
+- Prefer verbs like `show()` or `hide()` for booleans instead of properties like `.isVisible = true`
+  - Example: `isDebug` should be `enableDebug()`/`disableDebug()` or `toggleDebug() // returns current mode`
+
+#### CONSIDER
+
+- Consider `get` or `set` when needing to return non-trivial types or perform non-trivial calculation, for example `getConfiguration()`
+- Shorter descriptive names over longer names
+- Prefer less words over more where appropriate
+- Use option bags for parameters with interface typings, for example
+
+```typescript
+export interface EngineOptions { … }
+class Engine {
+    constructor(options?: EngineOptions) {
+       ...
+    }
+    ...
+}
+```
+
+#### AVOID
+
+- The words `get` or `set` for primitive types like `number` or `string`
+  Abbreviations for parameter names
+
+#### DON’T
+
+- Make parameter lists larger than 3 required parameters `someMethod(parm1, param2, param3, param4)`, use an option bag.
+
+## Interfaces:
+
+#### DO
+
+- Name with a verb suffix “-able” or "-like", for example `Updatable` or `Drawable` except in the case of option bag parameters
+
+#### CONSIDER
+
+- Keep interfaces short and simple, if they get too large can they be broken into **multiple** interfaces. See the **Interface Segregation Principle**
+
+### DON’T
+
+- Use an “I” prefix, do not use things like `IDrawable` should be `Drawable`
+
+## Enums
+
+#### DO
+
+- Use `number`ed or `string` enums, preferring `string` enums for more robust type support, robust refactorings, and debuggability at run-time
+
+```typescript
+export enum CollisionType {
+  /**
+   * Actors with the `PreventCollision` setting do not participate in any
+   * collisions and do not raise collision events.
+   */
+  PreventCollision = 'PreventCollision',
+  /**
+   * Actors with the `Passive` setting only raise collision events, but are not
+   * influenced or moved by other actors and do not influence or move other actors.
+   */
+  Passive = 'Passive',
+  /**
+   * Actors with the `Active` setting raise collision events and participate
+   * in collisions with other actors and will be push or moved by actors sharing
+   * the `Active` or `Fixed` setting.
+   */
+  Active = 'Active',
+  /**
+   * Actors with the `Fixed` setting raise collision events and participate in
+   * collisions with other actors. Actors with the `Fixed` setting will not be
+   * pushed or moved by other actors sharing the `Fixed`. Think of Fixed
+   * actors as "immovable/unstoppable" objects. If two `Fixed` actors meet they will
+   * not be pushed or moved by each other, they will not interact except to throw
+   * collision events.
+   */
+  Fixed = 'Fixed'
+}
+```

package/build/dist/Actions/Action/ActionSequence.js

@@ -0,0 +1,31 @@
+import { ActionContext } from '../ActionContext';
+/**
+ * Action that can represent a sequence of actions, this can be useful in conjunction with
+ * [[ParallelActions]] to run multiple sequences in parallel.
+ */
+export class ActionSequence {
+    constructor(entity, actionBuilder) {
+        this._stopped = false;
+        this._sequenceBuilder = actionBuilder;
+        this._sequenceContext = new ActionContext(entity);
+        this._actionQueue = this._sequenceContext.getQueue();
+        this._sequenceBuilder(this._sequenceContext);
+    }
+    update(delta) {
+        this._actionQueue.update(delta);
+    }
+    isComplete() {
+        return this._stopped || this._actionQueue.isComplete();
+    }
+    stop() {
+        this._stopped = true;
+    }
+    reset() {
+        this._stopped = false;
+        this._actionQueue.reset();
+    }
+    clone(entity) {
+        return new ActionSequence(entity, this._sequenceBuilder);
+    }
+}
+//# sourceMappingURL=ActionSequence.js.map

package/build/dist/Actions/Action/ActionSequence.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActionSequence.js","sourceRoot":"","sources":["../../../../src/engine/Actions/Action/ActionSequence.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAGjD;;;GAGG;AACH,MAAM,OAAO,cAAc;IAKzB,YAAY,MAAc,EAAE,aAAoD;QAHxE,aAAQ,GAAY,KAAK,CAAC;QAIhC,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAC;QACtC,IAAI,CAAC,gBAAgB,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC;QACrD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC/C,CAAC;IAEM,MAAM,CAAC,KAAa;QACzB,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;IACzD,CAAC;IAEM,IAAI;QACT,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAEM,KAAK;QACV,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;IAEM,KAAK,CAAC,MAAc;QACzB,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;IAC3D,CAAC;CACF"}