TextureCrop

.GameObjects.Components. TextureCrop

Since:
  • 3.0.0
提供用于获取和设置游戏对象纹理的方法.

Members

frame :Phaser.Textures.Frame

Since:
  • 3.0.0
这个游戏对象用来渲染的纹理框架.
Type:

isCropped :boolean

Since:
  • 3.11.0
一个布尔标志,指示此游戏对象是否被裁剪. 您可以在调用`剪切`后随时切换此选项,以打开或关闭剪切. 同样,在没有参数的情况下调用 `setCrop` 将重置裁剪并禁用它.
Type:
  • boolean

texture :Phaser.Textures.Texture|Phaser.Textures.CanvasTexture

Since:
  • 3.0.0
这个游戏对象用来渲染的纹理.
Type:

Methods

setCrop(xopt, yopt, widthopt, heightopt) → {this}

Since:
  • 3.11.0
将裁剪应用到基于纹理的游戏对象,如精灵或图像. 裁剪是一个矩形,它限制了渲染过程中可见的纹理框架的区域. 裁剪一个游戏物体并不会改变它的大小,尺寸,物理实体或命中区域,它只是 更改渲染时显示的内容. 裁剪坐标相对于纹理框架,而不是游戏对象,这意味着0 x 0是左上角. 因此,如果你有一个800x600大小纹理的游戏对象,你想只显示左边 一半的话,你可以叫 `setcrop(0,0,400,600)` . 它也会自动缩放以匹配游戏对象的比例.因此,将裁剪100x50的裁剪矩形 当应用于比例因子为2的游戏对象时,面积为200x100. 您可以直接传入数值,也可以提供一个矩形对象作为第一个参数. 调用这个没有任何参数的方法来重置裁剪,或者将属性 `isCropped` 切换为 `false` . 如果裁剪矩形与框架本身的大小相同,您应该这样做,因为这是允许的 渲染器跳过几个内部计算.
Parameters:
Name Type Attributes Description
x number | Phaser.Geom.Rectangle <optional>
开始裁剪的x坐标.或者相位器.矩形对象,在这种情况下,其余的参数被忽略.
y number <optional>
开始裁剪的y坐标.
width number <optional>
裁剪矩形的宽度,以像素为单位.
height number <optional>
裁剪矩形的高度,以像素为单位.
Returns:
此游戏对象实例.
Type
this

setFrame(frame, updateSizeopt, updateOriginopt) → {this}

Since:
  • 3.0.0
设置此游戏对象将用于渲染的帧. 框架必须属于当前使用的纹理. 它可以是字符串或索引. 调用 `setFrame` 将修改游戏对象的 `width` 和 `height` 属性. 如果框架有一个自定义轴点,它也会改变`origin`,就像从纹理打包器这样的包中导出一样.
Parameters:
Name Type Attributes Default Description
frame string | number 纹理中框架的名称或索引.
updateSize boolean <optional>
true 这个调用应该调整游戏对象的大小吗?
updateOrigin boolean <optional>
true 这个调用应该调整游戏对象的原点吗?
Returns:
此游戏对象实例.
Type
this

setTexture(key, frameopt) → {this}

Since:
  • 3.0.0
设置游戏对象用来渲染的纹理和框架. 纹理由存储在纹理管理器中的基于字符串的键引用.
Parameters:
Name Type Attributes Description
key string 要使用的纹理的键,存储在纹理管理器中.
frame string | number <optional>
纹理中框架的名称或索引.
Returns:
此游戏对象实例.
Type
this