new ScaleManager(game, width, height)
The ScaleManager object is responsible for helping you manage the scaling, resizing and alignment of your game within the browser.
Parameters:
| Name | Type | Description |
|---|---|---|
game |
Phaser.Game | A reference to the currently running game. |
width |
number | string | The width of the game. |
height |
number | string | The height of the game. |
- Source:
Members
-
<static, constant> EXACT_FIT :number
-
Type:
- number
- Source:
-
<static, constant> NO_SCALE :number
-
Type:
- number
- Source:
-
<static, constant> RESIZE :number
-
Type:
- number
- Source:
-
<static, constant> SHOW_ALL :number
-
Type:
- number
- Source:
-
<readonly> aspectRatio
-
- Source:
Properties:
Name Type Description aspectRationumber The aspect ratio of the scaled game.
-
<readonly> bounds
-
- Source:
Properties:
Name Type Description boundsPhaser.Rectangle The bounds of the scaled game. The x/y will match the offset of the canvas element and the width/height the scaled width and height.
-
enterFullScreen
-
- Source:
Properties:
Name Type Description enterFullScreenPhaser.Signal The event that is dispatched when the browser enters full screen mode (if it supports the FullScreen API).
-
enterIncorrectOrientation
-
- Source:
Properties:
Name Type Description enterIncorrectOrientationPhaser.Signal The event that is dispatched when the browser enters an incorrect orientation, as defined by forceOrientation.
-
enterLandscape
-
- Source:
Properties:
Name Type Description enterLandscapePhaser.Signal The event that is dispatched when the browser enters landscape orientation having been in portrait.
-
enterPortrait
-
- Source:
Properties:
Name Type Description enterPortraitPhaser.Signal The event that is dispatched when the browser enters portrait orientation having been in landscape.
-
event
-
- Source:
Properties:
Name Type Description event-any The native browser events from full screen API changes.
-
forceLandscape
-
- Default Value:
- false
- Source:
Properties:
Name Type Description forceLandscapeboolean Set to
trueif the game should only run in a landscape orientation. -
forcePortrait
-
- Default Value:
- false
- Source:
Properties:
Name Type Description forcePortraitboolean Set to
trueif the game should only run in a portrait orientation. -
fullScreenTarget
-
This is the DOM element that will have the Full Screen mode called on it. It defaults to the game canvas, but can be retargetted to any valid DOM element. If you adjust this property it's up to you to see it has the correct CSS applied, and that you have contained the game canvas correctly. Note that if you use a scale property of EXACT_FIT then fullScreenTarget will have its width and height style set to 100%.
- Source:
Properties:
Name Type Description fullScreenTargetany -
game
-
- Source:
Properties:
Name Type Description gamePhaser.Game A reference to the currently running game.
-
grid
-
- Source:
Properties:
Name Type Description gridPhaser.FlexGrid EXPERIMENTAL: A responsive grid on which you can align game objects.
-
height
-
- Source:
Properties:
Name Type Description heightnumber Height of the game after calculation.
-
incorrectOrientation
-
- Default Value:
- false
- Source:
Properties:
Name Type Description incorrectOrientationboolean If
forceLandscapeorforcePortraitare true and the browser doesn't match that orientation this is set totrue. -
<readonly> isFullScreen
-
- Source:
Properties:
Name Type Description isFullScreenboolean Returns true if the browser is in full screen mode, otherwise false.
-
<readonly> isLandscape
-
- Source:
Properties:
Name Type Description isLandscapeboolean Returns true if the browser dimensions match a landscape display.
-
<readonly> isPortrait
-
- Source:
Properties:
Name Type Description isPortraitboolean Returns true if the browser dimensions match a portrait display.
-
leaveFullScreen
-
- Source:
Properties:
Name Type Description leaveFullScreenPhaser.Signal The event that is dispatched when the browser leaves full screen mode (if it supports the FullScreen API).
-
leaveIncorrectOrientation
-
- Source:
Properties:
Name Type Description leaveIncorrectOrientationPhaser.Signal The event that is dispatched when the browser leaves an incorrect orientation, as defined by forceOrientation.
-
<readonly> margin
-
- Source:
Properties:
Name Type Description marginPhaser.Point If the game canvas is set to align by adjusting the margin, the margin calculation values are stored in this Point.
-
maxHeight
-
- Source:
Properties:
Name Type Description maxHeightnumber Maximum height the canvas should be scaled to (in pixels). If null it will scale to whatever height the browser can handle.
-
maxIterations
-
- Default Value:
- 5
- Source:
Properties:
Name Type Description maxIterationsnumber The maximum number of times it will try to resize the canvas to fill the browser.
-
maxWidth
-
- Source:
Properties:
Name Type Description maxWidthnumber Maximum width the canvas should be scaled to (in pixels). If null it will scale to whatever width the browser can handle.
-
minHeight
-
- Source:
Properties:
Name Type Description minHeightnumber Minimum height the canvas should be scaled to (in pixels).
-
minWidth
-
- Source:
Properties:
Name Type Description minWidthnumber Minimum width the canvas should be scaled to (in pixels).
-
offset
-
- Source:
Properties:
Name Type Description offsetPhaser.Point Holds the offset coordinates of the Game.canvas from the top-left of the browser window (used by Input and other classes)
-
onResize
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onResizefunction The callback that will be called each time a window.resize event happens or if set, the parent container resizes.
-
onResizeContext
-
- Default Value:
- null
- Source:
Properties:
Name Type Description onResizeContextobject The context in which the callback will be called.
-
orientation
-
- Source:
Properties:
Name Type Description orientationnumber The orientation value of the game (as defined by window.orientation if set). 90 = landscape. 0 = portrait.
-
pageAlignHorizontally
-
- Default Value:
- false
- Source:
Properties:
Name Type Description pageAlignHorizontallyboolean If you wish to align your game in the middle of the page then you can set this value to true. It will place a re-calculated margin-left pixel value onto the canvas element which is updated on orientation/resizing events. It doesn't care about any other DOM element that may be on the page, it literally just sets the margin.
-
pageAlignVertically
-
- Default Value:
- false
- Source:
Properties:
Name Type Description pageAlignVerticallyboolean If you wish to align your game in the middle of the page then you can set this value to true. It will place a re-calculated margin-left pixel value onto the canvas element which is updated on orientation/resizing events. It doesn't care about any other DOM element that may be on the page, it literally just sets the margin.
-
<readonly> parentIsWindow
-
- Source:
Properties:
Name Type Description parentIsWindowboolean If the parent container of the game is the browser window, rather than a div, this is set to
true. -
<readonly> parentNode
-
- Source:
Properties:
Name Type Description parentNodeobject The fully parsed parent container of the game. If the parent is the browser window this will be
null. -
<readonly> parentScaleFactor
-
- Source:
Properties:
Name Type Description parentScaleFactorPhaser.Point The scale of the game in relation to its parent container.
-
<readonly> scaleFactor
-
- Source:
Properties:
Name Type Description scaleFactorPhaser.Point The scale factor based on the game dimensions vs. the scaled dimensions.
-
<readonly> scaleFactorInversed
-
- Source:
Properties:
Name Type Description scaleFactorInversedPhaser.Point The inversed scale factor. The displayed dimensions divided by the game dimensions.
-
scaleMode
-
- Source:
Properties:
Name Type Description scaleModenumber The scaling method used by the ScaleManager.
-
<readonly> sourceAspectRatio
-
- Source:
Properties:
Name Type Description sourceAspectRationumber The aspect ratio (width / height) of the original game dimensions.
-
trackParentInterval
-
- Default Value:
- 2000
- Source:
Properties:
Name Type Description trackParentIntervalnumber The interval (in ms) upon which the ScaleManager checks if the parent has changed dimensions. Only applies if scaleMode = RESIZE and the game is contained within another html element.
-
width
-
- Source:
Properties:
Name Type Description widthnumber Width of the game after calculation.
Methods
-
boot()
-
Calculates and sets the game dimensions based on the given width and height.
- Source:
-
checkOrientation(event)
-
window.orientationchange event handler.
Parameters:
Name Type Description eventEvent The orientationchange event data.
- Source:
-
checkOrientationState()
-
Checks if the browser is in the correct orientation for your game (if forceLandscape or forcePortrait have been set)
- Source:
-
checkResize(event)
-
window.resize event handler.
Parameters:
Name Type Description eventEvent The resize event data.
- Source:
-
forceOrientation(forceLandscape, forcePortrait)
-
If you need your game to run in only one orientation you can force that to happen.
Parameters:
Name Type Argument Default Description forceLandscapeboolean true if the game should run in landscape mode only.
forcePortraitboolean <optional>
false true if the game should run in portrait mode only.
- Source:
-
<protected> fullScreenChange(event)
-
Called automatically when the browser enters of leaves full screen mode.
Parameters:
Name Type Description eventEvent The fullscreenchange event
- Source:
-
parseConfig(config)
-
Parses the Game configuration object.
Parameters:
Name Type Description configobject The game configuration object.
- Source:
-
<protected> preUpdate()
-
The ScaleManager.preUpdate is called automatically by the core Game loop.
- Source:
-
refresh()
-
Re-calculate scale mode and update screen size. This only applies if ScaleMode is not set to RESIZE.
- Source:
-
setExactFit()
-
Sets the width and height values of the canvas, no larger than the maxWidth/Height.
- Source:
-
setMaximum()
-
Sets this.width equal to window.innerWidth and this.height equal to window.innerHeight.
- Source:
-
setResizeCallback(callback, context)
-
Sets the callback that will be called when the window resize event occurs, or if set the parent container changes dimensions. Use this to handle responsive game layout options. Note that the callback will only be called if the ScaleManager.scaleMode is set to RESIZE.
Parameters:
Name Type Description callbackfunction The callback that will be called each time a window.resize event happens or if set, the parent container resizes.
contextobject The context in which the callback will be called.
- Source:
-
setScreenSize(force)
-
Set screen size automatically based on the scaleMode. This is only needed if ScaleMode is not set to RESIZE.
Parameters:
Name Type Description forceboolean If force is true it will try to resize the game regardless of the document dimensions.
- Source:
-
setShowAll()
-
Calculates the multiplier needed to scale the game proportionally.
- Source:
-
setSize()
-
Sets the canvas style width and height values based on minWidth/Height and maxWidth/Height.
- Source:
-
setupScale(width, height)
-
Calculates and sets the game dimensions based on the given width and height.
Parameters:
Name Type Description widthnumber | string The width of the game.
heightnumber | string The height of the game.
- Source:
-
startFullScreen(antialias)
-
Tries to enter the browser into full screen mode. Please note that this needs to be supported by the web browser and isn't the same thing as setting your game to fill the browser.
Parameters:
Name Type Description antialiasboolean You can toggle the anti-alias feature of the canvas before jumping in to full screen (false = retain pixel art, true = smooth art)
- Source:
-
stopFullScreen()
-
Stops full screen mode if the browser is in it.
- Source: