Class EnvironmentalSystem

Implements

IEnvironmentalSystem

Index

Constructors

Methods

setEnvironmentalContext applyModifiers registerModifier unregisterModifier getModifiers getActiveModifiers isModifierActive clearActiveModifiers getStats

Constructors

constructor

new EnvironmentalSystem(chance?: Chance): EnvironmentalSystem
Parameters
- chance: Chance = ...
Returns EnvironmentalSystem
- Defined in environment/EnvironmentalSystem.ts:57

Methods

setEnvironmentalContext

setEnvironmentalContext(context: EnvironmentalContext): void
Set environmental context and activate appropriate modifiers
Parameters
- context: EnvironmentalContext
Returns void
Implementation of IEnvironmentalSystem.setEnvironmentalContext
- Defined in environment/EnvironmentalSystem.ts:158

applyModifiers

applyModifiers(event: any): ModifiedEvent
Apply all active modifiers to an event
Parameters
- event: any
Returns ModifiedEvent
Implementation of IEnvironmentalSystem.applyModifiers
- Defined in environment/EnvironmentalSystem.ts:180

registerModifier

registerModifier(
modifierId: string,
modifierConfig: Omit<Modifier, "id" | "registeredAt">,
): void
Register a custom environmental modifier
Parameters
- modifierId: string
- modifierConfig: Omit<Modifier, "id" | "registeredAt">
Returns void
Implementation of IEnvironmentalSystem.registerModifier
- Defined in environment/EnvironmentalSystem.ts:319

unregisterModifier

unregisterModifier(modifierId: string): boolean
Unregister a custom modifier
Parameters
- modifierId: string
Returns boolean
- Defined in environment/EnvironmentalSystem.ts:335

getModifiers

getModifiers(): { [id: string]: Modifier }
Get all registered modifiers

Returns { [id: string]: Modifier }
- Defined in environment/EnvironmentalSystem.ts:349

getActiveModifiers

getActiveModifiers(): string[]
Get currently active modifiers

Returns string[]
Implementation of IEnvironmentalSystem.getActiveModifiers
- Defined in environment/EnvironmentalSystem.ts:360

isModifierActive

isModifierActive(modifierId: string): boolean
Check if a modifier is active
Parameters
- modifierId: string
Returns boolean
- Defined in environment/EnvironmentalSystem.ts:367

clearActiveModifiers

clearActiveModifiers(): void
Clear all active modifiers

Returns void
- Defined in environment/EnvironmentalSystem.ts:374

getStats

getStats(): {
    totalModifiers: number;
    activeModifiers: number;
    modifierTypes: { [type: string]: number };
}
Get environmental system statistics

Returns {
    totalModifiers: number;
    activeModifiers: number;
    modifierTypes: { [type: string]: number };
}
- Defined in environment/EnvironmentalSystem.ts:381