Class Container

noa.container - manages the game's HTML container element, canvas, fullscreen, pointerLock, and so on.

This module wraps micro-game-shell, which does most of the implementation.

Events

  • DOMready => ()
    Relays the browser DOMready event, after noa does some initialization
  • gainedPointerLock => ()
    Fires when the game container gains pointerlock.
  • lostPointerLock => ()
    Fires when the game container loses pointerlock.

Hierarchy

Properties

canvas element hasPointerLock isFocused listenerCount off on pointerInGame supportsPointerLock

Methods

addListener emit eventNames getMaxListeners listeners once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners setPointerLock

Properties

canvas

canvas: any

The canvas element that the game will draw into

element

element: any

Readonly hasPointerLock

hasPointerLock: boolean

Gets the current state of pointerLock.

Readonly isFocused

isFocused: boolean

Whether the game is focused.

listenerCount

listenerCount: {
    (type): any;
    (emitter, type): any;
}

Type declaration

    • (type): any

    • Parameters

      • type: any

      Returns any

    • (emitter, type): any

    • Parameters

      • emitter: any
      • type: any

      Returns any

off

off: any

on

on: any

Readonly pointerInGame

pointerInGame: boolean

Whether the user's pointer is within the game area.

Readonly supportsPointerLock

supportsPointerLock: boolean

Whether the browser supports pointerLock.

Methods

addListener

  • Parameters

    • type: any
    • listener: any

    Returns any

emit

  • Parameters

    • type: any
    • Rest ...args: any[]

    Returns boolean

eventNames

getMaxListeners

listeners

once

prependListener

prependOnceListener

rawListeners

removeAllListeners

removeListener

setMaxListeners

setPointerLock

  • Sets whether noa should try to acquire or release pointerLock

    Parameters

    • lock: boolean = false

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc