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, IDoodadManagerEvents>

`Protected` `Readonly` island

island: default

`Protected` `Readonly` name

name: "DoodadManager" = "DoodadManager"

Name of this object manager

`Protected` `Readonly` objects

objects: SaferArray<default>

`Protected` `Readonly` reregisterObjectsForMemoryLeaks

reregisterObjectsForMemoryLeaks: boolean = false

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

`Static` `Readonly` cachedDoodadSpawns

cachedDoodadSpawns: Map<BiomeType, Map<WorldZ, Map<TerrainType, DoodadType[]>>> = ...

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

`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(type: DoodadType, tile: default, options?: IDoodadOptions, creator?: default<unknown, number, NPC | Player>): undefined | default
Parameters
- type: DoodadType
- tile: default
- options: IDoodadOptions = {}
- Optional creator: default<unknown, number, NPC | Player>
Returns undefined | default
- Defined in src/game/game/doodad/DoodadManager.ts:244

createFake

createFake(type: DoodadType, options?: IDoodadOptions, tile?: default, id?: number): default
Parameters
- type: DoodadType
- options: IDoodadOptions = {}
- Optional tile: default
- id: number = -1
Returns default
- Defined in src/game/game/doodad/DoodadManager.ts:230

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

getBestDoodadForTier

getBestDoodadForTier(doodad: DoodadTypeGroup | DoodadType): undefined | DoodadType
Parameters
- doodad: DoodadTypeGroup | DoodadType
Returns undefined | DoodadType
- Defined in src/game/game/doodad/DoodadManager.ts:226

getGroups

getGroups(doodad: DoodadType): DoodadTypeGroup[]
Parameters
- doodad: DoodadType
Returns DoodadTypeGroup[]
- Defined in src/game/game/doodad/DoodadManager.ts:213

getObjects

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

getScarecrowInLineOfSight

getScarecrowInLineOfSight(creature: default, isClientside: boolean): undefined | default
Parameters
- creature: default
- isClientside: boolean
Returns undefined | default
- Defined in src/game/game/doodad/DoodadManager.ts:423

getScarecrowInRange

getScarecrowInRange(tile: default, range: number): undefined | default
Parameters
- tile: default
- range: number
Returns undefined | default
- Defined in src/game/game/doodad/DoodadManager.ts:399

isDoodadExtra

isDoodadExtra(type: number): type is DoodadTypeExtra
Checks if a number is a DoodadType or DoodadTypeExtra.

Returns
true or false depending on if the number is a DoodadType or DoodadTypeExtra.
Parameters
- type: number
  
  a number (DoodadType/DoodadTypeExtra enum).
Returns type is DoodadTypeExtra
- Defined in src/game/game/doodad/DoodadManager.ts:222

isGroup

isGroup(doodadType: DoodadTypeGroup | DoodadType): doodadType is DoodadTypeGroup
Parameters
- doodadType: DoodadTypeGroup | DoodadType
Returns doodadType is DoodadTypeGroup
- Defined in src/game/game/doodad/DoodadManager.ts:205

isInGroup

isInGroup(doodadType: DoodadType, doodadGroup: DoodadTypeGroup | DoodadType): boolean
Parameters
- doodadType: DoodadType
- doodadGroup: DoodadTypeGroup | DoodadType
Returns boolean
- Defined in src/game/game/doodad/DoodadManager.ts:209

load

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

loadEntity

loadEntity(doodad: default): void
Note: This can be called multiple times in the same game depending on loading/unloading of islands
Parameters
- doodad: default
Returns void
Overrides default.loadEntity
- Defined in src/game/game/doodad/DoodadManager.ts:189

`Protected` onRemove

onRemove(doodad: default): boolean
Removes a doodad from the world.
Parameters
- doodad: default
  
  The doodad to remove
Returns boolean
Overrides default.onRemove
- Defined in src/game/game/doodad/DoodadManager.ts:292

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

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(ticks: number, playingHumans: default<unknown, number, NPC | Player>[], playerHumanTiles: Set<default>): void
Runs a full gamut of updates on doodads including decaying items inside containers, spreading/growing plants/mushrooms, water distillation/desenation and more.
Parameters
- ticks: number
- playingHumans: default<unknown, number, NPC | Player>[]
- playerHumanTiles: Set<default>
Returns void
- Defined in src/game/game/doodad/DoodadManager.ts:338

updateAllAsync

updateAllAsync(ticks: number, playingHumans: default<unknown, number, NPC | Player>[], playerHumanTiles: Set<default>, onProgress: ((progess: number) => Promise<void>)): Promise<void>
Runs a full gamut of updates on doodads including decaying items inside containers, spreading/growing plants/mushrooms, water distillation/desenation and more.
Parameters
- ticks: number
- playingHumans: default<unknown, number, NPC | Player>[]
- playerHumanTiles: Set<default>
- onProgress: ((progess: number) => Promise<void>)
  - - (progess: number): Promise<void>
    - Parameters
      
      progess: number
      
      Returns Promise<void>
Returns Promise<void>
- Defined in src/game/game/doodad/DoodadManager.ts:347

updateFov

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

verifyAndFixItemWeights

verifyAndFixItemWeights(): void
Returns void
- Defined in src/game/game/doodad/DoodadManager.ts:360

`Static` clearCaches

clearCaches(): void
Returns void
- Defined in src/game/game/doodad/DoodadManager.ts:145

`Static` generateLookups

generateLookups(): void
Returns void
- Defined in src/game/game/doodad/DoodadManager.ts:75

`Static` getBestDoodadForTier

getBestDoodadForTier(doodad: DoodadTypeGroup | DoodadType): undefined | DoodadType
Parameters
- doodad: DoodadTypeGroup | DoodadType
Returns undefined | DoodadType
- Defined in src/game/game/doodad/DoodadManager.ts:71

`Static` getDoodadTypeGroupName

getDoodadTypeGroupName(doodadType: DoodadTypeGroup | DoodadType, article?: Article, count?: number): default
Parameters
- doodadType: DoodadTypeGroup | DoodadType
- Optional article: Article
- Optional count: number
Returns default
- Defined in src/game/game/doodad/DoodadManager.ts:181

`Static` getDoodadsInGroup

getDoodadsInGroup(doodadTypeGroup: DoodadTypeGroup): DoodadType[]
Parameters
- doodadTypeGroup: DoodadTypeGroup
Returns DoodadType[]
- Defined in src/game/game/doodad/DoodadManager.ts:168

`Static` getGroups

getGroups(doodadType: DoodadType): DoodadTypeGroup[]
Parameters
- doodadType: DoodadType
Returns DoodadTypeGroup[]
- Defined in src/game/game/doodad/DoodadManager.ts:164

`Static` isDoodadExtra

isDoodadExtra(type: number): type is DoodadTypeExtra
Checks if a number is a DoodadType or DoodadTypeExtra.

Returns
true or false depending on if the number is a DoodadType or DoodadTypeExtra.
Parameters
- type: number
  
  a number (DoodadType/DoodadTypeExtra enum).
Returns type is DoodadTypeExtra
- Defined in src/game/game/doodad/DoodadManager.ts:177

`Static` isGroup

isGroup(doodadType: DoodadTypeGroup | DoodadType): doodadType is DoodadTypeGroup
Parameters
- doodadType: DoodadTypeGroup | DoodadType
Returns doodadType is DoodadTypeGroup
- Defined in src/game/game/doodad/DoodadManager.ts:152

`Static` isInGroup

isInGroup(doodadType: DoodadType, doodadGroup: DoodadTypeGroup | DoodadType): boolean
Parameters
- doodadType: DoodadType
- doodadGroup: DoodadTypeGroup | DoodadType
Returns boolean
- Defined in src/game/game/doodad/DoodadManager.ts:156

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

island: default

objects: SaferArray<default> = []

Returns default

Properties

event

Protected Readonly island

Protected Readonly name

Protected Readonly objects

Protected Readonly reregisterObjectsForMemoryLeaks

Static Readonly cachedDoodadSpawns

Accessors

game

Returns Game

length

Returns number

Parameters

val: number

Returns void

Methods

[iterator]

Returns IteratorObject<undefined | default>

Protected canCreateEntity

Parameters

tile: default

options: IEntityCanCreateOptions = {}

Returns boolean

create

Parameters

type: DoodadType

tile: default

options: IDoodadOptions = {}

Optional creator: default<unknown, number, NPC | Player>

Returns undefined | default

createFake

Parameters

type: DoodadType

options: IDoodadOptions = {}

Optional tile: default

id: number = -1

Returns default

delete

Returns void

findUnusedId

Returns number

get

Parameters

id: number

Returns undefined | default

getBestDoodadForTier

Parameters

doodad: DoodadTypeGroup | DoodadType

Returns undefined | DoodadType

getGroups

Parameters

doodad: DoodadType

Returns DoodadTypeGroup[]

getObjects

Returns SaferArray<default>

getScarecrowInLineOfSight

Parameters

creature: default

isClientside: boolean

Returns undefined | default

getScarecrowInRange

Parameters

tile: default

range: number

Returns undefined | default

isDoodadExtra

Returns

`Protected` `Readonly` island

`Protected` `Readonly` name

`Protected` `Readonly` objects

`Protected` `Readonly` reregisterObjectsForMemoryLeaks

`Static` `Readonly` cachedDoodadSpawns

`Protected` canCreateEntity

`Optional` creator: default<unknown, number, NPC | Player>

`Optional` tile: default

`Protected` onRemove

`Protected` registerForMemoryLeakDetection

`Optional` options: undefined

`Protected` removeNulls

`Static` clearCaches

`Static` generateLookups

`Static` getBestDoodadForTier