excalibur 0.25.0 → 0.25.1

package/.nvmrc

@@ -1 +1 @@
-14.18.0
+14.18.1

package/CHANGELOG.md

@@ -8,25 +8,64 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Breaking Changes
 
 -
+### Deprecated
+
+-
+
 ### Added
 
-- 
-### Changed
+-
 
-- 
-### Deprecated
 
-- 
-### Removed
+### Fixed
+
+-
+
+### Updates
+
+-
+
+### Changed
 
 -
-### Fixed
 
-- 
 
 <!--------------------------------- DO NOT EDIT BELOW THIS LINE --------------------------------->
 <!--------------------------------- DO NOT EDIT BELOW THIS LINE --------------------------------->
 <!--------------------------------- DO NOT EDIT BELOW THIS LINE --------------------------------->
+## [v0.25.1] - 2021-11-05
+
+### Breaking Changes
+
+-
+### Added
+
+- *Experimental:* Native ES module bundle distribution in package `esm/excalibur.js` entrypoint ([#2064](https://github.com/excaliburjs/Excalibur/pull/2064))
+- `withEngine` utils support an aditional options parameter to override the Engine default options.
+- Story to show a play / pause implementation. 
+- `ex.Animation` now support `totalDuration` that will calculate automatically each frame duration based on how many frames have.
+- `ex.Animation` now supports `.reverse()` to reverse the direction of play in an animation, use the `ex.Animation.direction` to inspect if the animation is playing in the `ex.AnimationDirection.Forward` direction or the `ex.AnimationDirection.Backward` direction.
+-
+### Changed
+
+- Internal Actions implementation converted to ECS system and component, this is a backwards compatible change with v0.25.0
+  - `ex.ActionsSystem` and `ex.ActionsComponent` now wrap the existing `ex.ActionContext`
+  - Actions can be shared with all entities now!
+- Dispatch the `hidePlayButton` on the Button Event to prevent that keep on the screen on some situations [#1431].
+- Revert VSCode Workbench Colors
+-
+### Deprecated
+
+- Actions `asPromise()` renamed to `toPromise()`
+### Removed
+
+-
+### Fixed
+
+- Fixed loader button position on window resize
+- Fixed issue with setting `ex.TileMap.z` to a value
+- Fixed crash in debug system if there is no collider geometry
+- Fixed ImageSource loading error message [#2049]
 
 ## [0.25.0] - 2021-10-03
 
@@ -158,7 +197,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Add `SpriteSheet.getSpacingDimensions()` method to retrieve calculated spacing dimensions ([#1788](https://github.com/excaliburjs/Excalibur/issues/1778))
 - Add `KeyEvent.value?: string` which is the key value (or "typed" value) that the browser detected. For example, holding Shift and pressing 9 will have a value of `(` which is the typed character.
 - Add `KeyEvent.originalEvent?: KeyboardEvent` which exposes the raw keyboard event handled from the browser.
-
+- Added a new getter to GraphicsComponent.ts called currentKeys that will return the names of the graphics shown in all layers
+- Added a new getter to GraphicsLayer called currentKeys that will the names of the graphics shown in this layer
 ### Changed
 
 - `Gif` now supports new graphics component

package/LICENSE.md

@@ -1,6 +1,6 @@
 BSD 2-Clause License
 
-Copyright (c) 2014, Erik Onarheim
+Copyright (c) 2013, Erik Onarheim
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -17,10 +17,10 @@ Excalibur is an open source project licensed under the 2-clause BSD license (thi
 
 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 [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/features) 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
+- Learn what [Features](https://excaliburjs.com/docs/features) 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!
 
@@ -30,7 +30,7 @@ Visit the [API Reference](https://excaliburjs.com/docs/api/edge) section for ful
 
 # Questions
 
-- :question: Ask us anything in the [GitHub Discissions area](https://github.com/excaliburjs/Excalibur/discussions)
+- :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).
 
@@ -40,11 +40,11 @@ Compiled examples can be found [in the Excalibur Samples collection](http://exca
 
 # 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 good feature, we thank you for your help!
+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!
 
 # Writing Documentation
 
-We love when people help improve our documentation. You can contribute to the docs at https://github.com/excaliburjs/excaliburjs.github.io
+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
 
@@ -85,12 +85,8 @@ npm run build
 npm test
 npm run test
 
-# Compile HTML visual tests
-# Useful to ensure HTML sandbox compiles
-npm run visual
-
-# Start sandbox dev server (long-running)
-# Run in separate terminal alongside `npm run visual`
+# Start Storybook-based sandbox
+# Used for creating interactive visual tests and examples for docs
 npm run sandbox
 
 # Compile API docs

package/build/dist/Actions/Action/Blink.d.ts

@@ -1,15 +1,15 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 export declare class Blink implements Action {
+    private _graphics;
     private _timeVisible;
     private _timeNotVisible;
     private _elapsedTime;
     private _totalTime;
-    private _actor;
     private _duration;
     private _stopped;
     private _started;
-    constructor(actor: Actor, timeVisible: number, timeNotVisible: number, numBlinks?: number);
+    constructor(entity: Entity, timeVisible: number, timeNotVisible: number, numBlinks?: number);
     update(delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/Delay.d.ts

@@ -1,14 +1,10 @@
-import { Actor } from '../../Actor';
 import { Action } from '../Action';
 export declare class Delay implements Action {
-    x: number;
-    y: number;
-    private _actor;
     private _elapsedTime;
     private _delay;
     private _started;
     private _stopped;
-    constructor(actor: Actor, delay: number);
+    constructor(delay: number);
     update(delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/Die.d.ts

@@ -1,11 +1,9 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 export declare class Die implements Action {
-    x: number;
-    y: number;
-    private _actor;
+    private _entity;
     private _stopped;
-    constructor(actor: Actor);
+    constructor(entity: Entity);
     update(_delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/EaseTo.d.ts

@@ -1,8 +1,10 @@
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Actor } from '../../Actor';
 import { Action } from '../Action';
 export declare class EaseTo implements Action {
-    actor: Actor;
     easingFcn: (currentTime: number, startValue: number, endValue: number, duration: number) => number;
+    private _tx;
+    private _motion;
     private _currentLerpTime;
     private _lerpDuration;
     private _lerpStart;
@@ -10,7 +12,7 @@ export declare class EaseTo implements Action {
     private _initialized;
     private _stopped;
     private _distance;
-    constructor(actor: Actor, x: number, y: number, duration: number, easingFcn: (currentTime: number, startValue: number, endValue: number, duration: number) => number);
+    constructor(entity: Entity, x: number, y: number, duration: number, easingFcn: (currentTime: number, startValue: number, endValue: number, duration: number) => number);
     private _initialize;
     update(delta: number): void;
     isComplete(actor: Actor): boolean;

package/build/dist/Actions/Action/Fade.d.ts

@@ -1,15 +1,15 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 export declare class Fade implements Action {
+    private _graphics;
     x: number;
     y: number;
-    private _actor;
     private _endOpacity;
     private _speed;
     private _multiplier;
     private _started;
     private _stopped;
-    constructor(actor: Actor, endOpacity: number, speed: number);
+    constructor(entity: Entity, endOpacity: number, speed: number);
     update(delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/Follow.d.ts

@@ -1,8 +1,10 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 export declare class Follow implements Action {
-    private _actor;
-    private _actorToFollow;
+    private _tx;
+    private _motion;
+    private _followTx;
+    private _followMotion;
     x: number;
     y: number;
     private _current;
@@ -13,7 +15,7 @@ export declare class Follow implements Action {
     private _distanceBetween;
     private _started;
     private _stopped;
-    constructor(actor: Actor, actorToFollow: Actor, followDistance?: number);
+    constructor(entity: Entity, entityToFollow: Entity, followDistance?: number);
     update(_delta: number): void;
     stop(): void;
     isComplete(): boolean;

package/build/dist/Actions/Action/Meet.d.ts

@@ -1,8 +1,10 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 export declare class Meet implements Action {
-    private _actor;
-    private _actorToMeet;
+    private _tx;
+    private _motion;
+    private _meetTx;
+    private _meetMotion;
     x: number;
     y: number;
     private _current;
@@ -13,7 +15,7 @@ export declare class Meet implements Action {
     private _started;
     private _stopped;
     private _speedWasSpecified;
-    constructor(actor: Actor, actorToMeet: Actor, speed?: number);
+    constructor(actor: Entity, actorToMeet: Entity, speed?: number);
     update(_delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/MoveBy.d.ts

@@ -1,7 +1,9 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 export declare class MoveBy implements Action {
-    private _actor;
+    private _tx;
+    private _motion;
+    private _entity;
     x: number;
     y: number;
     private _distance;
@@ -12,9 +14,9 @@ export declare class MoveBy implements Action {
     private _dir;
     private _started;
     private _stopped;
-    constructor(actor: Actor, offsetX: number, offsetY: number, speed: number);
+    constructor(entity: Entity, offsetX: number, offsetY: number, speed: number);
     update(_delta: number): void;
-    isComplete(actor: Actor): boolean;
+    isComplete(entity: Entity): boolean;
     stop(): void;
     reset(): void;
 }

package/build/dist/Actions/Action/MoveTo.d.ts

@@ -1,7 +1,9 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 export declare class MoveTo implements Action {
-    private _actor;
+    entity: Entity;
+    private _tx;
+    private _motion;
     x: number;
     y: number;
     private _start;
@@ -11,9 +13,9 @@ export declare class MoveTo implements Action {
     private _distance;
     private _started;
     private _stopped;
-    constructor(actor: Actor, destx: number, desty: number, speed: number);
+    constructor(entity: Entity, destx: number, desty: number, speed: number);
     update(_delta: number): void;
-    isComplete(actor: Actor): boolean;
+    isComplete(entity: Entity): boolean;
     stop(): void;
     reset(): void;
 }

package/build/dist/Actions/Action/Repeat.d.ts

@@ -1,4 +1,4 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 import { ActionContext } from '../ActionContext';
 export declare class Repeat implements Action {
@@ -8,7 +8,7 @@ export declare class Repeat implements Action {
     private _stopped;
     private _repeatContext;
     private _repeatBuilder;
-    constructor(actor: Actor, repeatBuilder: (repeatContext: ActionContext) => any, repeat: number);
+    constructor(entity: Entity, repeatBuilder: (repeatContext: ActionContext) => any, repeat: number);
     update(delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/RepeatForever.d.ts

@@ -1,4 +1,4 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 import { ActionContext } from '../ActionContext';
 /**
@@ -12,7 +12,7 @@ export declare class RepeatForever implements Action {
     private _stopped;
     private _repeatContext;
     private _repeatBuilder;
-    constructor(actor: Actor, repeatBuilder: (repeatContext: ActionContext) => any);
+    constructor(entity: Entity, repeatBuilder: (repeatContext: ActionContext) => any);
     update(delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/RotateBy.d.ts

@@ -1,8 +1,9 @@
-import { Actor } from '../../Actor';
 import { Action } from '../Action';
 import { RotationType } from '../RotationType';
+import { Entity } from '../../EntityComponentSystem/Entity';
 export declare class RotateBy implements Action {
-    private _actor;
+    private _tx;
+    private _motion;
     x: number;
     y: number;
     private _start;
@@ -18,7 +19,7 @@ export declare class RotateBy implements Action {
     private _currentNonCannonAngle;
     private _started;
     private _stopped;
-    constructor(actor: Actor, angleRadiansOffset: number, speed: number, rotationType?: RotationType);
+    constructor(entity: Entity, angleRadiansOffset: number, speed: number, rotationType?: RotationType);
     update(_delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/RotateTo.d.ts

@@ -1,8 +1,9 @@
-import { Actor } from '../../Actor';
 import { Action } from '../Action';
 import { RotationType } from '../RotationType';
+import { Entity } from '../../EntityComponentSystem/Entity';
 export declare class RotateTo implements Action {
-    private _actor;
+    private _tx;
+    private _motion;
     x: number;
     y: number;
     private _start;
@@ -17,7 +18,7 @@ export declare class RotateTo implements Action {
     private _currentNonCannonAngle;
     private _started;
     private _stopped;
-    constructor(actor: Actor, angleRadians: number, speed: number, rotationType?: RotationType);
+    constructor(entity: Entity, angleRadians: number, speed: number, rotationType?: RotationType);
     update(_delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/ScaleBy.d.ts

@@ -1,7 +1,8 @@
-import { Actor } from '../../Actor';
+import { Entity } from '../../EntityComponentSystem/Entity';
 import { Action } from '../Action';
 export declare class ScaleBy implements Action {
-    private _actor;
+    private _tx;
+    private _motion;
     x: number;
     y: number;
     private _startScale;
@@ -15,7 +16,7 @@ export declare class ScaleBy implements Action {
     private _stopped;
     private _speedX;
     private _speedY;
-    constructor(actor: Actor, scaleOffsetX: number, scaleOffsetY: number, speed: number);
+    constructor(entity: Entity, scaleOffsetX: number, scaleOffsetY: number, speed: number);
     update(_delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action/ScaleTo.d.ts

@@ -1,7 +1,8 @@
-import { Actor } from '../../Actor';
 import { Action } from '../Action';
+import { Entity } from '../../EntityComponentSystem/Entity';
 export declare class ScaleTo implements Action {
-    private _actor;
+    private _tx;
+    private _motion;
     x: number;
     y: number;
     private _startX;
@@ -14,7 +15,7 @@ export declare class ScaleTo implements Action {
     private _distanceY;
     private _started;
     private _stopped;
-    constructor(actor: Actor, scaleX: number, scaleY: number, speedX: number, speedY: number);
+    constructor(entity: Entity, scaleX: number, scaleY: number, speedX: number, speedY: number);
     update(_delta: number): void;
     isComplete(): boolean;
     stop(): void;

package/build/dist/Actions/Action.d.ts

@@ -1,10 +1,10 @@
-import { Actor } from '../Actor';
+import { Entity } from '../EntityComponentSystem/Entity';
 /**
  * Used for implementing actions for the [[ActionContext|Action API]].
  */
 export interface Action {
     update(delta: number): void;
-    isComplete(actor: Actor): boolean;
+    isComplete(entity: Entity): boolean;
     reset(): void;
     stop(): void;
 }

package/build/dist/Actions/ActionContext.d.ts

@@ -1,8 +1,8 @@
 import { RotationType } from './RotationType';
-import { Actor } from '../Actor';
 import { EasingFunction } from '../Util/EasingFunctions';
 import { ActionQueue } from './ActionQueue';
-import { Vector } from '..';
+import { Vector } from '../Math/vector';
+import { Entity } from '../EntityComponentSystem/Entity';
 /**
  * The fluent Action API allows you to perform "actions" on
  * [[Actor|Actors]] such as following, moving, rotating, and
@@ -10,9 +10,9 @@ import { Vector } from '..';
  * the [[Action]] interface.
  */
 export declare class ActionContext {
-    private _actor;
+    private _entity;
     private _queue;
-    constructor(actor: Actor);
+    constructor(entity: Entity);
     getQueue(): ActionQueue;
     update(elapsedMs: number): void;
     /**
@@ -193,21 +193,27 @@ export declare class ActionContext {
      */
     repeatForever(repeatBuilder: (repeatContext: ActionContext) => any): ActionContext;
     /**
-     * This method will cause the actor to follow another at a specified distance
-     * @param actor           The actor to follow
+     * This method will cause the entity to follow another at a specified distance
+     * @param entity           The entity to follow
      * @param followDistance  The distance to maintain when following, if not specified the actor will follow at the current distance.
      */
-    follow(actor: Actor, followDistance?: number): ActionContext;
+    follow(entity: Entity, followDistance?: number): ActionContext;
     /**
-     * This method will cause the actor to move towards another until they
+     * This method will cause the entity to move towards another until they
      * collide "meet" at a specified speed.
-     * @param actor  The actor to meet
+     * @param entity  The entity to meet
      * @param speed  The speed in pixels per second to move, if not specified it will match the speed of the other actor
      */
-    meet(actor: Actor, speed?: number): ActionContext;
+    meet(entity: Entity, speed?: number): ActionContext;
     /**
      * Returns a promise that resolves when the current action queue up to now
      * is finished.
+     * @deprecated Use `toPromise()` will be removed in v0.26.0
      */
     asPromise(): Promise<void>;
+    /**
+     * Returns a promise that resolves when the current action queue up to now
+     * is finished.
+     */
+    toPromise(): Promise<void>;
 }

package/build/dist/Actions/ActionQueue.d.ts

@@ -1,4 +1,4 @@
-import { Actor } from '../Actor';
+import { Entity } from '../EntityComponentSystem/Entity';
 import { Action } from './Action';
 /**
  * Action Queues represent an ordered sequence of actions
@@ -11,11 +11,11 @@ import { Action } from './Action';
  * queue.
  */
 export declare class ActionQueue {
-    private _actor;
+    private _entity;
     private _actions;
     private _currentAction;
     private _completedActions;
-    constructor(actor: Actor);
+    constructor(entity: Entity);
     /**
      * Add an action to the sequence
      * @param action