Class default

Hierarchy

Host<ITemperatureManagerEvents>
- default

Implements

IPreSerializeCallback

Constructors

constructor

new default(island: default): default
Parameters
- island: default
Returns default
Overrides EventEmitter.Host<ITemperatureManagerEvents>.constructor
- Defined in src/game/game/temperature/TemperatureManager.ts:136

Properties

encodedCalculatedCache

encodedCalculatedCache: Map<number, Map<number, Uint32Array>> = ...

encodedGuaranteedCorrectCache

encodedGuaranteedCorrectCache: Map<number, Map<number, Uint32Array>> = ...

encodedProducedCache

encodedProducedCache: Map<number, Map<number, Uint32Array>> = ...

`Readonly` event

event: IEventEmitter<default, ITemperatureManagerEvents>

temperatureBoundaryMaxVector

temperatureBoundaryMaxVector: default

Methods

addLayer

addLayer(z: WorldZ): void
Parameters
- z: WorldZ
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:213

clearAll

clearAll(): void
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:140

clearContainerCache

clearContainerCache(container: IContainer): void
Clears temperature caching for the container
Parameters
- container: IContainer
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:271

clearContainerCacheByHash

clearContainerCacheByHash(containerHash: string): void
Clears temperature caching for the container
Parameters
- containerHash: string
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:278

clearContainerCaches

clearContainerCaches(): void
Clears all container caches

Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:205

delete

delete(): void
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:232

get

get(tile: default, serverSideSource: undefined | GetterOfOr<string>): number
Returns the current overall temperature for the given tile.
Parameters
- tile: default
- serverSideSource: undefined | GetterOfOr<string>
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:407

getBiomeBase

getBiomeBase(): number
Returns the base temperature.

Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:438

getBiomeRange

getBiomeRange(): Readonly<IRange>
Returns Readonly<IRange>
- Defined in src/game/game/temperature/TemperatureManager.ts:449

getBiomeTimeModifier

getBiomeTimeModifier(time?: default): number
Returns the temperature modifier at the given time.
Parameters
- Optional time: default
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:445

getCachedCalculated

getCachedCalculated(__namedParameters: IVector3, type: TempType): number
Returns the cached calculated temperature for a tile. If a tile has not been calculated yet, this will return TEMPERATURE_INVALID.
Parameters
- __namedParameters: IVector3
- type: TempType
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:514

getCachedProduced

getCachedProduced(__namedParameters: IVector3, type: TempType): number
Returns the cached produced temperature on a tile. If the production of a tile has not been calculated yet, this will return TEMPERATURE_INVALID.
Parameters
- __namedParameters: IVector3
- type: TempType
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:521

getContainer

getContainer(container: IContainer, serverSideSource: undefined | GetterOfOr<string>): number
Returns the current temperature for a container, calculated by combining the tile temperature and the combined temperature of the items inside
Parameters
- container: IContainer
- serverSideSource: undefined | GetterOfOr<string>
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:287

getContainerItemsTemperature

getContainerItemsTemperature(container: IContainer, containerHash?: string): undefined | number
Get the combined temperature of the items in the container.

Returns
temperature or undefined if the container/contained items do not produce temperatures
Parameters
- container: IContainer
- containerHash: string = ...
Returns undefined | number
- Defined in src/game/game/temperature/TemperatureManager.ts:366

getContainerProducedTemperature

getContainerProducedTemperature(container: IContainer, containerHash?: string, applyInsulation?: boolean): undefined | number
Returns the produced temperature for this container, calculated by combining the min and max temperatures of the items inside.

Returns
temperature or undefined if the container/contained items do not produce temperatures
Parameters
- container: IContainer
- containerHash: string = ...
- applyInsulation: boolean = true
  
  Whether to apply the container's insulation to the produced temperature value. For example, containers with no insulation return the exact temperature they produce, while containers with maximum insulation return Temperature.Neutral
Returns undefined | number
- Defined in src/game/game/temperature/TemperatureManager.ts:351

getLayer

getLayer(z: WorldZ, time?: default): number
Returns the temperature modifier of the given layer, at the given time.
Parameters
- z: WorldZ
- Optional time: default
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:457

getLayerBase

getLayerBase(z: WorldZ): number
Parameters
- z: WorldZ
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:462

getLayerRange

getLayerRange(z: WorldZ): IRange
Parameters
- z: WorldZ
Returns IRange
- Defined in src/game/game/temperature/TemperatureManager.ts:470

getLayerTimeModifier

getLayerTimeModifier(z: WorldZ, time?: default): number
Parameters
- z: WorldZ
- Optional time: default
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:466

getRange

getRange(tile: default, serverSideSource: undefined | GetterOfOr<string>): IRange
Parameters
- tile: default
- serverSideSource: undefined | GetterOfOr<string>
Returns IRange
- Defined in src/game/game/temperature/TemperatureManager.ts:423

getTile

getTile(tile: default, serverSideSource: undefined | GetterOfOr<string>): number
Returns the temperature of the given tile, produced by combining the temperatures of each type.
Parameters
- tile: default
- serverSideSource: undefined | GetterOfOr<string>
Returns number
- Defined in src/game/game/temperature/TemperatureManager.ts:488

initialize

initialize(): void
Called after the island map size is configured

Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:152

`Protected` onChangeZ

onChangeZ(human: default<unknown, number, NPC | Player>): void
Run inventory updates when human changes Z
Parameters
- human: default<unknown, number, NPC | Player>
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:795

`Protected` onCreateOrRemoveObject

onCreateOrRemoveObject(_: any, object: default | default | default | default): void
Parameters
- _: any
- object: default | default | default | default
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:671

`Protected` onDoodadFireUpdate

onDoodadFireUpdate(object: default, tile: default, stage?: FireStage): void
Parameters
- object: default
- tile: default
- Optional stage: FireStage
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:621

`Protected` onDoodadTransformed

onDoodadTransformed(object: default, newType: DoodadType, oldType: DoodadType): void
Parameters
- object: default
- newType: DoodadType
- oldType: DoodadType
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:635

`Protected` onEntityMove

onEntityMove(object: default<unknown, number, EntityReferenceTypes, unknown>, lastTile: default, tile: default): void
Parameters
- object: default<unknown, number, EntityReferenceTypes, unknown>
- lastTile: default
- tile: default
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:705

`Protected` onHumanUnequip

onHumanUnequip(object: default<unknown, number, NPC | Player>, item: default, slot: EquipType): void
Parameters
- object: default<unknown, number, NPC | Player>
- item: default
- slot: EquipType
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:691

`Protected` onItemContainerAdd

onItemContainerAdd(itemManager: default, items: default[], container?: IContainer): void
Parameters
- itemManager: default
- items: default[]
- Optional container: IContainer
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:746

`Protected` onItemContainerRemove

onItemContainerRemove(itemManager: default, items: default[], container: undefined | IContainer, containerTile: undefined | default): void
Parameters
- itemManager: default
- items: default[]
- container: undefined | IContainer
- containerTile: undefined | default
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:763

`Protected` onItemFireUpdate

onItemFireUpdate(item: default): void
Parameters
- item: default
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:782

`Protected` onItemTransformed

onItemTransformed(object: default, newType: ItemType, oldType: ItemType): void
Parameters
- object: default
- newType: ItemType
- oldType: ItemType
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:644

`Protected` onPlay

onPlay(): void
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:802

`Protected` onPlayerIdChanged

onPlayerIdChanged(player: default): void
Parameters
- player: default
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:664

`Protected` onPlayerSpawnOrRemove

onPlayerSpawnOrRemove(_: any, player: default): void
Parameters
- _: any
- player: default
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:656

`Protected` onTerrainChange

onTerrainChange(island: default, tile: default, oldType: TerrainType): void
Parameters
- island: default
- tile: default
- oldType: TerrainType
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:737

`Protected` onTickEnd

onTickEnd(island: default): void
Parameters
- island: default
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:819

`Protected` onTickStart

onTickStart(island: default): void
Parameters
- island: default
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:810

`Protected` onTileEventFireUpdate

onTileEventFireUpdate(object: default, tile: default, stage?: FireStage): void
Parameters
- object: default
- tile: default
- Optional stage: FireStage
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:628

preSerializeObject

preSerializeObject(): void
Returns void
Implementation of IPreSerializeCallback.preSerializeObject
- Defined in src/game/game/temperature/TemperatureManager.ts:237

update

update(invalidateContainers?: boolean, source: GetterOfOr<string>): void
Parameters
- invalidateContainers: boolean = true
- source: GetterOfOr<string>
Returns void
- Defined in src/game/game/temperature/TemperatureManager.ts:855

Class default

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

island: default

Returns default

Properties

encodedCalculatedCache

encodedGuaranteedCorrectCache

encodedProducedCache

Readonly event

temperatureBoundaryMaxVector

Methods

addLayer

Parameters

z: WorldZ

Returns void

clearAll

Returns void

clearContainerCache

Parameters

container: IContainer

Returns void

clearContainerCacheByHash

Parameters

containerHash: string

Returns void

clearContainerCaches

Returns void

delete

Returns void

get

Parameters

tile: default

serverSideSource: undefined | GetterOfOr<string>

Returns number

getBiomeBase

Returns number

getBiomeRange

Returns Readonly<IRange>

getBiomeTimeModifier

Parameters

Optional time: default

Returns number

getCachedCalculated

Parameters

__namedParameters: IVector3

type: TempType

Returns number

getCachedProduced

Parameters

__namedParameters: IVector3

type: TempType

Returns number

getContainer

Parameters

container: IContainer

serverSideSource: undefined | GetterOfOr<string>

Returns number

getContainerItemsTemperature

Returns

Parameters

container: IContainer

containerHash: string = ...

Returns undefined | number

getContainerProducedTemperature

Returns

Parameters

container: IContainer

containerHash: string = ...

applyInsulation: boolean = true

Returns undefined | number

getLayer

Parameters

`Readonly` event

`Optional` time: default

`Optional` time: default

`Optional` time: default

`Protected` onChangeZ

`Protected` onCreateOrRemoveObject

`Protected` onDoodadFireUpdate

`Optional` stage: FireStage

`Protected` onDoodadTransformed

`Protected` onEntityMove

`Protected` onHumanUnequip

`Protected` onItemContainerAdd

`Optional` container: IContainer

`Protected` onItemContainerRemove