Class default

Hierarchy

ObjectManager<default, IDoodadManagerEvents>
- default

Constructors

constructor

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

Properties

`Readonly` event

event: IEventEmitter<default, IDoodadManagerEvents> = ...

`Protected` `Readonly` island

island: default

`Protected` `Readonly` objects

objects: SaferArray<default>

`Static` `Readonly` cachedDoodadSpawns

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

Accessors

game

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

length

get length(): number
Returns number
Inherited from ObjectManager.length
- Defined in src/game/game/ObjectManager.ts:63

Methods

[iterator]

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

create

create(type: DoodadType, tile: default, options?: IDoodadOptions, creator?: default<number>): undefined | default
Parameters
- type: DoodadType
- tile: default
- options: IDoodadOptions = {}
- Optional creator: default<number>
Returns undefined | default
- Defined in src/game/game/doodad/DoodadManager.ts:263

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:249

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:42

findUnusedId

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

get

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

getBestDoodadForTier

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

getGroups

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

getObjects

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

getScarecrowInLineOfSight

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

getScarecrowInRange

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

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:241

isGroup

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

isInGroup

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

load

load(): void
Note: This can be called multiple times in the same game depending on loading/unloading of islands

Returns void
- Defined in src/game/game/doodad/DoodadManager.ts:181

onUnserialized

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

`Protected` registerForMemoryLeakDetection

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

remove

remove(doodad: default, removeItems?: boolean): void
Removes a doodad from the world.
Parameters
- doodad: default
  
  The doodad to remove
- removeItems: boolean = false
  
  Whether to remove items.
  
  Note: This method will remove any items in them whether the removeItems parameter is provided or not. If the parameter is not provided, the assumption is that it will only be called on empty doodads. Therefore, if there are items, it will log a warning.
Returns void
- Defined in src/game/game/doodad/DoodadManager.ts:313

`Protected` removeNulls

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

set

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

updateAll

updateAll(ticks: number, playingHumans: default<number>[], playerHumanTiles: Set<default>, updatesPerTick?: number): 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<number>[]
- playerHumanTiles: Set<default>
- updatesPerTick: number = 1
Returns void
- Defined in src/game/game/doodad/DoodadManager.ts:349

updateAllAsync

updateAllAsync(ticks: number, playingHumans: default<number>[], playerHumanTiles: Set<default>, updatesPerTick?: number, 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<number>[]
- playerHumanTiles: Set<default>
- updatesPerTick: number = 1
- 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:360

verifyAndFixItemWeights

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

`Static` clearCaches

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

`Static` generateLookups

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

`Static` getBestDoodadForTier

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

`Static` getDoodadTypeGroupName

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

`Static` getGroups

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

`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:169

`Static` isGroup

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

`Static` isInGroup

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

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

island: default

objects: SaferArray<default> = []

Returns default

Properties

Readonly event

Protected Readonly island

Protected Readonly objects

Static Readonly cachedDoodadSpawns

Accessors

game

Returns Game

length

Returns number

Methods

[iterator]

Returns IterableIterator<undefined | default>

create

Parameters

type: DoodadType

tile: default

options: IDoodadOptions = {}

Optional creator: default<number>

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: DoodadType | DoodadTypeGroup

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

Parameters

type: number

Returns type is DoodadTypeExtra

isGroup

Parameters

doodadType: DoodadType | DoodadTypeGroup

Returns doodadType is DoodadTypeGroup

isInGroup

Parameters

doodadType: DoodadType

`Readonly` event

`Protected` `Readonly` island

`Protected` `Readonly` objects

`Static` `Readonly` cachedDoodadSpawns

`Optional` creator: default<number>

`Optional` tile: default

`Protected` registerForMemoryLeakDetection

`Protected` removeNulls

`Static` clearCaches

`Static` generateLookups

`Static` getBestDoodadForTier

`Static` getDoodadTypeGroupName

`Optional` article: Article

`Optional` count: number

`Static` getGroups

`Static` isDoodadExtra

`Static` isGroup

`Static` isInGroup