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

Properties

`Readonly` event

event: IEventEmitter<default, ICreatureManagerEvents>

`Protected` `Readonly` island

island: default

`Protected` `Readonly` objects

objects: SaferArray<default>

`Static` combatStrength

combatStrength: default

Accessors

combatStrength

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

game

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

length

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

Methods

[iterator]

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

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

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

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

exists

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

findUnusedId

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

get

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

getHappinessLevel

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

getMovePenalty

getMovePenalty(moveType: MoveType, tile: default, willMove: boolean, options?: Partial<ICreatureCheckMoveOptions>): 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 theres an existing npc/creature there and return false if so
- Optional options: Partial<ICreatureCheckMoveOptions>
Returns number
- Defined in src/game/game/entity/creature/CreatureManager.ts:498

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

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

getObjects

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

getSpawnableCreatures

getSpawnableCreatures(creatureGroup: SpawnGroup, z: number, reputation?: number, time?: number): {
aberrantChance: number;
pool: CreatureType[];
}
Parameters
- creatureGroup: SpawnGroup
- z: number
- reputation: number = ...
- time: number = ...
Returns {
aberrantChance: number;
pool: CreatureType[];
}
- aberrantChance: number
- pool: CreatureType[]
- Defined in src/game/game/entity/creature/CreatureManager.ts:629

load

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

maybeSpawnClawWorm

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

maybeSpawnDryad

maybeSpawnDryad(target: default<number>): void
Maybe spawns a Dryad based on target reputation, plants around target, and chance.
Parameters
- target: default<number>
  
  Human that we check around to find a suitable spawn.
Returns void
- Defined in src/game/game/entity/creature/CreatureManager.ts:432

onUnserialized

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

`Protected` registerForMemoryLeakDetection

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

remove

remove(creature: default, remainTamed?: boolean): void
Parameters
- creature: default
- Optional remainTamed: boolean
Returns void
Overrides default.remove
- Defined in src/game/game/entity/creature/CreatureManager.ts:463

`Protected` removeNulls

removeNulls(): void
Returns void
Inherited from default.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 default.set
- Defined in src/game/game/ObjectManager.ts:71

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

spawnFromGroup

spawnFromGroup(creatureGroup: SpawnGroup, tile: default, bypass?: boolean, bypassCreatureLimit?: boolean): undefined | default
Parameters
- creatureGroup: SpawnGroup
- tile: default
- Optional bypass: boolean
- Optional bypassCreatureLimit: boolean
Returns undefined | default
- Defined in src/game/game/entity/creature/CreatureManager.ts:324

spawnGuardians

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

updateAll

updateAll(playingHumans: default<number>[]): void
Parameters
- playingHumans: default<number>[]
Returns void
- Defined in src/game/game/entity/creature/CreatureManager.ts:477

updateFov

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

`Static` generateLookups

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

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

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 combatStrength

Accessors

combatStrength

Returns default

game

Returns Game

length

Returns number

Methods

[iterator]

Returns IterableIterator<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<number>

creature: default

bonus: number = 0

Returns number

getMovePenalty

Returns

Parameters

moveType: MoveType

tile: default

willMove: boolean

Optional options: Partial<ICreatureCheckMoveOptions>

Returns number

getMovePenaltyFromWasm

Parameters

moveType: MoveType

x: number

y: number

z: number

Returns number

getName

Parameters

creature: default | CreatureType

Optional aberrant: boolean

Optional count: number

Optional article: Article

Returns default

`Readonly` event

`Protected` `Readonly` island

`Protected` `Readonly` objects

`Static` combatStrength

`Protected` canCreateEntity

`Optional` tile: default

`Optional` options: Partial<ICreatureCheckMoveOptions>

`Optional` aberrant: boolean

`Optional` count: number

`Optional` article: Article

Returns {
aberrantChance: number;
pool: CreatureType[];
}

`Protected` registerForMemoryLeakDetection

`Optional` remainTamed: boolean

`Protected` removeNulls

`Optional` bypass: boolean

`Optional` forceAberrant: boolean

`Optional` spawnTiles: TileGroup

`Optional` bypassCreatureLimit: boolean

`Optional` bypass: boolean

`Optional` bypassCreatureLimit: boolean

`Static` generateLookups