Class StormDamage

Accumulates wind damage from a Weather into a DamageTarget: every interval seconds, wherever the wind (with gusts) is above threshold, damage grows with the excess. Deterministic per tick: ticks sit at fixed times, so the same weather and time range give the same damage. Damage is never undone when time goes backwards.

Index

Constructors

constructor

new StormDamage(
    weather: Weather,
    target: DamageTarget,
    input?: Partial<StormDamageOptions>,
): StormDamage
Creates storm damage for target; anything not given uses DEFAULT_STORM_DAMAGE.
Parameters
- weather: Weather
- target: DamageTarget
- input: Partial<StormDamageOptions> = {}
Returns StormDamage
- Defined in weathering/src/damage.ts:86

Properties

options

options: StormDamageOptions

Resolved settings.

target

target: DamageTarget

Where damage goes.

weather

weather: Weather

The weather read for wind.

Methods

reset

reset(input?: Partial<StormDamageOptions>): this
Replaces all settings (anything not given goes back to defaults).
Parameters
- input: Partial<StormDamageOptions> = {}
Returns this
- Defined in weathering/src/damage.ts:99

set

set(input: Partial<StormDamageOptions>): this
Merges input into the settings.
Parameters
- input: Partial<StormDamageOptions>
Returns this
- Defined in weathering/src/damage.ts:93

update

update(time: number): void
Processes every damage tick up to time seconds. The first call only sets the starting time.
Parameters
- time: number
Returns void
- Defined in weathering/src/damage.ts:105

Class StormDamage

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StormDamage

Properties

options

target

weather

Methods

reset

Parameters

Returns this

set

Parameters

Returns this

update

Parameters

Returns void

Settings

On This Page