Class: Config

Phaser.Boot. Config

The active game configuration settings, parsed from a GameConfig object.


new Config( [GameConfig])

Parameters:
Name Type Argument Description
GameConfig GameConfig <optional>

The configuration object for your Phaser Game instance.

Since: 3.0.0
Source: src/boot/Config.js (Line 219)
See:

Members


<constant> antialias :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 505)

<constant> audio :any

[description]

Type:
  • any
Source: src/boot/Config.js (Line 450)

<constant> autoFocus :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 371)

<constant> autoResize :boolean

Automatically resize the Game Canvas if you resize the renderer.

Type:
  • boolean
Source: src/boot/Config.js (Line 500)

<constant> backgroundColor :Phaser.Display.Color

[description]

Type:
Source: src/boot/Config.js (Line 568)

<constant> bannerBackgroundColor :Array.<string>

[description]

Type:
  • Array.<string>
Source: src/boot/Config.js (Line 472)

<constant> bannerTextColor :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 467)

<constant> batchSize :integer

The default WebGL Batch size.

Type:
  • integer
Source: src/boot/Config.js (Line 556)

<constant, nullable> canvas :HTMLCanvasElement

Force Phaser to use your own Canvas element instead of creating one.

Type:
  • HTMLCanvasElement
Source: src/boot/Config.js (Line 329)

<constant, nullable> canvasStyle :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 339)

<constant> clearBeforeRender :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 531)

<constant, nullable> context :CanvasRenderingContext2D|WebGLRenderingContext

Force Phaser to use your own Canvas context instead of creating one.

Type:
  • CanvasRenderingContext2D | WebGLRenderingContext
Source: src/boot/Config.js (Line 334)

<constant> defaultImage :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 719)

<constant> defaultPhysicsSystem :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 603)

<constant> defaultPlugins :any

The plugins installed into every Scene (in addition to CoreScene and Global).

Type:
  • any
Source: src/boot/Config.js (Line 711)

<constant> disableContextMenu :boolean

Set to true to disable context menu. Default value is false.

Type:
  • boolean
Source: src/boot/Config.js (Line 445)

<constant, nullable> domBehindCanvas :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 383)

<constant, nullable> domCreateContainer :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 378)

<constant> expandParent :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 280)

<constant> failIfMajorPerformanceCaveat :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 546)

<constant, nullable> fps :FPSConfig

[description]

Type:
Source: src/boot/Config.js (Line 490)

<constant> gameTitle :string

The title of the game.

Type:
  • string
Source: src/boot/Config.js (Line 356)

<constant> gameURL :string

The URL of the game.

Type:
  • string
Source: src/boot/Config.js (Line 361)

<constant> gameVersion :string

The version of the game.

Type:
  • string
Source: src/boot/Config.js (Line 366)

<constant> height :integer|string

[description]

Type:
  • integer | string
Source: src/boot/Config.js (Line 255)

<constant> hideBanner :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 457)

<constant> hidePhaser :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 462)

<constant> inputActivePointers :integer

[description]

Type:
  • integer
Source: src/boot/Config.js (Line 430)

<constant> inputGamepad :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 435)

<constant> inputGamepadEventTarget :*

[description]

Type:
  • *
Source: src/boot/Config.js (Line 440)

<constant> inputKeyboard :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 390)

<constant> inputKeyboardEventTarget :*

[description]

Type:
  • *
Source: src/boot/Config.js (Line 395)

<constant> inputMouse :boolean|object

[description]

Type:
  • boolean | object
Source: src/boot/Config.js (Line 400)

<constant> inputMouseCapture :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 410)

<constant, nullable> inputMouseEventTarget :*

[description]

Type:
  • *
Source: src/boot/Config.js (Line 405)

<constant> inputTouch :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 415)

<constant> inputTouchCapture :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 425)

<constant, nullable> inputTouchEventTarget :*

[description]

Type:
  • *
Source: src/boot/Config.js (Line 420)

<constant> installGlobalPlugins :any

[description]

Type:
  • any
Source: src/boot/Config.js (Line 675)

<constant> installScenePlugins :any

[description]

Type:
  • any
Source: src/boot/Config.js (Line 680)

<constant> loaderAsync :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 635)

<constant> loaderBaseURL :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 610)

<constant> loaderCrossOrigin :string|undefined

[description]

Type:
  • string | undefined
Source: src/boot/Config.js (Line 625)

<constant> loaderMaxParallelDownloads :integer

Maximum parallel downloads allowed for resources (Default to 32).

Type:
  • integer
Source: src/boot/Config.js (Line 620)

<constant> loaderPassword :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 645)

<constant> loaderPath :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 615)

<constant> loaderResponseType :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 630)

<constant> loaderTimeout :integer

[description]

Type:
  • integer
Source: src/boot/Config.js (Line 650)

<constant> loaderUser :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 640)

<constant> maxHeight :integer

[description]

Type:
  • integer
Source: src/boot/Config.js (Line 300)

<constant> maxLights :integer

The maximum number of lights allowed to be visible within range of a single Camera in the LightManager.

Type:
  • integer
Source: src/boot/Config.js (Line 561)

<constant> maxWidth :integer

[description]

Type:
  • integer
Source: src/boot/Config.js (Line 290)

<constant> minHeight :integer

[description]

Type:
  • integer
Source: src/boot/Config.js (Line 295)

<constant> minWidth :integer

[description]

Type:
  • integer
Source: src/boot/Config.js (Line 285)

<constant> missingImage :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 724)

<constant, nullable> parent :*

[description]

Type:
  • *
Source: src/boot/Config.js (Line 270)

<constant> physics :object

[description]

Type:
  • object
Source: src/boot/Config.js (Line 598)

<constant> pixelArt :boolean

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:
  • boolean
Source: src/boot/Config.js (Line 515)

<constant> postBoot :BootCallback

[description]

Type:
Source: src/boot/Config.js (Line 585)

<constant> powerPreference :string

[description]

Type:
  • string
Source: src/boot/Config.js (Line 551)

<constant> preBoot :BootCallback

[description]

Type:
Source: src/boot/Config.js (Line 580)

<constant> premultipliedAlpha :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 536)

<constant> preserveDrawingBuffer :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 541)

<constant> renderType :number

Force Phaser to use a specific renderer. Can be CONST.CANVAS, CONST.WEBGL, CONST.HEADLESS or CONST.AUTO (default)

Type:
  • number
Source: src/boot/Config.js (Line 324)

<constant> resolution :number

[description]

Type:
  • number
Source: src/boot/Config.js (Line 265)

<constant> roundPixels :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 510)

<constant> scaleMode :integer

[description]

Type:
  • integer
Source: src/boot/Config.js (Line 275)

<constant, nullable> sceneConfig :object

[description]

Type:
  • object
Source: src/boot/Config.js (Line 344)

<constant> seed :Array.<string>

[description]

Type:
  • Array.<string>
Source: src/boot/Config.js (Line 349)

<constant> transparent :boolean

[description]

Type:
  • boolean
Source: src/boot/Config.js (Line 526)

<constant> width :integer|string

[description]

Type:
  • integer | string
Source: src/boot/Config.js (Line 250)

<constant> zoom :number

[description]

Type:
  • number
Source: src/boot/Config.js (Line 260)