Skip to content

Commit 6506e8d

Browse files
committed
JSdocs update (fix phaserjs#1520)
1 parent ff76cf7 commit 6506e8d

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

src/core/ScaleManager.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1176,6 +1176,10 @@ Phaser.ScaleManager.prototype = {
11761176
* Force the game to run in only one orientation.
11771177
*
11781178
* This enables generation of incorrect orientation signals and affects resizing but does not otherwise rotate or lock the orientation.
1179+
*
1180+
* Orientation checks are performed via the Screen Orientation API, if available in browser. This means it will check your monitor
1181+
* orientation on desktop, or your device orientation on mobile, rather than comparing actual game dimensions. If you need to check the
1182+
* viewport dimensions instead and bypass the Screen Orientation API then set: `ScaleManager.compatibility.orientationFallback = 'viewport'`
11791183
*
11801184
* @method Phaser.ScaleManager#forceOrientation
11811185
* @public

0 commit comments

Comments
 (0)