Fade

.Cameras.Scene2D.Effects. Fade

相机淡入淡出效果. 此效果将在指定的持续时间内,将相机视口淡化为给定的颜色. 只有相机视口褪色.它显示的所有对象都不会受到影响,即.他们的颜色会 不变. 该效果将在摄像机本身上调度几个事件,并且您还可以指定一个 `onUpdate` 回调, 如果需要的话,在效果的持续时间内每帧调用一次.

Constructor

new Fade(camera)

Since:
  • 3.5.0
Parameters:
Name Type Description
camera Phaser.Cameras.Scene2D.Camera 这种效果作用的摄像机.

Members

(readonly) camera :Phaser.Cameras.Scene2D.Camera

Since:
  • 3.5.0
这个效果所属的相机.
Type:

(readonly) direction :boolean

Since:
  • 3.5.0
褪色的方向. `true` =淡出(对颜色透明), `false` =淡入(对颜色透明)
Type:
  • boolean

(readonly) duration :number

Since:
  • 3.5.0
Default Value:
  • 0
效果的持续时间,以毫秒为单位.
Type:
  • number

(readonly) isComplete :boolean

Since:
  • 3.5.0
Default Value:
  • false
这个效果跑完了吗? 这与 `isRunning` 不同,因为它在效果结束时保持设置为 `true` , 直到效果被重置或再次开始.
Type:
  • boolean

(readonly) isRunning :boolean

Since:
  • 3.5.0
Default Value:
  • false
这种效应是主动运行的吗?
Type:
  • boolean

progress :number

Since:
  • 3.5.0
如果此效果正在运行,它将保留当前的进度百分比,介于0和1之间.
Type:
  • number

Methods

destroy()

Since:
  • 3.5.0
破坏此效果,将其从相机中释放.

effectComplete()

Since:
  • 3.5.0
当效果完成时在内部调用.
Fires:

postRenderCanvas(ctx) → {boolean}

Since:
  • 3.5.0
由画布渲染器在内部调用.
Parameters:
Name Type Description
ctx CanvasRenderingContext2D 要呈现到的画布上下文.
Returns:
如果效果绘制到渲染器,则为 `true` ,否则为 `false` .
Type
boolean

postRenderWebGL(pipeline, getTintFunction) → {boolean}

Since:
  • 3.5.0
由WebGL渲染器在内部调用.
Parameters:
Name Type Description
pipeline Phaser.Renderer.WebGL.Pipelines.MultiPipeline 要呈现到的网络总帐管道.必须提供 `drawFillRect` 方法.
getTintFunction function 将返回gl安全色调的函数.
Returns:
如果效果绘制到渲染器,则为 `true` ,否则为 `false` .
Type
boolean

reset()

Since:
  • 3.5.0
重置此相机效果. 如果它以前运行过,它会立即停止,而不调用其onComplete回调或发出事件.

start(directionopt, durationopt, redopt, greenopt, blueopt, forceopt, callbackopt, contextopt) → {Phaser.Cameras.Scene2D.Camera}

Since:
  • 3.5.0
在指定的持续时间内,将相机淡入或淡出给定的颜色.
Parameters:
Name Type Attributes Default Description
direction boolean <optional>
true 褪色的方向. `true` =淡出(对颜色透明), `false` =淡入(对颜色透明)
duration number <optional>
1000 效果的持续时间,以毫秒为单位.
red number <optional>
0 红色通道的淡入量.介于0和255之间的值.
green number <optional>
0 绿色通道的渐变量.介于0和255之间的值.
blue number <optional>
0 蓝色通道的渐变量.介于0和255之间的值.
force boolean <optional>
false 强制效果立即开始,即使已经在运行.
callback Phaser.Types.Cameras.Scene2D.CameraFadeCallback <optional>
在效果持续期间,每个帧都会调用此回调. 它被发送两个参数:一个对摄像机的引用和一个0到1之间的进度量,指示效果有多完整.
context any <optional>
调用回调的上下文.默认为摄像机所属的场景.
Fires:
Returns:
开始效果的摄像机.
Type
Phaser.Cameras.Scene2D.Camera

update(time, delta)

Since:
  • 3.5.0
这个效果的主要更新循环.由摄像机自动调用.
Parameters:
Name Type Description
time number 由请求动画帧或设置时间输出生成的当前时间戳.
delta number 自最后一帧以来经过的增量时间(毫秒).