Class default

Hierarchy

default<default>
- default

Constructors

constructor

new default(island: default, objects?: SaferArray<default>): default
Parameters
- island: default
- objects: SaferArray<default> = []
Returns default
Inherited from default.constructor
- Defined in src/game/game/ObjectManager.ts:35

Properties

event

event: IEventEmitter<default, INPCManagerEvents>

`Protected` `Readonly` island

island: default

`Protected` `Readonly` name

name: "NPCManager" = "NPCManager"

Name of this object manager

`Protected` `Readonly` objects

objects: SaferArray<default>

`Readonly` playerLikeNpcs

playerLikeNpcs: default[] = []

`Protected` `Readonly` reregisterObjectsForMemoryLeaks

reregisterObjectsForMemoryLeaks: true = true

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

Accessors

game

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

length

get length(): number
Returns number
Inherited from EntityManager.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 EntityManager.length
- Defined in src/game/game/ObjectManager.ts:79

Methods

[iterator]

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

addPlayerLike

addPlayerLike(npc: default, addToIsland?: boolean): void
Parameters
- npc: default
- addToIsland: boolean = true
Returns void
- Defined in src/game/game/entity/npc/NPCManager.ts:188

`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
Inherited from default.canCreateEntity
- Defined in src/game/game/entity/EntityManager.ts:144

create

create(npcType: NPCType, tile: default, options?: INPCCanCreateOptions): undefined | default
Parameters
- npcType: NPCType
- tile: default
- options: INPCCanCreateOptions = ...
Returns undefined | default
- Defined in src/game/game/entity/npc/NPCManager.ts:126

delete

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

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

findUnusedId

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

get

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

getObjects

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

getPendingOutboundShippers

getPendingOutboundShippers(): default[]
Get an array of shippers that are in the process of shipping things to another island

Returns default[]
- Defined in src/game/game/entity/npc/NPCManager.ts:223

load

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

loadEntity

loadEntity(npc: default): void
Parameters
- npc: default
Returns void
Overrides default.loadEntity
- Defined in src/game/game/entity/npc/NPCManager.ts:94

`Protected` onRemove

onRemove(npc: default): boolean
Called when an entity is being removed

Returns
Return true if this method handled tile updates
Parameters
- npc: default
  
  Entity to remove
Returns boolean
Overrides default.onRemove
- Defined in src/game/game/entity/npc/NPCManager.ts:173

onUnserialized

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

`Protected` registerForMemoryLeakDetection

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

remove

remove(entity: default, options?: undefined): void
Parameters
- entity: default
- Optional options: undefined
Returns void
Inherited from default.remove
- Defined in src/game/game/entity/EntityManager.ts:84

`Protected` removeNulls

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

removePlayerLike

removePlayerLike(npc: default): void
Parameters
- npc: default
Returns void
- Defined in src/game/game/entity/npc/NPCManager.ts:199

resetSpawnInterval

resetSpawnInterval(npcType: NPCType): void
Parameters
- npcType: NPCType
Returns void
- Defined in src/game/game/entity/npc/NPCManager.ts:256

resetSpawnIntervals

resetSpawnIntervals(): void
Returns void
- Defined in src/game/game/entity/npc/NPCManager.ts:245

runRandomEvents

runRandomEvents(island: default, tile: default, human: default<unknown, number, NPC | Player>): undefined | boolean | void
Parameters
- island: default
- tile: default
- human: default<unknown, number, NPC | Player>
Returns undefined | boolean | void
- Defined in src/game/game/entity/npc/NPCManager.ts:290

set

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

updateAll

updateAll(): void
Returns void
- Defined in src/game/game/entity/npc/NPCManager.ts:210

updateFov

updateFov(humanBounds: IHumanBound[]): void
Parameters
- humanBounds: IHumanBound[]
Returns void
Inherited from default.updateFov
- Defined in src/game/game/entity/EntityManager.ts:104

Generated using TypeDoc