API概览

Via: 如果一个类在Via列中有一个条目,就意味着你可以通过本地引用快速访问它。例如,如果游戏已经被全局定义,你可以在任何场景中通过this.camera或者game.camera 来控制相机。

Class Via 说明
Game game 用于管理启动、子系统的创建、逻辑与渲染循环的运行。
World world 游戏世界,所有游戏对象生活于其中。
Camera camera 相机是你面对游戏世界时的视野。
Stage stage 舞台是根显示对象。

游戏场景

Class Via 说明
StateManager state 创建,管理和交换你的游戏场景。
State - 一个基本的游戏场景对象,你可加以扩展。

装载器

Class Via 说明
Cache cache 缓存是存储和检索所有已加载资源的地方。
Loader load 加载所有外部资源类型(图像,音频,json,xml,txt),并将它们添加到缓存。由场景的 preload方法自动调用。
LoaderParser - 一个静态类,给加载器用于处理复杂资源类型的解析。

游戏缩放

Class Via 说明
ScaleManager scale 管理你的游戏在不同设备中的大小和缩放。
FlexGrid scale.grid 自适应布局网格(仍在测试中)
FlexLayer - 自适应网格层(仍在测试中)

信号

Class 说明
Signal 信号是Phaser内部的事件系统。
SignalBinding 管理把哪些回调函数绑定到一个信号。

插件

Class Via 说明
PluginManager plugins 安装,更新和销毁插件。
Plugin - 一个基础的Plugin对象,你可以扩展它。

游戏对象

Class Via 说明
GameObjectFactory add 一个帮助类,可以创建任何Phaser游戏对象,并将其添加到游戏世界。
GameObjectCreator make 一个帮助类,可以创建和返回任何Phaser游戏对象。
Group add.group 组可以包含多个游戏对象,并且能搜索,排序,调用,更新和过滤它们。
InputHandler <object>.input 如果游戏对象开启了输入功能,则这个类控制所有与输入相关的事件,包括点击和拖动。
Events <object>.events 所有游戏对象级别的事件。
Create create 动态的精灵与纹理的生成方法。

显示

Class 说明
Sprite 一个游戏对象,具有纹理、输入事件和物理系统,能够运行动画。
Image 一个更轻的游戏对象,具有纹理和输入,但没有物理系统和动画处理手段。
TileSprite 一个游戏对象,具有重复的纹理,可以滚动和缩放。
Button 一个图像游戏对象,具有辅助的方法和事件以转换为UI按钮。
SpriteBatch 自定义的Sprite批处理。如果多个精灵共享相同的纹理,渲染起来要快得多。
Rope 一个连接而成的游戏对象,具有基于条纹的纹理。

图形

Class 说明
Graphics 图形:允许你绘制原始形状(直线、矩形、圆形),设置颜色,笔画和填充。
BitmapData 位图数据:为空白的画布对象提供强大的界面。可用作精灵的纹理。
RenderTexture 渲染纹理:一种特殊的纹理,使你可以极快地绘制精灵。

文本

Class 说明
Text 使用系统字体或网络字体显示文本,可选填充,阴影和笔触(描边)。
BitmapText 位图文本:一种纹理,基于使用位图字体文件的文本对象。
RetroFont 复古字:与位图文本对象类似,但使用经典精灵表。每个字符都是固定宽度的。

动画

Class Via 说明
AnimationManager sprite.animations 动画管理器:添加、播放和更新精灵游戏对象中的动画。
Animation - 动画:动画管理器创建的基础的游戏对象。
AnimationParser - 动画解析器:供Phaser装载器内部使用,用以外部文件解析动画数据。
FrameData - 帧数据:构成动画的帧对象的集合。
Frame - 动画的单一个帧。存储在帧数据对象内部。

几何

Class 说明
Circle 圆形对象,由位置和直径组成。
Ellipse 椭圆对象,由位置,宽度和高度组成。
Line 直线对象,由直线的起点和末尾的两个点组成。
Point 点对象,由x和y位置组成。
Polygon 多边形对象,由一系列点组成。
Rectangle 方形对象,由x,y,宽和高组成。
RoundedRectangle 圆角方形对象,由x,y,宽,高和角半径组成。

时间

Class Via 说明
Time time 内核时钟,所有与Phaser时间相关的操作都依赖它。
Timer time.create 自定义定时器,包含一个或多个定时事件。可以使用一次或设置为重复。
TimerEvent time.add 关联单个时间的事件对象。从属于一个Phaser定时器。

瓦片地图

Class 说明
Tilemap 瓦片地图由一个或多个瓦片地图层和相关联的瓦片数据组成。包含处理瓦片数据和生成瓦片层的方法。
TilemapLayer 瓦片层:瓦片地图中的单个层。从Phaser精灵扩展而来,负责自身的渲染。
Tileset 瓦片套件:一个对象,包含瓦片层要用于渲染瓦片的纹理和数据。
Tile 单个瓦片对象,具有相关属性。个别瓦片是为地图中的所有瓦片而存在的。
TilemapParser 瓦片地图解析器:一个静态类,用于解析外部加载的地图数据。通常由Phaser.Loader直接调用。

数学

Class Via 说明
Math math 包含许多与数学相关的辅助方法,,包括模糊逻辑和插值。
QuadTree - 四叉树:一个独立的四叉树实现。由Arcade物理系统使用,但也可以直接使用。
RandomDataGenerator rnd 可填入种子的可重复随机数据生成器。

网络

Class Via 说明
Net net 与浏览器URL和请求字符串相关的方法。

粒子

Class Via 说明
Particles particles Phaser粒子管理器。在游戏循环期中调用,会更新所有相关的粒子发射器。
Emitter add.emitter 基于Arcade物理学的粒子发射器。
Particle - 由发射器发射的单个粒子对象。扩展自Phaser精灵。

物理

Class Via 说明
Physics physics 核心物理学管理器。提供对所有物理子系统的访问。

Arcade物理系统

Class Via 说明
Arcade physics.arcade Arcade物理系统处理器。 包含与碰撞、重叠和运动相关的方法。
Body sprite.body Arcade物理体。 包含速度,加速度,阻力等相关属性。
Weapon game.add.weapon Arcade物理学驱动的武器插件,方便子弹池管理。

Ninja物理系统

默认情况下,Ninja物理系统不会在Phaser中绑定。请参阅自述文件,以自定义地构建细节。

Class Via 说明
Ninja physics.ninja Ninja物理系统处理器。 包含碰撞,重叠和运动相关的方法。
Body sprite.body Ninja物理体。包含速度,加速度,阻力等相关属性。
AABB - AABB式Ninja 物理体类型。
Circle - 圆形Ninja 物理体类型。
Tile - 瓷砖式Ninja 物理体类型。

P2物理系统

Class Via 说明
P2 physics.p2 P2物理世界。包含碰撞,重叠和运动相关的方法。
Body sprite.body P2物理体。包含速度,加速度,阻力等相关属性。
BodyDebug - P2物理体中调试用的特定视图(?)。渲染其形状以便视觉调试。
Material - 用于世界做出反应的P2材料,如摩擦和复原。
ContactMaterial - P2接触材料,用于接触反应。
CollisionGroup - P2碰撞组。
FixtureList - P2固定列表处理程器。
Constraints: - Distance Constraint, GearConstraint, LockConstraint, PrismaticConstraint, RevoluteConstraint
PointProxy - 点代理:负责代理Phaser游戏世界传给P2物理系统的值。
InversePointProxy - 反向点代理:负责代理P2物理系统传给Phaser游戏世界的值。
Spring - P2弹簧对象。
RotationalSpring - P2旋转弹簧对象。

输入

Class Via 说明
Input input 输入管理器。负责处理所有输入子系统。还监控开启了输入的游戏对象。
Pointer input.pointer 点封装了所有鼠标或触摸相关的输入,不管它是如何生成的。在多点触控系统上,多个点可以随时激活。在输入相关事件中,会传递对相应点的引用。
DeviceButton pointer.leftButton ,... 设备按键:表示鼠标或笔/手写笔上的按钮。
Keyboard input.keyboard 键盘输入处理器。监听与设备相关的事件。也可以创建Key对象。
Key - 一个键对象负责听特定的键。由Keyboard类创建。
KeyCode - KeyCode常量在创建新的Key对象时要用到。
Mouse input.mouse 鼠标事件处理器。侦听与设备相关的事件并将其传递给活动的Pointer。
MSPointer input.mspointer MSPointer事件处理程序。侦听与设备相关的事件并将其传递给活动的Pointer。
Touch input.touch 触摸事件处理程器。侦听与设备相关的事件并将其传递给活动的Pointer。

游戏手柄

Class Via 说明
Gamepad input.gamepad 游戏手柄管理器监控所有连接到设备的游戏手柄。创建SinglePad实例。
SinglePad input.gamepad.pad <1,4> 代表连接的单个手柄。
DeviceButton - 表示SinglePad实例上的按钮。

补间动画

Class Via 说明
TweenManager tweens 补间动画管理器创建,更新和销毁所有活动的补间动画。
Tween add.tween 补间动画对象。包含TweenData对象——代表补间动画和所有子补间动画。
TweenData - TweenData对象包含与补间动画相关的所有信息。由Phaser.Tween对象创建并控制。
Easing - 一个静态类,包含补间动画可用的所有缓冲功能。

声音

Class Via 说明
SoundManager sound 声音管理器控制所有声音对象,并可以播放,循环,淡化和停止声音。
Sound add.audioadd.sound 一个声音对象。可以直接播放,暂停,停止,调整音量。
AudioSprite add.audioSprite 音频精灵是一个Sound对象,具有表示音频部分的相关标记数据。

系统

Class Via 说明
Canvas - 一个静态类,包含画布创建和操作的方法。如添加到DOM,设置触摸动作,平滑和图像渲染。
Device game.device Device类在启动时检查系统功能和设置,并存储以备以后访问。
DOM - 一个包含DOM特定方法的静态类,包括偏移处理,视口校准和边界检查。
RequestAnimationFrame game.raf 为核心游戏更新循环而抽象RAF或setTimeOut的用法。

工具

Class Via 说明
ArraySet - 数组套装是一个套数据结构(集合中的项目必须是唯一的),它也维护顺序。
ArrayUtils - 数组的特定方法,如getRandomItem,shuffle,transposeMatrix,rotate和numberArray。
Color - Phaser.Color是一组辅助颜色操纵和转换的静态方法。
Debug game.debug 用于显示游戏对象相关调试信息的方法集。
LinkedList - 一个基本的链接列表数据结构。
Utils - 检查、修改对象和字符串的一些实用方法。包括getProperty,pad,isPlainObject,extend和mixin。