Class default

Hierarchy

default<default, {
remainTamed?: boolean;
}>
- 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, ICreatureManagerEvents>

`Protected` `Readonly` island

island: default

list

list: ITranslationListBuilder<default, CreatureType, boolean> = CreatureManager.list

`Protected` `Readonly` name

name: "CreatureManager" = "CreatureManager"

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` combatStrength

combatStrength: default

`Static` list

list: ITranslationListBuilder<default, CreatureType, boolean> = ...

Accessors

combatStrength

get combatStrength(): default
Returns default
- Defined in src/game/game/entity/creature/CreatureManager.ts:69

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

createFake

createFake(type: CreatureType, aberrant: boolean, tile?: default, id?: number): default
Parameters
- type: CreatureType
- aberrant: boolean
- Optional tile: default
- id: number = -1
Returns default
- Defined in src/game/game/entity/creature/CreatureManager.ts:347

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

exists

exists(creature: default): boolean
Parameters
- creature: default
Returns boolean
- Defined in src/game/game/entity/creature/CreatureManager.ts:361

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

getHappinessLevel

getHappinessLevel(human: default<unknown, number, NPC | Player>, creature: default, bonus?: number): number
Parameters
- human: default<unknown, number, NPC | Player>
- creature: default
- bonus: number = 0
Returns number
- Defined in src/game/game/entity/creature/CreatureManager.ts:113

getMovePenalty

getMovePenalty(moveType: MoveType, tile: default, willMove: boolean, options?: Partial<ICreatureCheckMoveOptions>, creature?: default): number
getMovePenalty

Returns
Blocked penalty - Do no return 0!
Parameters
- moveType: MoveType
- tile: default
- willMove: boolean
  
  Set to true if the object is about to move to this tile. This method will confirm if there's an existing npc/creature there and return false if so
- Optional options: Partial<ICreatureCheckMoveOptions>
- Optional creature: default
Returns number
- Defined in src/game/game/entity/creature/CreatureManager.ts:461

getMovePenaltyFromWasm

getMovePenaltyFromWasm(moveType: MoveType, x: number, y: number, z: number): number
wasm calls this when calculating penalties for flow fields
Parameters
- moveType: MoveType
- x: number
- y: number
- z: number
Returns number
- Defined in src/game/game/entity/creature/CreatureManager.ts:594

getName

getName(creature: default | CreatureType, aberrant?: boolean, count?: number, article?: Article): default
Parameters
- creature: default | CreatureType
- Optional aberrant: boolean
- Optional count: number
- Optional article: Article
Returns default
- Defined in src/game/game/entity/creature/CreatureManager.ts:108

getObjects

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

load

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

loadEntity

loadEntity(creature: default): void
Parameters
- creature: default
Returns void
Overrides default.loadEntity
- Defined in src/game/game/entity/creature/CreatureManager.ts:81

maybeSpawnClawWorm

maybeSpawnClawWorm(target: default | default<unknown, number, NPC | Player>): void
Parameters
- target: default | default<unknown, number, NPC | Player>
Returns void
- Defined in src/game/game/entity/creature/CreatureManager.ts:366

maybeSpawnDryad

maybeSpawnDryad(target: default<unknown, number, NPC | Player>): void
Maybe spawns a Dryad based on target's skill, zone tier, plants around target, and chance.
Parameters
- target: default<unknown, number, NPC | Player>
  
  Human that we check around to find a suitable spawn.
Returns void
- Defined in src/game/game/entity/creature/CreatureManager.ts:394

`Protected` onRemove

onRemove(creature: default, options?: {
remainTamed?: boolean;
}): boolean
Called when an entity is being removed

Returns
Return true if this method handled tile updates
Parameters
- creature: default
  
  Entity to remove
- Optional options: {
  remainTamed?: boolean;
  }
  - Optional remainTamed?: boolean
Returns boolean
Overrides default.onRemove
- Defined in src/game/game/entity/creature/CreatureManager.ts:426

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?: {
remainTamed?: boolean;
}): void
Parameters
- entity: default
- Optional options: {
  remainTamed?: boolean;
  }
  - Optional remainTamed?: boolean
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

spawn

spawn(type: CreatureType, tile: default, bypass?: boolean, forceAberrant?: boolean, spawnTiles?: TileGroup, bypassCreatureLimit?: boolean): undefined | default
Spawns a creature.
Parameters
- type: CreatureType
  
  The type of creature to spawn.
- tile: default
  
  The tile
- Optional bypass: boolean
  
  Whether to bypass checks for whether the creature can spawn there naturally. Defaults to false, if the creature can't spawn naturally, it won't.
- Optional forceAberrant: boolean
  
  If provided, forces the spawned creature's aberrant state to be the passed boolean. True = aberrant, false = not aberrant. If not provided, the aberrant state is decided based on chance.
- Optional spawnTiles: TileGroup
  
  If set, this will overwrite the creature's description for which tiles it can spawn on
- Optional bypassCreatureLimit: boolean
  
  If set, the creature limit will be ignored and spawn the creature over the set limit
Returns undefined | default
- Defined in src/game/game/entity/creature/CreatureManager.ts:138

spawnFromZone

spawnFromZone(tile: default, bypassCreatureLimit?: boolean, checkTerrainType?: boolean): undefined | default
Parameters
- tile: default
- Optional bypassCreatureLimit: boolean
- Optional checkTerrainType: boolean
Returns undefined | default
- Defined in src/game/game/entity/creature/CreatureManager.ts:295

spawnGuardians

spawnGuardians(position: IVector3, amount: number): number
Parameters
- position: IVector3
- amount: number
Returns number
- Defined in src/game/game/entity/creature/CreatureManager.ts:600

updateAll

updateAll(playingHumans: default<unknown, number, NPC | Player>[]): void
Parameters
- playingHumans: default<unknown, number, NPC | Player>[]
Returns void
- Defined in src/game/game/entity/creature/CreatureManager.ts:440

updateFov

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

`Static` generateLookups

generateLookups(): void
Returns void
- Defined in src/game/game/entity/creature/CreatureManager.ts:73

`Static` getName

getName(creature: default | CreatureType, aberrant?: boolean, count?: number, article?: Article): default
Parameters
- creature: default | CreatureType
- Optional aberrant: boolean
- Optional count: number
- Optional article: Article
Returns default
- Defined in src/game/game/entity/creature/CreatureManager.ts:96

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

island: default

objects: SaferArray<default> = []

Returns default

Properties

event

Protected Readonly island

list

Protected Readonly name

Protected Readonly objects

Protected Readonly reregisterObjectsForMemoryLeaks

Static combatStrength

Static list

Accessors

combatStrength

Returns default

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

createFake

Parameters

type: CreatureType

aberrant: boolean

Optional tile: default

id: number = -1

Returns default

delete

Returns void

exists

Parameters

creature: default

Returns boolean

findUnusedId

Returns number

get

Parameters

id: number

Returns undefined | default

getHappinessLevel

Parameters

human: default<unknown, number, NPC | Player>

creature: default

bonus: number = 0

Returns number

getMovePenalty

Returns

Parameters

moveType: MoveType

tile: default

willMove: boolean

Optional options: Partial<ICreatureCheckMoveOptions>

Optional creature: default

Returns number

getMovePenaltyFromWasm

Parameters

moveType: MoveType

x: number

y: number

z: number

`Protected` `Readonly` island

`Protected` `Readonly` name

`Protected` `Readonly` objects

`Protected` `Readonly` reregisterObjectsForMemoryLeaks

`Static` combatStrength

`Static` list

`Protected` canCreateEntity

`Optional` tile: default

`Optional` options: Partial<ICreatureCheckMoveOptions>

`Optional` creature: default

`Optional` aberrant: boolean

`Optional` count: number

`Optional` article: Article

`Protected` onRemove

`Optional` options: {
remainTamed?: boolean;
}

`Optional` remainTamed?: boolean

`Protected` registerForMemoryLeakDetection

`Optional` options: {
remainTamed?: boolean;
}

`Optional` remainTamed?: boolean

`Protected` removeNulls

`Optional` bypass: boolean

`Optional` forceAberrant: boolean

`Optional` spawnTiles: TileGroup

`Optional` bypassCreatureLimit: boolean

`Optional` bypassCreatureLimit: boolean

`Optional` checkTerrainType: boolean