构造函数

new Sprite(game, x, y, key, frame)

精灵是游戏的命脉,用于几乎所有的视觉。

参数

名称 类型 参数 默认值 描述
game Phaser.Game 一个参考目前正在运行的游戏。
x number 坐标(在世界空间)位置的精灵。
y number 在世界空间坐标(在世界空间)位置的精灵。
key string | Phaser.RenderTexture | Phaser.BitmapData | PIXI.Texture 这是在渲染过程中所使用的精灵的图像或纹理。它可以是一个字符串,这是一个参考的缓存条目,或实例的一个或pixi.texture RenderTexture。
frame string | number 如果这个精灵是使用一个精灵片或纹理的一部分,你可以通过给一个字符串或数字索引指定确切的帧使用的阿特拉斯。

公共属性

alive : boolean

一个有用的标志来控制,如果游戏对象是活的或死的。

Source code: gameobjects/components/LifeSpan.js (Line 50)

alpha : number

对象的不透明度。

Source code: pixi/display/DisplayObject.js (Line 46)

anchor :Point

锚定纹理的原点点。

Source code: pixi/display/Sprite.js (Line 22)

angle : number

“角”属性是“对象的旋转”,从它的原始方向看。

Source code: gameobjects/components/Angle.js (Line 29)

animations : Phaser.AnimationManager

如果游戏的目的是启用动画(如相位。雪碧)这是一个参考的animationmanager实例。

Source code: gameobjects/components/Core.js (Line 186)

autoCull : boolean

一个<代码> autocull < /代码的游戏对象>设置为true将检查其边界对世界相机每架。

Source code: gameobjects/components/AutoCull.js (Line 28)

blendMode : number

将混合模式应用于精灵。设置pixi.blendmodes.normal删除任何混合模式。

Source code: pixi/display/Sprite.js (Line 87)

body : Phaser.Physics.Arcade.Body | Phaser.Physics.P2.Body | Phaser.Physics.Ninja.Body | null

<代码>身体< /码>是游戏对象物理身体。一旦一个游戏对象被允许物理你访问所有相关的

Source code: gameobjects/components/PhysicsBody.js (Line 91)

[readonly] bottom : number

的和高度的总和。

Source code: gameobjects/components/Bounds.js (Line 110)

cacheAsBitmap : boolean

如果该显示对象被缓存为位图。

Source code: pixi/display/DisplayObject.js (Line 355)

cameraOffset : Phaser.Point

X / Y坐标偏移应用于相机的左上方,这个游戏对象将被绘制在如果<代码> fixedtocamera < /代码>是真的。

Source code: gameobjects/components/FixedToCamera.js (Line 86)

checkWorldBounds : boolean

如果这是设置为<代码>真< /代码>游戏对象检查,如果它是在世界范围内的每一帧。

Source code: gameobjects/components/InWorld.js (Line 92)

[readonly] children : Array.<DisplayObject>

[只读]这个容器的儿童数组。

Source code: pixi/display/DisplayObjectContainer.js (Line 17)

<internal> components : Object

这个游戏对象的组件已经安装了。

Source code: gameobjects/components/Core.js (Line 160)

cropRect : Phaser.Rectangle

用来裁剪纹理的矩形,该游戏对象使用。

Source code: gameobjects/components/Crop.js (Line 24)

damage

损害游戏对象。这从<代码>健康>属性中移除给定的健康量。

Source code: gameobjects/components/Health.js (Line 46)

debug : boolean

调试标志设计使用<代码>游戏。enablestep

Source code: gameobjects/components/Core.js (Line 211)

[readonly] deltaX : number

返回增量值。世界之间的差异,现在和以前的帧。

Source code: gameobjects/components/Delta.js (Line 24)

[readonly] deltaY : number

返回三角洲。世界的不同,现在和以前的帧。

Source code: gameobjects/components/Delta.js (Line 42)

[readonly] deltaZ : number

返回三角洲。之间的差异,现在和以前的帧。三角洲值。

Source code: gameobjects/components/Delta.js (Line 58)

[readonly] destroyPhase : boolean

作为一个游戏对象运行通过它的破坏方法,该标志设置为真,

Source code: gameobjects/components/Destroy.js (Line 22)

events : Phaser.Events

所有的相位器的游戏对象有一个事件类,包含所有被派出当某些事情发生在这事件

Source code: gameobjects/components/Core.js (Line 178)

exists : boolean

控制如果这个游戏对象被核心游戏循环处理。

Source code: gameobjects/components/Core.js (Line 277)

filterArea :Rectangle

该地区的滤波器应用于像hitarea这是作为更大的优化

Source code: pixi/display/DisplayObject.js (Line 164)

filters : Array.<Filter>

设置DisplayObject过滤器。

Source code: pixi/display/DisplayObject.js (Line 307)

fixedToCamera : boolean

一个游戏对象,是“固定”的相机使用它的X-坐标作为偏移量从相机的左上角渲染。

Source code: gameobjects/components/FixedToCamera.js (Line 56)

frame : integer

获取或设置用于渲染该游戏对象的纹理的当前帧索引。

Source code: gameobjects/components/LoadTexture.js (Line 242)

frameName : string

获取或设置用于渲染该游戏对象的纹理的当前帧名称。

Source code: gameobjects/components/LoadTexture.js (Line 267)

[readonly] fresh : boolean

一个游戏对象是否已经创建或复位和还没有渲染变换更新认为<代码>新鲜< /代码>。

Source code: gameobjects/components/Core.js (Line 241)

game : Phaser.Game

一个参考目前正在运行的游戏。

Source code: gameobjects/components/Core.js (Line 145)

heal

治愈游戏对象。这增加了一定量的健康的<代码>健康< /代码>属性。

Source code: gameobjects/components/Health.js (Line 90)

health : number

游戏对象的健康价值。这是一个方便的属性设置和操作的游戏对象的健康。

Source code: gameobjects/components/Health.js (Line 26)

height : number

精灵的高度,设置此值实际上将修改以实现值集的刻度

Source code: pixi/display/Sprite.js (Line 139)

hitArea :Rectangle | Circle | Ellipse | Polygon

这是定义的区域,将拿起鼠标/触摸事件。默认情况下是空的。

Source code: pixi/display/DisplayObject.js (Line 62)

[readonly] inCamera : boolean

检查游戏对象的界限是否与游戏相机界限相交。

Source code: gameobjects/components/AutoCull.js (Line 37)

input : Phaser.InputHandler | null

这个游戏对象的输入处理程序。

Source code: gameobjects/components/InputEnabled.js (Line 24)

inputEnabled : boolean

默认情况下一个游戏对象不会处理任何输入事件。通过设置<代码> inputenabled < /代码>真正创建一phaser.inputhandler

Source code: gameobjects/components/InputEnabled.js (Line 38)

[readonly] inWorld : boolean

检查游戏对象的范围是否在,或与游戏世界范围内的任何点相交。

Source code: gameobjects/components/InWorld.js (Line 114)

key : string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture

本游戏对象在渲染过程中所使用的图像或纹理的关键。

Source code: gameobjects/components/Core.js (Line 196)

[readonly] left : number

游戏对象的左坐标。

Source code: gameobjects/components/Bounds.js (Line 59)

lifespan : number

寿命可以让你以毫秒为单位给一个游戏对象的生命周期。

Source code: gameobjects/components/LifeSpan.js (Line 65)

mask : PIXI.Graphics

设置一个DisplayObject的面具。一个面具是一个对象,限制了一个对象的可见性,应用到它的形状。

Source code: pixi/display/DisplayObject.js (Line 282)

maxHealth : number

游戏对象最大的健康值。这与<<规范>>、<<痊愈>>、<<方法>>相结合,确保了

Source code: gameobjects/components/Health.js (Line 35)

name : string

给定此游戏对象的用户定义的名称。

Source code: gameobjects/components/Core.js (Line 153)

[readonly] offsetX : number

游戏对象的数量在视觉上从它的坐标系中偏移。

Source code: gameobjects/components/Bounds.js (Line 24)

[readonly] offsetY : number

游戏对象的数量在视觉上从它的坐标系中偏移。

Source code: gameobjects/components/Bounds.js (Line 42)

outOfBoundsKill : boolean

如果这和<代码> checkworldbounds < /代码>属性都设置为<代码>真的< /代码>然后<密码>杀< /代码>方法是呼吁尽快<代码>中< /代码>返回false。

Source code: gameobjects/components/InWorld.js (Line 100)

[readonly] parent : PIXI.DisplayObjectContainer

[只读]包含该显示对象的显示对象容器。

Source code: pixi/display/DisplayObject.js (Line 79)

pendingDestroy : boolean

游戏对象是pendingdestroy标记有其破坏的方法称为第二逻辑更新。

Source code: gameobjects/components/Core.js (Line 252)

[readonly] physicsType : number

这个对象的const物理身体类型。

Source code: gameobjects/Sprite.js (Line 61)

pivot :Point

它围绕DisplayObject的支点

Source code: pixi/display/DisplayObject.js (Line 30)

position :Point

对象的坐标相对于父的局部坐标。

Source code: pixi/display/DisplayObject.js (Line 14)

[readonly] previousPosition : Phaser.Point

游戏对象定位于前一帧。

Source code: gameobjects/components/Core.js (Line 218)

[readonly] previousRotation : number

游戏对象在前一帧中的旋转。值为弧度。

Source code: gameobjects/components/Core.js (Line 225)

renderable : boolean

这个对象可以呈现

Source code: pixi/display/DisplayObject.js (Line 71)

[readonly] renderOrderID : number

渲染顺序ID由渲染器和输入管理器内部使用,不应修改。

Source code: gameobjects/components/Core.js (Line 233)

[readonly] right : number

游戏对象的权利坐标。

Source code: gameobjects/components/Bounds.js (Line 76)

rotation : number

弧度旋转的对象。

Source code: pixi/display/DisplayObject.js (Line 38)

scale :Point

对象的比例因子。

Source code: pixi/display/DisplayObject.js (Line 22)

scaleMax : Phaser.Point

最大规模的游戏对象将扩展到。

Source code: gameobjects/components/ScaleMinMax.js (Line 46)

scaleMin : Phaser.Point

这个游戏对象的最小规模将缩小到。

Source code: gameobjects/components/ScaleMinMax.js (Line 36)

setHealth

将游戏对象的健康属性设置为给定的量。

Source code: gameobjects/components/Health.js (Line 70)

shader : PIXI.AbstractFilter

将用来渲染纹理到舞台的着色。设置为空删除当前的着色。

Source code: pixi/display/Sprite.js (Line 98)

smoothed : boolean

启用或禁用此游戏对象的纹理平滑。

Source code: gameobjects/components/Smoothed.js (Line 25)

[readonly] stage :Stage

显示对象是连接到或未定义的阶段,如果它没有连接到舞台上。

Source code: pixi/display/DisplayObject.js (Line 88)

texture : PIXI.Texture

精灵使用的纹理

Source code: pixi/display/Sprite.js (Line 33)

tint : number

色彩应用于雪碧。这是一个十六进制值。一个价值0xffffff将删除任何色彩的影响。

Source code: pixi/display/Sprite.js (Line 59)

tintedTexture :Canvas

帆布包含着色版的雪碧(在画布模式,WebGL不填充此)

Source code: pixi/display/Sprite.js (Line 78)

[readonly] top : number

游戏对象的坐标。

Source code: gameobjects/components/Bounds.js (Line 93)

transformCallback : Function

回调,将适用于任何规模限制的worldtransform。

Source code: gameobjects/components/ScaleMinMax.js (Line 20)

transformCallbackContext : Object

的背景下,<代码> transformcallback < /代码>被称为。

Source code: gameobjects/components/ScaleMinMax.js (Line 26)

[readonly] type : number

这个对象的const类型。

Source code: gameobjects/Sprite.js (Line 55)

visible : boolean

对象的可见性。

Source code: pixi/display/DisplayObject.js (Line 54)

width : number

的精灵的宽度,设置,这将实际上修改的规模,以实现价值集

Source code: pixi/display/Sprite.js (Line 120)

world : Phaser.Point

这个游戏对象的世界坐标像素。

Source code: gameobjects/components/Core.js (Line 204)

[readonly] worldAlpha : number

【只读】乘以αDisplayObject

Source code: pixi/display/DisplayObject.js (Line 97)

[readonly] worldPosition :Point

基于世界变换的显示对象的位置。

Source code: pixi/display/DisplayObject.js (Line 116)

[readonly] worldRotation : number

弧度的显示对象,旋转,基于世界变换。

Source code: pixi/display/DisplayObject.js (Line 136)

[readonly] worldScale :Point

基于世界变换的显示对象的规模。

Source code: pixi/display/DisplayObject.js (Line 126)

worldVisible : boolean

[只读]表示,如果精灵是全局可见的。

Source code: pixi/display/DisplayObject.js (Line 258)

x : number

位置DisplayObject在X轴相对于父局部坐标。

Source code: pixi/display/DisplayObject.js (Line 723)

y : number

的DisplayObject在Y轴上的位置相对于父局部坐标。

Source code: pixi/display/DisplayObject.js (Line 741)

[readonly] z : number

该游戏对象在其母组中的深度。

Source code: gameobjects/components/Core.js (Line 170)

公共方法

addChild(child) → {PIXI.DisplayObject}

向容器中添加一个儿童。

参数

名称 类型 参数 默认值 描述
child PIXI.DisplayObject

DisplayObject添加到容器

Source code: pixi/display/DisplayObjectContainer.js (Line 91)


addChildAt(child, index) → {PIXI.DisplayObject}

在指定索引处为容器添加一个儿童。如果该索引是不可能的,将抛出一个错误

参数

名称 类型 参数 默认值 描述
child PIXI.DisplayObject 孩子要加上“”
index Number 在<< /对>>中的儿童

Source code: pixi/display/DisplayObjectContainer.js (Line 103)


bringToTop() → {PIXI.DisplayObject}

把这个游戏对象的顶部,其父母的显示列表。

Source code: gameobjects/components/BringToTop.js (Line 24)


crop(rect, copy)

作物让你可以裁剪纹理来显示这个游戏对象。

参数

名称 类型 参数 默认值 描述
rect Phaser.Rectangle 在裁剪时使用的矩形。通过空或没有参数来清除先前设置的作物矩形。
copy boolean <optional>
false

如果假<代码> croprect < /代码>将存储作为参考给定的矩形。如果真的可以复制正确的值存储在croprect局部相位矩形对象。

Source code: gameobjects/components/Crop.js (Line 49)


destroy()

摧毁这个DisplayObject。

Source code: pixi/display/DisplayObject.js (Line 223)


generateTexture(resolution, scaleMode, renderer) → {PIXI.Texture}

有用的函数,返回一个纹理的DisplayObject对象可以用来创建精灵

参数

名称 类型 参数 默认值 描述
resolution Number “生成的纹理的分辨率”
scaleMode Number

看到{ { #交联";Pixi / scalemodes:财产";} } Pixi。scalemodes { { } } /交联的可能值

renderer PIXI.CanvasRenderer | PIXI.WebGLRenderer

用于生成纹理渲染。

Source code: pixi/display/DisplayObject.js (Line 542)


getBounds(matrix) → {Rectangle}

返回精灵作为一个矩形的边界。边界计算要考虑的worldtransform。

参数

名称 类型 参数 默认值 描述
matrix Matrix <精灵>的转换矩阵>

Source code: pixi/display/Sprite.js (Line 193)


getChildAt(index) → {PIXI.DisplayObject}

返回指定索引处的儿童

参数

名称 类型 参数 默认值 描述
index Number 以“指数”的指标来得到孩子的

Source code: pixi/display/DisplayObjectContainer.js (Line 194)


getChildIndex(child) → {Number}

返回一个孩子DisplayObject实例的索引位置

参数

名称 类型 参数 默认值 描述
child PIXI.DisplayObject

DisplayObject实例识别

Source code: pixi/display/DisplayObjectContainer.js (Line 159)


getLocalBounds() → {Rectangle}

检索的displayobjectcontainer非局部边界为矩形。计算考虑了所有可见的孩子。

Source code: pixi/display/DisplayObjectContainer.js (Line 367)


kill() → {PIXI.DisplayObject}

杀死一个游戏对象。一个被杀的游戏对象有它的<代码>活着的< /代码>,<代码>存在< /代码>和<代码>可见的< /码>属性都设置为假。

Source code: gameobjects/components/LifeSpan.js (Line 113)


loadTexture(key, frame, stopAnimation)

改变游戏对象的基础结构。旧的纹理被删除,新的一个被引用或从缓存中获取。

参数

名称 类型 参数 默认值 描述
key string | Phaser.RenderTexture | Phaser.BitmapData | Phaser.Video | PIXI.Texture 这是在渲染过程中所使用的精灵所使用的图像或纹理。它可以是一个字符串,这是一个参考的图片缓存条目,或一个RenderTexture,BitmapData,视频或Pixi。纹理。

frame string | number <optional>
如果这个精灵是使用精灵片或纹理的一部分,你可以通过给一个字符串或数字索引指定确切的帧来使用。”
stopAnimation boolean <optional>
true 如果一个动画已经在这个精灵上播放,你可以选择停止它,或者让它继续玩。

Source code: gameobjects/components/LoadTexture.js (Line 49)


moveDown() → {PIXI.DisplayObject}

将此游戏对象移动到其父母显示列表中的一个位置。

Source code: gameobjects/components/BringToTop.js (Line 87)


moveUp() → {PIXI.DisplayObject}

将此游戏对象移到其父母显示列表中的一个位置。

Source code: gameobjects/components/BringToTop.js (Line 66)


overlap(displayObject) → {boolean}

检查该游戏对象的边界是否与给定的显示对象的边界重叠,

参数

名称 类型 参数 默认值 描述
displayObject Phaser.Sprite | Phaser.Image | Phaser.TileSprite | Phaser.Button | PIXI.DisplayObject “显示对象要检查。”

Source code: gameobjects/components/Overlap.js (Line 29)


play(name, frameRate, loop, killOnComplete) → {Phaser.Animation}

扮演一个动画。

参数

名称 类型 参数 默认值 描述
name string 要发挥的动画名称,如“火”,“火”,“走”,“”,“跳”;。一定是以前创建的通过“animationmanager。添加'。

frameRate number <optional>
null

帧率播放动画。每秒的速度是按帧的。如果不提供预先设定的帧率的动画使用。

loop boolean <optional>
false

的动画循环播放后。如果没有提供先前设置的动画的循环值,则使用。

killOnComplete boolean <optional>
false 当动画完成时,如果设置为真(仅当循环=假)父精灵将被杀死。

Source code: gameobjects/components/Animation.js (Line 31)


<internal> postUpdate()

内部调用的方法个周期的世界。

Source code: gameobjects/components/Core.js (Line 331)


preUpdate() → {boolean}

通过world.preupdate自动调用。

Source code: gameobjects/Sprite.js (Line 107)


removeChild(child) → {PIXI.DisplayObject}

从容器中移除一个孩子。

参数

名称 类型 参数 默认值 描述
child PIXI.DisplayObject

DisplayObject去除

Source code: pixi/display/DisplayObjectContainer.js (Line 211)


removeChildAt(index) → {PIXI.DisplayObject}

从指定索引位置删除子。

参数

名称 类型 参数 默认值 描述
index Number 以“指数”的指标来得到孩子的

Source code: pixi/display/DisplayObjectContainer.js (Line 226)


removeChildren(beginIndex, endIndex)

从这个容器中移除所有在开始和结束索引中的所有儿童。

参数

名称 类型 参数 默认值 描述
beginIndex Number <起始位置。默认值为0。
endIndex Number <“结束位置”。默认值是容器的大小。

Source code: pixi/display/DisplayObjectContainer.js (Line 244)


removeStageReference()

从容器和所有的儿童中删除当前阶段引用。

Source code: pixi/display/DisplayObjectContainer.js (Line 407)


reset(x, y, health) → {PIXI.DisplayObject}

重置游戏对象。

参数

名称 类型 参数 默认值 描述
x number 在世界空间中的坐标(在世界空间中)定位游戏对象。
y number 在世界空间中,坐标(在世界空间)的位置,在游戏对象的位置。
health number <optional>
1 如果有健康的成分,则给游戏对象提供健康的身体。

Source code: gameobjects/components/Reset.js (Line 30)


resetFrame()

重置纹理帧尺寸,游戏对象使用的渲染。

Source code: gameobjects/components/LoadTexture.js (Line 220)


resizeFrame(parent, width, height)

调整框架尺寸,游戏对象使用的渲染。

参数

名称 类型 参数 默认值 描述
parent object

导致调整父纹理对象,即相位。视频对象。

width integer “纹理的新宽度”。
height integer “新高度的质地。”

Source code: gameobjects/components/LoadTexture.js (Line 208)


revive(health) → {PIXI.DisplayObject}

将一个'死亡'的游戏对象重新回到生活中,选择重置其在过程中的健康价值。

参数

名称 类型 参数 默认值 描述
health number <optional>
100 给游戏对象的健康。只是如果对象有健康的组成部分。

Source code: gameobjects/components/LifeSpan.js (Line 78)


sendToBack() → {PIXI.DisplayObject}

将此游戏对象发送到其父母显示列表的底部。

Source code: gameobjects/components/BringToTop.js (Line 45)


setChildIndex(child, index)

改变显示对象容器中存在的子位置的位置

参数

名称 类型 参数 默认值 描述
child PIXI.DisplayObject

孩子DisplayObject实例为你想改变指数

index Number 儿童显示对象的索引编号为< /

Source code: pixi/display/DisplayObjectContainer.js (Line 176)


setFrame(frame)

设置纹理帧的游戏对象用于渲染。

参数

名称 类型 参数 默认值 描述
frame Phaser.Frame 按纹理所使用的帧的帧。

Source code: gameobjects/components/LoadTexture.js (Line 143)


setScaleMinMax(minX, minY, maxX, maxY)

集scalemin和scalemax值。这些值被用来限制该游戏对象将以其母公司为基础的规模。

参数

名称 类型 参数 默认值 描述
minX number | null 该游戏对象的最小水平刻度值可以缩小到。
minY number | null 该游戏对象的最小垂直刻度值可以缩小到。
maxX number | null 该游戏对象的最大横向规模值可以扩展到。
maxY number | null 该游戏对象的最大垂直刻度值可以扩展到。

Source code: gameobjects/components/ScaleMinMax.js (Line 110)


setStageReference(stage)

设置容器级引用。这是这个对象,以及所有的孩子,都连接到。

参数

名称 类型 参数 默认值 描述
stage Stage 在容器将作为其当前阶段引用的阶段

Source code: pixi/display/DisplayObjectContainer.js (Line 391)


setTexture(texture, destroy)

设置精灵的纹理。警告说,这并没有删除或破坏以前

参数

名称 类型 参数 默认值 描述
texture PIXI.Texture

Pixi的纹理是由雪碧

destroy Boolean <optional>
false

叫texture.destroy当前纹理在更换新的吗?< /对

Source code: pixi/display/Sprite.js (Line 158)


swapChildren(child, child2)

交换2显示对象在这个容器内的位置。

参数

名称 类型 参数 默认值 描述
child PIXI.DisplayObject < < / >
child2 PIXI.DisplayObject < < / >

Source code: pixi/display/DisplayObjectContainer.js (Line 134)


toGlobal(position) → {Point}

计算显示对象的全局位置

参数

名称 类型 参数 默认值 描述
position Point <世界起源地计算从< / <

Source code: pixi/display/DisplayObject.js (Line 576)


toLocal(position, from) → {Point}

计算显示对象相对于另一点的局部位置

参数

名称 类型 参数 默认值 描述
position Point <世界起源地计算从< / <
from PIXI.DisplayObject <optional>

DisplayObject计算从

Source code: pixi/display/DisplayObject.js (Line 590)


update()

重写此方法在您自己的自定义对象来处理任何更新要求。

Source code: gameobjects/components/Core.js (Line 321)


updateCache()

生成并更新该对象的缓存精灵。

Source code: pixi/display/DisplayObject.js (Line 566)


updateCrop()

如果你已经拥有一个作物矩形这个游戏对象通过<代码> < /代码>和作物自修改代码> < croprect < /代码>属性,

Source code: gameobjects/components/Crop.js (Line 86)