Pipeline

.GameObjects.Components. Pipeline

Since:
  • 3.0.0
提供用于设置游戏对象的网络游戏渲染管道的方法.

Members

defaultPipeline :Phaser.Renderer.WebGL.WebGLPipeline

Since:
  • 3.0.0
Default Value:
  • null
这个游戏对象的初始网络游戏管道. 如果您在此游戏对象上调用 `resetPipeline` ,管道将被重置为默认值.
Type:

hasPostPipeline :boolean

Since:
  • 3.50.0
这个游戏对象有设置后期管道吗?
Type:
  • boolean

pipeline :Phaser.Renderer.WebGL.WebGLPipeline

Since:
  • 3.0.0
Default Value:
  • null
此游戏对象的当前网络总帐管道.
Type:

pipelineData :object

Since:
  • 3.50.0
存储管道特定数据的对象,由该游戏对象使用的管道读取.
Type:
  • object

postPipeline :Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline>

Since:
  • 3.50.0
这个游戏对象用于后期渲染效果. 管道按照它们在此数组中出现的顺序进行处理. 如果直接修改此数组,请确保将 相应地设置 `hasPostPipeline` 属性.
Type:

Methods

getPipelineName() → {string}

Since:
  • 3.0.0
获取此游戏对象当前使用的网络游戏管道的名称.
Returns:
The string-based name of the pipeline being used by 这个游戏对象.
Type
string

getPostPipeline(pipeline) → {Phaser.Renderer.WebGL.Pipelines.PostFXPipeline|Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline>}

Since:
  • 3.50.0
基于给定的名称,从该游戏对象获取发布管道实例,并将其返回.
Parameters:
Name Type Description
pipeline string | function | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline 管道的基于字符串的名称或管道类.
Returns:
与名称匹配的发布管道,如果不匹配,则未定义.如果有多个匹配项,它们将在数组中返回.
Type
Phaser.Renderer.WebGL.Pipelines.PostFXPipeline | Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline>

initPipeline(pipeline) → {boolean}

Since:
  • 3.0.0
设置这个游戏对象的初始网络游戏管道. 这应该只在游戏对象的实例化过程中调用.之后用 `setPipeline` .
Parameters:
Name Type Description
pipeline string | Phaser.Renderer.WebGL.WebGLPipeline 管道的基于字符串的名称,或要设置的管道实例.
Returns:
如果管道设置成功,则为 `true` ,否则为 `false` .
Type
boolean

removePostPipeline(pipeline) → {this}

Since:
  • 3.50.0
根据给定的名称,从此游戏对象中删除一种类型的后期管道实例,并销毁它们. 如果您希望删除所有的后期管道,请使用 `resetPostPipeline` 方法.
Parameters:
Name Type Description
pipeline string | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline 管道的基于字符串的名称或管道类.
Returns:
这个游戏对象.
Type
this

resetPipeline(resetPostPipelinesopt, resetDataopt) → {boolean}

Since:
  • 3.0.0
将此游戏对象的网络游戏管道重置回其创建时的默认设置.
Parameters:
Name Type Attributes Default Description
resetPostPipelines boolean <optional>
false 重置所有后管道?
resetData boolean <optional>
false 将 `pipelineData` 对象重置为空对象?
Returns:
如果管道复位成功,则为 `true` ,否则为 `false` .
Type
boolean

resetPostPipeline(resetDataopt)

Since:
  • 3.50.0
重置此游戏对象的网络游戏日志管道.它通过调用 方法,然后清除本地数组.
Parameters:
Name Type Attributes Default Description
resetData boolean <optional>
false 将 `pipelineData` 对象重置为空对象?

setPipeline(pipeline, pipelineDataopt, copyDataopt) → {this}

Since:
  • 3.0.0
设置此游戏对象的主网络游戏管道. 如果给定了参数,还设置 `pipelineData` 属性. 管道和后置管道共享同一个管道数据对象.
Parameters:
Name Type Attributes Default Description
pipeline string | Phaser.Renderer.WebGL.WebGLPipeline 管道的基于字符串的名称,或要设置的管道实例.
pipelineData object <optional>
可选的管道数据对象,被深度复制到此游戏对象的`pipelineData`属性中.
copyData boolean <optional>
true 管道数据对象应该被深度复制到这个游戏对象的属性中吗?如果 `false` ,将改为通过引用设置.
Returns:
此游戏对象实例.
Type
this

setPipelineData(key, valueopt) → {this}

Since:
  • 3.50.0
向属于此游戏对象的对象添加一个条目. 如果 `key` 已经存在,则更新其值.如果不存在,就创建. 如果 `value` 未定义,并且 `key` 存在,则从数据对象中删除 `key` . 管线和后管线一起共享管线数据对象.
Parameters:
Name Type Attributes Description
key string 要设置,更新或删除的管道数据的键.
value any <optional>
要用键设置的值.如果 `undefined` ,则 `key` 将从对象中删除.
Returns:
此游戏对象实例.
Type
this

setPostPipeline(pipelines, pipelineDataopt, copyDataopt) → {this}

Since:
  • 3.50.0
在此游戏对象上设置一个或多个发布管道. 在游戏对象渲染到其目标后调用后管道 通常用于外汇交易后. 后管道被附加到属于此的 `postPipelines` 数组 游戏对象.当渲染器处理这个游戏对象时,它会遍历帖子 管道按照它们在数组中出现的顺序排列.如果你们在一起 多重效果,注意顺序很重要. 如果多次调用此方法,新管道将被追加到任何现有管道中 已经设置了post管道.如果需要,首先使用 `resetPostPipeline` 方法清除它们. 如果给定了参数,还可以选择设置 `pipelineData` 属性. 管线和后管线一起共享管线数据对象.
Parameters:
Name Type Attributes Default Description
pipelines string | Array.<string> | function | Array.<function()> | Phaser.Renderer.WebGL.Pipelines.PostFXPipeline | Array.<Phaser.Renderer.WebGL.Pipelines.PostFXPipeline> 管道的基于字符串的名称,管道实例,类或它们的数组.
pipelineData object <optional>
可选的管道数据对象,被深度复制到此游戏对象的`pipelineData`属性中.
copyData boolean <optional>
true 管道数据对象应该被深度复制到这个游戏对象的属性中吗?如果 `false` ,将改为通过引用设置.
Returns:
此游戏对象实例.
Type
this