Skip to content

Commit

Permalink
Update files for 0.11.0 release (#834)
Browse files Browse the repository at this point in the history
## Changes:

- update CHANGELOG.md
- fix documentation typos
  • Loading branch information
jedeen authored and eonarheim committed Jun 10, 2017
1 parent e69dfe2 commit a24cdb6
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 25 deletions.
24 changes: 16 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,28 @@ This project adheres to [Semantic Versioning](http://semver.org/).
## [Unreleased]

### Breaking Changes
- Renamed Utils.removeItemFromArray() to Utils.removeItemFromArray() ([#798](https://github.com/excaliburjs/Excalibur/issues/798/))
### Added
### Changed
### Deprecated
### Fixed

<!----------------------------------------------------------------------------------------------->

## [0.11.0] 2017-06-10

### Breaking Changes
- Renamed Utils.removeItemToArray() to Utils.removeItemFromArray() ([#798](https://github.com/excaliburjs/Excalibur/issues/798/))

### Added
- Added optional volume argument to `Sound.play(volume?: number)`, which will play the Audio file at anywhere from mute (`volume` is 0.0) to full volume (`volume` is 1.0). ([#801](https://github.com/excaliburjs/Excalibur/issues/801))
- Added another DisplayMode option: `DisplayMode.Position`. When this is selected as the displayMode type, the user must specify a new `position` option
- Added a new Interface `AbsolutePosition` which can described the `position` option. A `string` can also describe `position`
- Added a static method distanceBetweenVectors to the Vector class ([#517](https://github.com/excaliburjs/Excalibur/issues/517))
- Added `PointerWheel` event type for the `wheel` browser event, Excalibur now supports scroll wheel ([#808](https://github.com/excaliburjs/Excalibur/issues/808/))
- Added another DisplayMode option: `DisplayMode.Position`. When this is selected as the displayMode type, the user must specify a new `position` option ([#781](https://github.com/excaliburjs/Excalibur/issues/781))
- Added a static method `distance` to the `Vector` class ([#517](https://github.com/excaliburjs/Excalibur/issues/517))
- Added `WheelEvent` event type for the `wheel` browser event, Excalibur now supports scroll wheel ([#808](https://github.com/excaliburjs/Excalibur/issues/808/))

### Changed
- Camera zoom over time now returns a promise that resolves on completion ([#800](https://github.com/excaliburjs/Excalibur/issues/800))
- Edge builds have more descriptive versions now containing build number and Git commit hash (e.g. `0.10.0-alpha.105#commit`) ([#777](https://github.com/excaliburjs/Excalibur/issues/777))

### Deprecated
### Removed
### Fixed
- Fixed camera zoom over time, before it did not work at all ([#800](https://github.com/excaliburjs/Excalibur/issues/800))
- Fixed semi-colon key not being detected on Firefox and Opera. ([#789](https://github.com/excaliburjs/Excalibur/issues/789))
Expand Down Expand Up @@ -402,7 +409,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).

<!----------------------------------------------------------------------------------------------->

[Unreleased]: https://github.com/excaliburjs/Excalibur/compare/v0.10.0...HEAD
[Unreleased]: https://github.com/excaliburjs/Excalibur/compare/v0.11.0...HEAD
[0.11.0]: https://github.com/excaliburjs/Excalibur/compare/v0.10.0...v0.11.0
[0.10.0]: https://github.com/excaliburjs/Excalibur/compare/v0.9.0...v0.10.0
[0.9.0]: https://github.com/excaliburjs/Excalibur/compare/v0.8.0...v0.9.0
[0.8.0]: https://github.com/excaliburjs/Excalibur/compare/v0.7.1...v0.8.0
Expand Down
2 changes: 1 addition & 1 deletion src/engine/Debug.ts
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ export interface IPhysicsStats {
collisions: number;

/**
* A Hash storing the [[Pair.ids]]s of [[Pairs]]s that collided in the frame
* A Hash storing the [[Pair.id]]s of [[Pair]]s that collided in the frame
*/
collidersHash: ICollidersHash;

Expand Down
32 changes: 16 additions & 16 deletions src/engine/Engine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ export enum DisplayMode {
*/
Fixed,

/*
* Allow the game to be positioned with the position option
*/
/**
* Allow the game to be positioned with the [[IEngineOptions.position]] option
*/
Position
}

Expand All @@ -65,11 +65,11 @@ export enum ScrollPreventionMode {
All
}

/*
* Interface describing the absolute CSS position of the game window. For use when DisplayMode.Position
* is specified and when the user wants to define exact pixel spacing of the window.
* When a number is given, the value is interpreted as pixels
*/
/**
* Interface describing the absolute CSS position of the game window. For use when [[DisplayMode.Position]]
* is specified and when the user wants to define exact pixel spacing of the window.
* When a number is given, the value is interpreted as pixels
*/
export interface IAbsolutePosition {

top?: number | string;
Expand Down Expand Up @@ -121,14 +121,14 @@ export interface IEngineOptions {
*/
suppressMinimumBrowserFeatureDetection?: boolean;

/*
* Specify how the game window is to be positioned when the DisplayMode.Position is chosen. This option MUST be specified
* if the DisplayMode is set as DisplayMode.Position. The position can be either a string or an AbsolutePosition. String must be in the
* format of css style background-position. The vertical position must precede the horizontal position in Strings
* Valid String examples: "top left", "top", "bottom", "middle", "middle center", "bottom right"
* Valid IAbsolutePosition examples: {top: 5, right: 10%}, {bottom: 49em, left: 10px}, {left: 10, bottom: 40}
*/

/**
* Specify how the game window is to be positioned when the [[DisplayMode.Position]] is chosen. This option MUST be specified
* if the DisplayMode is set as [[DisplayMode.Position]]. The position can be either a string or an [[IAbsolutePosition]].
* String must be in the format of css style background-position. The vertical position must precede the horizontal position in strings.
*
* Valid String examples: "top left", "top", "bottom", "middle", "middle center", "bottom right"
* Valid [[IAbsolutePosition]] examples: `{top: 5, right: 10%}`, `{bottom: 49em, left: 10px}`, `{left: 10, bottom: 40}`
*/
position?: string | IAbsolutePosition;

/**
Expand Down

0 comments on commit a24cdb6

Please sign in to comment.