Class default<T, IRemoveOptions>`Abstract`

Type Parameters

T extends default
IRemoveOptions = undefined

Hierarchy

ObjectManager<T, IEntityManagerEvents<T>>
- default
  - default
  - default
  - default
  - default
  - default
  - default

Implements

IEntityManager<T>

Index

Constructors

Properties

event island name objects reregisterObjectsForMemoryLeaks

Accessors

Methods

[iterator] canCreateEntity delete findUnusedId get getObjects load loadEntity? onRemove onUnserialized registerForMemoryLeakDetection remove removeNulls set updateFov

Constructors

constructor

new default<T, IRemoveOptions>(island: default, objects?: SaferArray<T>): default<T, IRemoveOptions>
Type Parameters
- T extends default<unknown, number, EntityReferenceTypes, unknown, T>
- IRemoveOptions = undefined
Parameters
- island: default
- objects: SaferArray<T> = []
Returns default<T, IRemoveOptions>
Inherited from ObjectManager.constructor
- Defined in src/game/game/ObjectManager.ts:35

Properties

`Readonly` event

event: IEventEmitter<default<T, IRemoveOptions>, IEntityManagerEvents<T>>

`Protected` `Readonly` island

island: default

`Protected` `Readonly` `Abstract` name

name: string

Name of this object manager

`Protected` `Readonly` objects

objects: SaferArray<T>

`Protected` `Readonly` reregisterObjectsForMemoryLeaks

reregisterObjectsForMemoryLeaks: boolean = false

Indicates if objects should be re-registered to the memory leak detector after loading

Accessors

game

get game(): Game
Returns Game
Inherited from ObjectManager.game
- Defined in src/game/game/ObjectManager.ts:42

length

get length(): number
Returns number
Inherited from ObjectManager.length
- Defined in src/game/game/ObjectManager.ts:72
set length(val: number): void
This is likely only used during save upgrades
Parameters
- val: number
Returns void
Inherited from ObjectManager.length
- Defined in src/game/game/ObjectManager.ts:79

Methods

[iterator]

[iterator](): IteratorObject<undefined | T>
Returns IteratorObject<undefined | T>
Inherited from ObjectManager.[iterator]
- Defined in src/game/game/ObjectManager.ts:68

`Protected` canCreateEntity

canCreateEntity(tile: default, options?: IEntityCanCreateOptions): boolean
Checks if the target position is a good spot for a new entity
Parameters
- tile: default
- options: IEntityCanCreateOptions = {}
Returns boolean
- Defined in src/game/game/entity/EntityManager.ts:144

delete

delete(): void
Called when this object manager is not used anymore (after it was saved!)

Returns void
Inherited from ObjectManager.delete
- Defined in src/game/game/ObjectManager.ts:49

findUnusedId

findUnusedId(): number
Returns number
Inherited from ObjectManager.findUnusedId
- Defined in src/game/game/ObjectManager.ts:104

get

get(id: number): undefined | T
Parameters
- id: number
Returns undefined | T
Inherited from ObjectManager.get
- Defined in src/game/game/ObjectManager.ts:83

getObjects

getObjects(): SaferArray<T>
Returns SaferArray<T>
Inherited from ObjectManager.getObjects
- Defined in src/game/game/ObjectManager.ts:100

load

load(): void
Returns void
- Defined in src/game/game/entity/EntityManager.ts:53

`Protected` `Optional` `Abstract` loadEntity

loadEntity(entity: T): void
Parameters
- entity: T
Returns void
- Defined in src/game/game/entity/EntityManager.ts:51

`Protected` `Abstract` onRemove

onRemove(entity: T, options?: IRemoveOptions): boolean
Called when an entity is being removed

Returns
Return true if this method handled tile updates
Parameters
- entity: T
  
  Entity to remove
- Optional options: IRemoveOptions
Returns boolean
- Defined in src/game/game/entity/EntityManager.ts:49

onUnserialized

onUnserialized(): void
Returns void
Inherited from ObjectManager.onUnserialized
- Defined in src/game/game/ObjectManager.ts:62

`Protected` registerForMemoryLeakDetection

registerForMemoryLeakDetection(object: SaferArray<T>): void
Parameters
- object: SaferArray<T>
Returns void
Inherited from ObjectManager.registerForMemoryLeakDetection
- Defined in src/game/game/ObjectManager.ts:144

remove

remove(entity: T, options?: IRemoveOptions): void
Parameters
- entity: T
- Optional options: IRemoveOptions
Returns void
Implementation of IEntityManager.remove
- Defined in src/game/game/entity/EntityManager.ts:84

`Protected` removeNulls

removeNulls(): void
Returns void
Inherited from ObjectManager.removeNulls
- Defined in src/game/game/ObjectManager.ts:134

set

set(id: number, value: undefined | T): void
Parameters
- id: number
- value: undefined | T
Returns void
Inherited from ObjectManager.set
- Defined in src/game/game/ObjectManager.ts:87

updateFov

updateFov(humanBounds: IHumanBound[]): void
Parameters
- humanBounds: IHumanBound[]
Returns void
Implementation of IEntityManager.updateFov
- Defined in src/game/game/entity/EntityManager.ts:104

Generated using TypeDoc