Namespace GameObjectRegistry

Index

Functions

addGameObject callForType callForTypeSafe deployGameObject genUniqueName getAllByType registerClass removeGameObject resetEngine

Variables

activeGameObjects gameObjectTypes

Functions

addGameObject

addGameObject(gameObject): 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
- Defined in GameObject.d.ts:120

callForType

callForType(type, what, ...params): 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
- Defined in GameObject.d.ts:151

callForTypeSafe

callForTypeSafe(type, what, ...params): any
Same as GameObjectRegistry.callForType but for async operations.
Parameters
- type: string
- what: string
- Rest...params: any
Returns any
- Defined in GameObject.d.ts:156

deployGameObject

deployGameObject(gameObject): void
Internal
Puts game object to an updatable queue, calling GameObjectPrototype.loaded. Should be called by GameObject.deploy.
Parameters
- gameObject: GameObject<any>
Returns void
- Defined in GameObject.d.ts:113

genUniqueName

genUniqueName(name): string
Internal
Suffixes game object type if it already registered.
Parameters
- name: string
Returns string
- Defined in GameObject.d.ts:100

getAllByType

getAllByType<T>(type, clone): GameObject<T>[]
Gets an array of deployed game objects of specified type.
Type Parameters
- T extends 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>[]
- Defined in GameObject.d.ts:141

registerClass

registerClass(gameObject): void
Internal
Registers game object to be saveable, called from GameObject.constructor.
Parameters
- gameObject: GameObject<any>
Returns void
- Defined in GameObject.d.ts:106

removeGameObject

removeGameObject(gameObject): void
Internal
Destroys game object, but without removing updatable as it is done via GameObject.destroy.
Parameters
- gameObject: GameObject<any>
Returns void
- Defined in GameObject.d.ts:127

resetEngine

resetEngine(): void
Internal
Clears active game object list, maintaining updatable states.

Returns void
- Defined in GameObject.d.ts:133

Variables

`Const` `Internal`activeGameObjects

activeGameObjects: {
[type: string]: GameObject<any>;
}

Game objects which are deployed via GameObject.deploy or internally via GameObjectRegistry.deployGameObject and GameObjectRegistry.addGameObject.

`Const` `Internal`gameObjectTypes

gameObjectTypes: {
[gameobjectName: string]: GameObject<any>;
}

Game objects which are registered via GameObject.constructor or internally via GameObjectRegistry.registerClass.

Copyright © 2024 Nernar. Copyright © 2020 #mineprogramming. Built with ❤ and TypeDoc.