Core

Core

Type Definitions

AudioConfig

Since:
  • 3.0.0
See:
  • Phaser.Sound.SoundManagerCreator
Properties:
Name Type Attributes Default Description
disableWebAudio boolean <optional>
false 用HTML5音频代替Web音频.
context AudioContext <optional>
现有的网络音频上下文.
noAudio boolean <optional>
false 禁用所有音频输出.
包含各种声音设置的.
Type:
  • object

BannerConfig

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
hidePhaser boolean <optional>
false 从横幅中省略相位器的名称和版本.
text string <optional>
'#ffffff' 横幅文本的颜色.
background Array.<string> <optional>
横幅的背景颜色.
Type:
  • object

BootCallback(game)

Since:
  • 3.0.0
Parameters:
Name Type Description
game Phaser.Game The game.

CallbacksConfig

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
preBoot Phaser.Types.Core.BootCallback <optional>
Phaser.Types.Core.NOOP 在启动序列开始时运行的函数.
postBoot Phaser.Types.Core.BootCallback <optional>
Phaser.Types.Core.NOOP 在引导序列结束时运行的函数.至此,所有游戏系统已经启动,外挂已经加载.
Type:
  • object

DOMContainerConfig

Since:
  • 3.12.0
Properties:
Name Type Attributes Default Description
createContainer boolean <optional>
false 游戏应该创建一个div元素来充当DOM容器吗?仅当您正在使用DOM元素对象时才启用.如果使用此功能,必须提供父对象.
behindCanvas boolean <optional>
false 创建的DOM容器(如果 `dom.createcontainer` 为真)应该放在游戏画布的后面(真)还是上面(假,默认)?
pointerEvents string <optional>
'none' The default `pointerEvents` attribute set on the DOM Container.
Type:
  • object

FPSConfig

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
min number <optional>
5 最低可接受的渲染速率,以每秒帧数为单位.
target number <optional>
60 最佳渲染速率,以每秒帧数为单位.这并不强制fps的速度,它只是告诉Phaser什么速度被认为是这个游戏的最佳速度.
forceSetTimeOut boolean <optional>
false 用setTimeout代替requestAnimationFrame运行游戏循环.
deltaHistory number <optional>
10 根据这许多连续的帧间隔计算平均帧增量.
panicMax number <optional>
120 在我们再次信任增量值之前,时间步长计数的帧数.
smoothStep boolean <optional>
true 在游戏更新期间应用增量平滑来帮助避免峰值?
Type:
  • object

GameConfig

Since:
  • 3.0.0
Properties:
Name Type Attributes Default Description
width number | string <optional>
1024 游戏的宽度,以游戏像素为单位.
height number | string <optional>
768 游戏的高度,以游戏像素为单位.
zoom number <optional>
1 应用于游戏画布的简单缩放.2是两倍大小,0.5是一半大小,等等.
type number <optional>
CONST.AUTO 要使用哪个渲染器.相位器.自动,相位器.CANVAS,Phaser.无头,或Phaser.WEBGL.如果可用,自动选择WEBGL,否则选择CANVAS.
parent HTMLElement | string <optional>
将包含游戏画布的DOM元素,或者它的 `id` .如果未定义,或者如果命名元素不存在,游戏画布将附加到文档正文.如果 `null` 将不会使用父级,您负责将画布添加到dom中.
canvas HTMLCanvasElement <optional>
null 提供你自己的画布元素供Phaser使用,而不是创建一个.
canvasStyle string <optional>
null 应用于游戏画布的CSS样式,而不是Phasers的默认样式.
customEnvironment boolean <optional>
false Phaser是在自定义(非原生web)环境下运行的吗?如果是,将此设置为 `true` 以跳过内部特征检测.如果 `true` ,则 `renderType` 不能保留为 `AUTO` .
context CanvasRenderingContext2D <optional>
提供你自己的画布上下文供Phaser使用,而不是创建一个.
scene Phaser.Scene | Array.<Phaser.Scene> | Phaser.Types.Scenes.SettingsConfig | Array.<Phaser.Types.Scenes.SettingsConfig> | Phaser.Types.Scenes.CreateSceneFromObjectConfig | Array.<Phaser.Types.Scenes.CreateSceneFromObjectConfig> | function | Array.<function()> <optional>
null 添加到游戏中的一个或多个场景.给几个的话,第一个开始;其余的只有在它们具有 `{ active: true }` 时才会启动.请参见 `zPhaser.scene.scene manager # add` `中的 `sceneConfig` 参数.
seed Array.<string> <optional>
随机数生成器的种子.
title string <optional>
'' 游戏的标题.显示在浏览器控制台中.
url string <optional>
'https://phaser.io' 游戏的URL.显示在浏览器控制台中.
version string <optional>
'' 游戏的版本.显示在浏览器控制台中.
autoFocus boolean <optional>
true 游戏启动时自动调用window.focus().如果游戏在单独的框架中,通常需要捕捉输入事件.
input boolean | Phaser.Types.Core.InputConfig <optional>
输入配置,或 `false` 禁用所有游戏输入.
disableContextMenu boolean <optional>
false 禁用浏览器的默认 `contextmenu` 事件(通常由鼠标右键单击触发).
banner boolean | Phaser.Types.Core.BannerConfig <optional>
false 游戏开始时在浏览器控制台中打印的横幅的配置.
dom Phaser.Types.Core.DOMContainerConfig <optional>
DOM容器配置对象.
fps Phaser.Types.Core.FPSConfig <optional>
游戏循环配置.
render Phaser.Types.Core.RenderConfig <optional>
游戏渲染器配置.
callbacks Phaser.Types.Core.CallbacksConfig <optional>
在游戏启动之前或之后运行的可选回调.
loader Phaser.Types.Core.LoaderConfig <optional>
装载机配置.
images Phaser.Types.Core.ImagesConfig <optional>
图像配置.
physics Phaser.Types.Core.PhysicsConfig <optional>
物理配置.
plugins Phaser.Types.Core.PluginObject | Array.<Phaser.Types.Core.PluginObjectItem> <optional>
要安装的插件.
scale Phaser.Types.Core.ScaleConfig <optional>
秤管理器配置.
audio Phaser.Types.Core.AudioConfig <optional>
音频配置对象.
pipeline Phaser.Types.Core.PipelineConfig <optional>
网络总帐管道配置对象.也可以是 `RenderConfig` 的一部分.
backgroundColor string | number <optional>
0x000000 游戏画布的背景颜色.默认为黑色.
antialias boolean <optional>
true 当设置为 `true` 时,WebGL使用线性插值来绘制缩放或旋转的纹理,给出平滑的外观.当设置为 `false` 时,WebGL使用最近邻插值,给出更清晰的外观.当游戏画布被缩放时,如果浏览器支持的话, `false` 也禁用游戏画布本身的抗锯齿.
antialiasGL boolean <optional>
true 创建WebGL上下文时,设置 `antialias` 属性.设置此值不会影响任何后续创建的纹理或画布样式属性.
desynchronized boolean <optional>
false 当设置为 `true` 时,它将为2D和WebGL创建一个不同步的上下文.详见https://developers.Google.com/web/updates/2019/05/de synchronized.
pixelArt boolean <optional>
false 将 `antialias` 设置为false,将 `roundPixels` 设置为true.这是像素艺术游戏的最佳设置.
roundPixels boolean <optional>
false 仅在整数位置绘制基于纹理的游戏对象.没有纹理的游戏对象,像图形,忽略这个属性.
transparent boolean <optional>
false 游戏画布是否会透明.布尔值,指示画布是否包含alpha通道.如果设置为false,浏览器现在知道背景总是不透明的,这可以加快透明内容和图像的绘制速度.
clearBeforeRender boolean <optional>
true 每个渲染帧之间是否会清空游戏画布.
preserveDrawingBuffer boolean <optional>
false 如果该值为真,WebGL缓冲区将不会被清除,并将保留其值,直到被作者清除或覆盖.
premultipliedAlpha boolean <optional>
true 在WebGL模式下,绘图缓冲区包含带有预乘alpha的颜色.
failIfMajorPerformanceCaveat boolean <optional>
false 如果浏览器判断性能不可接受,就让它中止创建WebGL上下文.
powerPreference string <optional>
'default'