GameObjectCreator

.GameObjects. GameObjectCreator

游戏对象创建器是一个场景插件,允许你快速创建许多常见的 游戏对象的类型并返回它们.与游戏对象工厂不同,它们不是自动生成的 添加到场景中. 游戏对象直接向创作者注册自己,并注入自己的创作 方法添加到类中.

Constructor

new GameObjectCreator(scene)

Since:
  • 3.0.0
Parameters:
Name Type Description
scene Phaser.Scene 此游戏对象工厂所属的场景.

Members

(protected) displayList :Phaser.GameObjects.DisplayList

Since:
  • 3.0.0
场景显示列表的参考.
Type:

(protected) events :Phaser.Events.EventEmitter

Since:
  • 3.50.0
场景事件发射器的参考.
Type:

(protected) scene :Phaser.Scene

Since:
  • 3.0.0
游戏对象创建者所属的场景.
Type:

(protected) systems :Phaser.Scenes.Systems

Since:
  • 3.0.0
场景参考系统.
Type:

(protected) updateList :Phaser.GameObjects.UpdateList

Since:
  • 3.0.0
场景更新列表的参考.
Type:

Methods

(static) register(factoryType, factoryFunction)

Since:
  • 3.0.0
Static method called directly by the Game Object creator functions. With this method you can register a custom GameObject factory in the GameObjectCreator, 依次提供名称( `factoryType` )和构造函数( `factoryFunction` ) to be called when you invoke Phaser.Scene.make[ factoryType ] method.
Parameters:
Name Type Description
factoryType string The key of the factory that you will use to call to Phaser.Scene.make[ factoryType ] method.
factoryFunction function The constructor function to be called when you invoke to the Phaser.Scene.make method.

(static) remove(factoryType)

Since:
  • 3.0.0
Static method called directly by the Game Object Creator functions. With this method you can remove a custom Game Object Creator that has been previously registered in the Game Object Creator. Pass in its `factoryType` in order to 移开它.
Parameters:
Name Type Description
factoryType string The key of the factory that you want to remove from the GameObjectCreator.

bitmapText(config, addToSceneopt) → {Phaser.GameObjects.BitmapText}

Since:
  • 3.0.0
创建一个新的位图文本游戏对象并返回它. 注意:这个方法只有在位图文本游戏对象已经被嵌入相位器时才可用.
Parameters:
Name Type Attributes Description
config Phaser.Types.GameObjects.BitmapText.BitmapTextConfig 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.BitmapText

blitter(config, addToSceneopt) → {Phaser.GameObjects.Blitter}

Since:
  • 3.0.0
创建一个新的游戏对象并返回它. 注意:这个方法只有在快乐者游戏对象已经被嵌入相位器的情况下才有效.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Blitter

container(config, addToSceneopt) → {Phaser.GameObjects.Container}

Since:
  • 3.4.0
创建一个新的容器游戏对象并返回它. 注意:这个方法只有在容器游戏对象已经被构建到相位器中时才可用.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Container

dynamicBitmapText(config, addToSceneopt) → {Phaser.GameObjects.DynamicBitmapText}

Since:
  • 3.0.0 ²
创建一个新的动态位图文本游戏对象并返回它. 注意:这个方法只有在动态位图文本游戏对象已经被嵌入相位器时才可用.
Parameters:
Name Type Attributes Description
config Phaser.Types.GameObjects.BitmapText.BitmapTextConfig 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.DynamicBitmapText

graphics(config, addToSceneopt) → {Phaser.GameObjects.Graphics}

Since:
  • 3.0.0
创建一个新的图形游戏对象并返回它. 注意:这种方法只有在图形游戏对象已经内置到相位器中时才可用.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Graphics

group(config) → {Phaser.GameObjects.Group}

Since:
  • 3.0.0
创建一个新的团体游戏对象并返回. 注意:这种方法只有在群组游戏对象已经内置在相位器中时才可用.
Parameters:
Name Type Description
config Phaser.Types.GameObjects.Group.GroupConfig | Phaser.Types.GameObjects.Group.GroupCreateConfig 这个游戏对象将用来创建自己的配置对象.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Group

image(config, addToSceneopt) → {Phaser.GameObjects.Image}

Since:
  • 3.0.0
创建一个新的图像游戏对象并返回它. 注意:这种方法只有在图像游戏对象已经内置在相位器中时才可用.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Image

layer(config, addToSceneopt) → {Phaser.GameObjects.Layer}

Since:
  • 3.50.0
创建一个新的层游戏对象并返回它. 注意:这个方法只有在图层游戏对象已经内置到相位器中时才可用.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Layer

mesh(config, addToSceneopt) → {Phaser.GameObjects.Mesh}

Since:
  • 3.0.0
创建一个新的网格游戏对象并返回它. 注意:只有在相位器中内置了网格游戏对象和网络游戏支持时,这种方法才可用.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Mesh

particles(config, addToSceneopt) → {Phaser.GameObjects.Particles.ParticleEmitterManager}

Since:
  • 3.0.0
创建一个新的粒子发射器管理器游戏对象并返回它. 注意:这个方法只有在粒子游戏对象已经被内置到相位器中时才可用.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Particles.ParticleEmitterManager

pointlight(config, addToSceneopt) → {Phaser.GameObjects.PointLight}

Since:
  • 3.50.0
创建一个新的点光源游戏对象并返回它. 注意:这个方法只有在点光游戏物体已经被置入相位器的情况下才有效.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.PointLight

renderTexture(config, addToSceneopt) → {Phaser.GameObjects.RenderTexture}

Since:
  • 3.2.0
创建一个新的渲染纹理游戏对象并返回它. 注意:这个方法只有在渲染纹理游戏对象已经被嵌入相位器的情况下才可用.
Parameters:
Name Type Attributes Description
config Phaser.Types.GameObjects.RenderTexture.RenderTextureConfig 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.RenderTexture

rope(config, addToSceneopt) → {Phaser.GameObjects.Rope}

Since:
  • 3.23.0
创建一个新的绳子游戏对象并返回它. 注意:只有在相位器中内置了绳索游戏对象和网络游戏支持时,该方法才可用.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Rope

shader(config, addToSceneopt) → {Phaser.GameObjects.Shader}

Since:
  • 3.17.0
创建新的着色器游戏对象并将其返回. 注意:这个方法只有在着色器游戏对象和WebGL支持已经内置到Phaser中时才可用.
Parameters:
Name Type Attributes Description
config object 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Shader

sprite(config, addToSceneopt) → {Phaser.GameObjects.Sprite}

Since:
  • 3.0.0
创建一个新的精灵游戏对象并返回它. 注意:这种方法只有在精灵游戏对象已经内置在相位器中时才可用.
Parameters:
Name Type Attributes Description
config Phaser.Types.GameObjects.Sprite.SpriteConfig 这个游戏对象将用来创建自己的配置对象.
addToScene boolean <optional>
创建游戏对象后将其添加到场景中?如果设置此参数,将覆盖配置对象中的 `add` 属性.
Returns:
创建的游戏对象.
Type
Phaser.GameObjects.Sprite

text(config, addToSceneopt) → {Phaser.GameObjects.Text}

Since:
  • 3.0.0
创建一个新的文本游戏对象并返回它. 注意:这个方法只有在文本游戏对象已经被嵌入相位器的情况下才可用.
Parameters:
Name Type Attributes Description
config Phaser.Types.GameObjects.Text.TextConfig