Skip to content

Commit f18be88

Browse files
committed
Update 'Change Log'
1 parent 93d6500 commit f18be88

File tree

1 file changed

+27
-23
lines changed

1 file changed

+27
-23
lines changed

README.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -334,63 +334,63 @@ If you're starting or stopping input handlers manually, you'll have to make some
334334

335335
### API Changes / New Features
336336

337-
* Phaser now starts the Pointer Events handler (with capture off) or the Mouse handler (with capture off), but not both. This makes input behavior more consistent and avoids some rare conflicts between the two when running simultaneously.
337+
* Phaser now starts the [Pointer Events handler](https://photonstorm.github.io/phaser-ce/Phaser.MSPointer.html) (with capture off) or the [Mouse handler](https://photonstorm.github.io/phaser-ce/Phaser.Mouse.html) (with capture off), but not both. This makes input behavior more consistent and avoids some rare conflicts between the two when running simultaneously.
338338

339339
If you want to disable the Pointer Events handler, pass `{ mspointer: false }` in your game config. The Mouse handler will be used instead.
340340

341-
If you want to run the Mouse handler as well, you can start it manually. You should also turn on capture for the Pointer Events handler to avoid duplicate events:
341+
If you want to run both handlers together, you can start the Mouse handler manually. You should also turn on capture for the Pointer Events handler to avoid duplicate events:
342342

343343
```javascript
344344
game.input.mouse.start();
345345
game.input.mspointer.capture = true;
346346
```
347347

348-
* Mouse wheel input was moved to `input.mouseWheel`. The changed properties are
348+
* [Mouse wheel input](https://photonstorm.github.io/phaser-ce/Phaser.MouseWheel.html) was moved to `input.mouseWheel`. The changed properties are
349349

350-
- `input.mouse.wheelDelta` -> `input.mouseWheel.delta`
351-
- `input.mouse.mouseWheelCallback` -> `input.mouseWheel.callback`
350+
- `input.mouse.wheelDelta` `input.mouseWheel.delta`
351+
- `input.mouse.mouseWheelCallback` `input.mouseWheel.callback`
352352

353353
The old properties will keep working for now.
354354

355-
* Pointer lock input was moved to `input.pointerLock`. The changed properties are
355+
* [Pointer lock input](https://photonstorm.github.io/phaser-ce/Phaser.PointerLock.html) was moved to `input.pointerLock`. The changed properties are
356356

357-
- `input.mouse.pointerLock` -> `input.pointerLock.onChange`
358-
- `input.mouse.requestPointerLock()` -> `input.pointerLock.request()`
359-
- `input.mouse.locked` -> `input.pointerLock.locked`
360-
- `input.mouse.releasePointerLock()` -> `input.pointerLock.exit()`
357+
- `input.mouse.pointerLock` `input.pointerLock.onChange`
358+
- `input.mouse.requestPointerLock()` `input.pointerLock.request()`
359+
- `input.mouse.locked` `input.pointerLock.locked`
360+
- `input.mouse.releasePointerLock()` `input.pointerLock.exit()`
361361

362362
The old properties will keep working for now.
363363

364364
There is a new Signal, `input.pointerLock.onError`, dispatched when a request fails.
365365

366-
Beware that Chrome < 68 doesn't pass movement values when using Pointer Events with pointer lock, so you should use the Mouse handler instead for that.
366+
Beware that [Chrome < 68 doesn't pass movement values when using Pointer Events with pointer lock](https://bugs.chromium.org/p/chromium/issues/detail?id=836995), so you should use the Mouse handler instead for that.
367367

368368
* `game.debug.inputInfo()` now shows which input handlers and pointers are active.
369369

370370
* All the input handlers have an `active` property that shows whether they've been started. Their `start` methods return true if they've been started or false otherwise.
371371

372-
* The `skipFrames` argument in AnimationParser#spritesheet now works as an offset (#514). When positive, it's an offset from the start of the parsed frame list; when negative, it's an offset from the end. Negative `frameWidth` and `frameHeight` arguments are no longer allowed.
372+
* The `skipFrames` argument in [AnimationParser#spriteSheet](https://photonstorm.github.io/phaser-ce/Phaser.AnimationParser.html#_spriteSheet) now works as an offset (#514). When positive, it's an offset from the start of the parsed frame list; when negative, it's an offset from the end. Negative `frameWidth` and `frameHeight` arguments are no longer allowed.
373373

374374
* preRender() and postRender() hooks are no longer called for the HEADLESS renderer.
375375

376-
* `game.make.group()` no longer assigns a default parent. This is more consistent with the rest of the game.make methods (#525). Use `game.add.group()` instead to add the Group to the game world.
376+
* `game.make.group()` no longer assigns a default parent. This is more consistent with the rest of the [game.make](https://photonstorm.github.io/phaser-ce/Phaser.GameObjectCreator.html) methods (#525). Use `game.add.group()` instead to add the Group to the game world.
377377

378-
* Point.parse() no longer converts coordinates to integers (#502). Use the new method Point.trunc() as well if you want the previous behavior.
378+
* [Point.parse()](https://photonstorm.github.io/phaser-ce/Phaser.Point.html#_parse) no longer converts coordinates to integers (#502). Use the new method [Point.trunc()](https://photonstorm.github.io/phaser-ce/Phaser.Point.html#_trunc) as well if you want the previous behavior.
379379

380-
* The default Debug#font is now '14px monospace'.
380+
* The default [Debug#font](https://photonstorm.github.io/phaser-ce/Phaser.Utils.Debug.html#font) is now '14px monospace'.
381381

382382
* The unused and deprecated property MSPointer#button was removed.
383383

384384
### New Features
385385

386-
* States have a new postUpdate method hook. It's called after game objects have received all their own updates (including physics), but before the Stage has calculated the final transformations.
387-
* Debug#spriteInfo shows the sprite's parent, if any.
388-
* When a sprite is being dragged you can read its change in position (as `deltaX`, `deltaY`) in the onDragUpdate handler.
389-
* Phaser.Math.trunc() truncates a number.
386+
* States have a new [postUpdate](https://photonstorm.github.io/phaser-ce/Phaser.State.html#postUpdate) method hook. It's called after game objects have received all their own updates (including physics), but before the Stage has calculated the final transformations.
387+
* [Debug#spriteInfo](https://photonstorm.github.io/phaser-ce/Phaser.Utils.Debug.html#spriteInfo) shows the sprite's parent, if any.
388+
* When a sprite is being dragged you can read its change in position (as `deltaX`, `deltaY`) in the [onDragUpdate](https://photonstorm.github.io/phaser-ce/Phaser.Events.html#onDragUpdate) handler.
389+
* [Phaser.Math.trunc()](https://photonstorm.github.io/phaser-ce/Phaser.Math.html#trunc) truncates a number.
390390
* Phaser.EmptyRectangle replaces PIXI.EmptyRectangle.
391-
* Debug#device shows device graphics, audio, and input support. It may be helpful on devices where you can't see `console` output easily.
392-
* Debug#pointer shows the pointer's movementX/movementY values and button states (for mouse pointers).
393-
* maxPointers can be passed in the game config, setting Input#maxPointers.
391+
* [Debug#device](https://photonstorm.github.io/phaser-ce/Phaser.Utils.Debug.html#device) shows device graphics, audio, and input support. It may be helpful on devices where you can't see `console` output easily.
392+
* [Debug#pointer](https://photonstorm.github.io/phaser-ce/Phaser.Utils.Debug.html#pointer) shows the pointer's movementX/movementY values and button states (for mouse pointers).
393+
* `maxPointers` can be passed in the [game config](https://photonstorm.github.io/phaser-ce/global.html#GameConfig), setting [Input#maxPointers](https://photonstorm.github.io/phaser-ce/Phaser.Input.html#maxPointers).
394394

395395
### Updates
396396

@@ -399,7 +399,11 @@ If you're starting or stopping input handlers manually, you'll have to make some
399399
### Bug Fixes
400400

401401
* Masks are no longer disabled by getBounds() and are excluded from bounds calculations (#334).
402-
* Sprites' bringToTop() and sendToBack() methods now work as expected for all parent types, not just Groups (#549).
402+
* Sprites' [bringToTop()](https://photonstorm.github.io/phaser-ce/Phaser.Sprite.html#bringToTop) and [sendToBack()](https://photonstorm.github.io/phaser-ce/Phaser.Sprite.html#sendToBack) methods now work as expected for all parent types, not just Groups (#549).
403+
404+
### Thanks
405+
406+
@giniwren, @griever989, @mindcity, @omretterry, @photonstorm, @samme, @Siri0n, @tobspr
403407

404408
## Version 2.10.6 - 1st June 2018
405409

0 commit comments

Comments
 (0)