Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UIScene

Hierarchy

  • Scene
    • UIScene

Index

Constructors

constructor

  • new UIScene(config: string | Phaser.Types.Scenes.SettingsConfig): UIScene

Properties

add

add: GameObjectFactory

A scene level Game Object Factory. This property will only be available if defined in the Scene Injection Map.

anims

anims: AnimationManager

A reference to the global Animation Manager. This property will only be available if defined in the Scene Injection Map.

cache

cache: CacheManager

A reference to the global Cache. This property will only be available if defined in the Scene Injection Map.

cameras

cameras: CameraManager

A scene level Camera System. This property will only be available if defined in the Scene Injection Map.

children

children: DisplayList

A scene level Game Object Display List. This property will only be available if defined in the Scene Injection Map.

data

data: DataManager

A scene level Data Manager Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

events

events: EventEmitter

A scene level Event Emitter. This property will only be available if defined in the Scene Injection Map.

facebook

facebook: FacebookInstantGamesPlugin

A scene level Facebook Instant Games Plugin. This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.

game

game: Game

A reference to the Phaser.Game instance. This property will only be available if defined in the Scene Injection Map.

input

input: InputPlugin

A scene level Input Manager Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

lights

lights: LightsManager

A scene level Lights Manager Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

load

load: LoaderPlugin

A scene level Loader Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

loaded

loaded: boolean = false

make

make: GameObjectCreator

A scene level Game Object Creator. This property will only be available if defined in the Scene Injection Map.

matter

matter: MatterPhysics

A scene level Matter Physics Plugin. This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.

orgMainFont

orgMainFont: string

orgMainFont_o

orgMainFont_o: string

orgPopUpFont

orgPopUpFont: string

physics

physics: ArcadePhysics

A scene level Arcade Physics Plugin. This property will only be available if defined in the Scene Injection Map, the plugin is installed and configured.

playerCache

playerCache: Mob[]

plugins

plugins: PluginManager

A reference to the Plugin Manager.

The Plugin Manager is a global system that allows plugins to register themselves with it, and can then install those plugins into Scenes as required.

registry

registry: DataManager

A reference to the game level Data Manager. This property will only be available if defined in the Scene Injection Map.

scale

scale: ScaleManager

A reference to the global Scale Manager. This property will only be available if defined in the Scene Injection Map.

scene

scene: ScenePlugin

A reference to the Scene Manager Plugin. This property will only be available if defined in the Scene Injection Map.

sound

sound: BaseSoundManager

A reference to the Sound Manager. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

sys

sys: Systems

The Scene Systems. You must never overwrite this property, or all hell will break lose.

textures

textures: TextureManager

A reference to the Texture Manager. This property will only be available if defined in the Scene Injection Map.

time

time: Clock

A scene level Time and Clock Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

toolTip

toolTip: { body: HTMLElement; title: HTMLElement; toolTip: HTMLElement }

Type declaration

  • body: HTMLElement
  • title: HTMLElement
  • toolTip: HTMLElement

tweens

tweens: TweenManager

A scene level Tween Manager Plugin. This property will only be available if defined in the Scene Injection Map and the plugin is installed.

unitFrames

unitFrames: UnitFrame[] = []

Static instance

instance: UIScene

Methods

clearUnitFrame

  • clearUnitFrame(): void

create

  • create(): void

hideToolTip

  • hideToolTip(): void

initUnitFrames

  • initUnitFrames(): void

loadComplete

  • loadComplete(): void

preload

  • preload(): void

resetPlayers

  • resetPlayers(): void

setupScene

  • setupScene(): void

showToolTip

update

  • update(time: number, dt: number): void

Static getSingleton

Generated using TypeDoc