Filter
The active game configuration settings, parsed from a Phaser.Types.Core.GameConfig object.
Constructor:
new Config([GameConfig])
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| GameConfig | Phaser.Types.Core.GameConfig | <optional> |
The configuration object for your Phaser Game instance. |
Members
Description:
When set to true, WebGL uses linear interpolation to draw scaled or rotated textures, giving a smooth appearance. When set to false, WebGL uses nearest-neighbor interpolation, giving a crisper appearance. false also disables antialiasing of the game canvas itself, if the browser supports it, when the game canvas is scaled.
Type:
Description:
Sets the antialias property when the WebGL context is created. Setting this value does not impact any subsequent textures that are created, or the canvas style attributes.
Type:
Description:
The Audio Configuration object.
Description:
Automatically center the canvas within the parent?
Type:
Description:
If true the window will automatically be given focus immediately and on any future mousedown event.
Type:
Description:
Automatically enable the Mobile Pipeline if iOS or Android detected?
Type:
Description:
Automatically round the display and style sizes of the canvas. This can help with performance in lower-powered devices.
Type:
Description:
The background color of the game canvas. The default is black. This value is ignored if transparent is set to true.
Type:
Description:
The background colors of the banner.
Type:
Description:
The color of the banner text.
Type:
Description:
The default WebGL Batch size. Represents the number of quads that can be added to a single batch.
Type:
Description:
Force Phaser to use your own Canvas element instead of creating one.
Type:
Description:
Optional CSS attributes to be set on the canvas object created by the renderer.
Type:
Description:
Whether the game canvas will be cleared between each rendering frame. You can disable this if you have a full-screen background image or game object.
Type:
Description:
Force Phaser to use your own Canvas context instead of creating one.
Type:
Description:
Is Phaser running under a custom (non-native web) environment? If so, set this to true to skip internal Feature detection. If true the renderType cannot be left as AUTO.
Type:
Description:
A base64 encoded PNG that will be used as the default blank texture.
Type:
Description:
The default physics system. It will be started for each scene. Either 'arcade', 'impact' or 'matter'.
Type:
Description:
The WebGL Pipeline that Game Objects will use by default. Set to 'MultiPipeline' as standard. See also 'autoMobilePipeline'.
Type:
Description:
The plugins installed into every Scene (in addition to CoreScene and Global).
Type:
Description:
When set to true it will create a desynchronized context for both 2D and WebGL. See https://developers.google.com/web/updates/2019/05/desynchronized for details.
Type:
Description:
Set to true to disable the right-click context menu.
Type:
Description:
Disables the automatic creation of the Post FX Pipelines. If disabled, you cannot use the built-in Post FX on Game Objects.
Type:
Description:
Disables the automatic creation of the Pre FX Pipelines. If disabled, you cannot use the built-in Pre FX on Game Objects.
Type:
Description:
Should the game create a div element to act as a DOM Container? Only enable if you're using DOM Element objects. You must provide a parent object if you use this feature.
Type:
Description:
The default pointerEvents attribute set on the DOM Container.
Type:
Description:
Is the Scale Manager allowed to adjust the CSS height property of the parent to be 100%?
Type:
Description:
Let the browser abort creating a WebGL context if it judges performance would be unacceptable.
Type:
Description:
The Frame Rate Configuration object, as parsed by the Timestep class.
Description:
The DOM element that will be sent into full screen mode, or its id. If undefined Phaser will create its own div and insert the canvas into it when entering fullscreen mode.
Type:
Description:
The title of the game.
Type:
Description:
The URL of the game.
Type:
Description:
The version of the game.
Type:
Description:
The distance of the Glow FX (defaults to 10)
Type:
Description:
The quality of the Glow FX (defaults to 0.1)
Type:
Description:
The height of the underlying canvas, in pixels.
Type:
Description:
Don't write the banner line to the console.log. See Phaser.Types.Core.BannerConfig for details of this object.
Type:
Description:
Omit Phaser's name and version from the banner.
Type:
Description:
The number of Pointer objects created by default. In a mouse-only, or non-multi touch game, you can leave this as 1.
Type:
Description:
Enable the Gamepad Plugin. This can be disabled in games that don't need gamepad input.
Type:
Description:
The DOM Target to listen for gamepad events on. Defaults to window if not specified.
Type:
Description:
Enable the Keyboard Plugin. This can be disabled in games that don't need keyboard input.
Type:
Description:
preventDefault will be called on every non-modified key which has a key code in this array. By default, it is empty.
Type:
Description:
The DOM Target to listen for keyboard events on. Defaults to window if not specified.
Type:
Description:
Enable the Mouse Plugin. This can be disabled in games that don't need mouse input.
Type:
Description:
The DOM Target to listen for mouse events on. Defaults to the game canvas if not specified.
Type:
Description:
Should mousedown DOM events have preventDefault called on them?
Type:
Description:
Should mousemove DOM events have preventDefault called on them?
Type:
Description:
Should mouseup DOM events have preventDefault called on them?
Type:
Description:
Should wheel DOM events have preventDefault called on them?
Type:
Description:
The smoothing factor to apply during Pointer movement. See {@link Phaser.Input.Pointer#smoothFactor}.
Type:
Description:
Enable the Touch Plugin. This can be disabled in games that don't need touch input.
Type:
Description:
Should touch events be captured? I.e. have prevent default called on them.
Type:
Description:
The DOM Target to listen for touch events on. Defaults to the game canvas if not specified.
Type:
Description:
Should Phaser listen for input events on the Window? If you disable this, events like 'POINTER_UP_OUTSIDE' will no longer fire.
Type:
Description:
An array of global plugins to be installed.
Type:
Description:
An array of Scene level plugins to be installed.
Type:
Description:
Should the XHR request use async or not?
Type:
Description:
A URL used to resolve paths given to the loader. Example: 'http://labs.phaser.io/assets/'.
Type:
Description:
'anonymous', 'use-credentials', or undefined. If you're not making cross-origin requests, leave this as undefined. See {@link https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes}.
Type:
Description:
Optional load type for image, XHR is default, or HTMLImageElement for a lightweight way.
Type:
Description:
An array of schemes that the Loader considers as being 'local' files. Defaults to: [ 'file://', 'capacitor://' ].
Type:
Description:
Maximum parallel downloads allowed for resources (Default to 32).
Type:
Description:
The number of times to retry a file load if it fails.
Type:
Description:
Optional password for all XHR requests.
Type:
Description:
A URL path used to resolve relative paths given to the loader. Example: 'images/sprites/'.
Type:
Description:
The response type of the XHR request, e.g. blob, text, etc.
Type:
Description:
Optional XHR timeout value, in ms.
Type:
Description:
Optional username for all XHR requests.
Type:
Description:
Optional XHR withCredentials value.
Type:
Description:
The maximum height, in pixels, the canvas will scale up to. A value of zero means no maximum.
Type:
Description:
The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.
Type:
Description:
When in WebGL mode, this sets the maximum number of GPU Textures to use. The default, -1, will use all available units. The WebGL1 spec says all browsers should provide a minimum of 8.
Type:
Description:
The maximum width, in pixels, the canvas will scale up to. A value of zero means no maximum.
Type:
Description:
The minimum height, in pixels, the canvas will scale down to. A value of zero means no minimum.
Type:
Description:
The minimum width, in pixels, the canvas will scale down to. A value of zero means no minimum.
Type:
Description:
Sets the mipmap magFilter to be used when creating WebGL textures. Don't set unless you wish to create mipmaps. Set to one of the following: 'NEAREST', 'LINEAR', 'NEAREST_MIPMAP_NEAREST', 'LINEAR_MIPMAP_NEAREST', 'NEAREST_MIPMAP_LINEAR' or 'LINEAR_MIPMAP_LINEAR'.
Type:
Description:
A base64 encoded PNG that will be used as the default texture when a texture is assigned that is missing or not loaded.
Type:
Description:
A parent DOM element into which the canvas created by the renderer will be injected.
Type:
Description:
The Physics Configuration object.
Description:
An object mapping WebGL names to WebGLPipeline classes. These should be class constructors, not instances.
Description:
Prevent pixel art from becoming blurred when scaled. It will remain crisp (tells the WebGL renderer to automatically create textures using a linear filter mode).
Type:
Description:
A function to run at the end of the boot sequence. At this point, all the game systems have started and plugins have been loaded.
Description:
"high-performance", "low-power" or "default". A hint to the browser on how much device power the game might use.
Type:
Description:
Called before Phaser boots. Useful for initializing anything not related to Phaser that Phaser may require while booting.
Description:
In WebGL mode, sets the drawing buffer to contain colors with pre-multiplied alpha.
Type:
Description:
If the value is true the WebGL buffers will not be cleared and will preserve their values until cleared or overwritten by the author.
Type:
Description:
Force Phaser to use a specific renderer. Can be CONST.CANVAS, CONST.WEBGL, CONST.HEADLESS or CONST.AUTO (default)
Type:
Description:
How many ms should elapse before checking if the browser size has changed?
Type:
Description:
Draw texture-based Game Objects at only whole-integer positions. Game Objects without textures, like Graphics, ignore this property.
Type:
Description:
The scale mode as used by the Scale Manager. The default is zero, which is no scaling.
Description:
The default Scene configuration object.
Type:
Description:
A seed which the Random Data Generator will use. If not given, a dynamic seed based on the time is used.
Type:
Description:
The vertical amount to snap the canvas by when the Scale Manager is resizing. A value of zero means no snapping.
Type:
Description:
The horizontal amount to snap the canvas by when the Scale Manager is resizing. A value of zero means no snapping.
Type:
Description:
false or 0 = Use the built-in StableSort (needed for older browsers), true or 1 = Rely on ES2019 Array.sort being stable (modern browsers only), or -1 = Try and determine this automatically based on browser inspection (not guaranteed to work, errs on side of caution).
Type:
Description:
Whether the game canvas will have a transparent background.
Type:
Description:
A base64 encoded PNG that will be used as the default texture when a texture is assigned that is white or not loaded.
Type:
Description:
The width of the underlying canvas, in pixels.
Type:
Description:
The zoom factor, as used by the Scale Manager.
Type: