GameObjectRegistry

Index

Variables

• activeGameObjects
• gameObjectTypes

Functions

• addGameObject
• callForType
• callForTypeSafe
• deployGameObject
• genUniqueName
• getAllByType
• registerClass
• removeGameObject
• resetEngine

Variables

Functions

addGameObject

• addGameObject(gameObject: GameObject<any>): void

• internal

  Puts game object as active, but without adding as updatable, which has been achieved by calling GameObject.deploy.

  ---

  Parameters

  • gameObject: GameObject<any>

  Returns void

callForType

• callForType(type: string, what: string, ...params: any): any

• Calls function of the GameObject of specified type with specified parameters.

  ---

  Parameters

  • type: string

    unique GameObject type to get all the instances of

  • what: string

    function name as defined in GameObjectPrototype passed to GameObject.constructor

  • rest...params: any

    parameters to be passed to the function

  Returns any

callForTypeSafe

• callForTypeSafe(type: string, what: string, ...params: any): any

• Same as GameObjectRegistry.callForType but for async operations.

  ---

  Parameters

  • type: string

  • what: string

  • rest...params: any

  Returns any

deployGameObject

• deployGameObject(gameObject: GameObject<any>): void

• internal

  Puts game object to an updatable queue, calling GameObjectPrototype.loaded. Should be called by GameObject.deploy.

  ---

  Parameters

  • gameObject: GameObject<any>

  Returns void

genUniqueName

• genUniqueName(name: string): string

• internal

  Suffixes game object type if it already registered.

  ---

  Parameters

  • name: string

  Returns string

getAllByType

• getAllByType<T>(type: string, clone: boolean): GameObject<T>[]

• Gets an array of deployed objects of specified type.

  ---

  Type parameters

  • T: GameObjectPrototype

  Parameters

  • type: string

    unique GameObject type to get all the instances of

  • clone: boolean

    if true, a new array is created to be changeable, recommended by default

  Returns GameObject<T>[]

registerClass

• registerClass(gameObject: GameObject<any>): void

• internal

  Registers game object to be saveable, called from GameObject.constructor.

  ---

  Parameters

  • gameObject: GameObject<any>

  Returns void

removeGameObject

• removeGameObject(gameObject: GameObject<any>): void

• internal

  Destroys game object, but without removing updatable as it is done via GameObject.destroy.

  ---

  Parameters

  • gameObject: GameObject<any>

  Returns void

resetEngine

• resetEngine(): void

• internal

  Clears active game object list, maintaining updatable states.

  ---

  Returns void