Modules

This page lists the 19 addons and their functions. Each function file is functions/fnc_<name>.sqf. Functions use the name aee_<component>_fnc_<name>.

core

The orchestrator. It initialises the mod, registers the EDEN module, updates the environment, and reports diagnostics.

Function	Purpose
`calculateSeededWeatherProgression`	Compute a deterministic weather quality factor from a seeded LCG
`calculateSolarRadiation`	Calculate the solar radiation factor from date, time and latitude
`deterministicRandom`	Generate a deterministic pseudo-random value from two integer seeds
`diagnostic`	Report diagnostic information
`init`	Initialise the mod at mission start
`moduleInit`	Initialise the EDEN module
`moduleStormInit`	Initialise the storm control EDEN module
`updateEnvironment`	Orchestrate the environment update
`updateSoilMoisture`	Update soil moisture and evaporation

atmos

Atmosphere and weather simulation.

Function	Purpose
`calculateAirframeIcing`	Calculate airframe icing
`calculateCloudCeiling`	Calculate the cloud ceiling
`calculateCloudDevelopment`	Calculate cloud development
`calculateHaze`	Calculate atmospheric haze from humidity and dust suppression
`calculateLightning`	Calculate lightning risk
`calculateMicroburst`	Calculate microburst risk
`calculatePrecipitationPhase`	Determine the precipitation phase from wet-bulb temperature
`calculatePressureTrend`	Calculate the pressure trend
`calculateTurbulence`	Calculate turbulence
`updateFog`	Update fog density
`updateHumidity`	Update humidity
`updatePressure`	Update pressure
`updateWind`	Update wind

thermal

Temperature and thermal effects.

Function	Purpose
`calculateClothingInsulation`	Publish the clothing insulation factor
`calculateFreezingRain`	Calculate freezing rain
`calculateHeatIndex`	Calculate the heat index (NWS Rothfusz)
`calculateHypothermiaRisk`	Calculate hypothermia risk
`calculateThermalCrossover`	Calculate thermal crossover
`calculateWaterTemperature`	Calculate water temperature
`calculateWBGT`	Calculate wet-bulb globe temperature
`updateTemperature`	Update temperature

ballistics

Air density and ballistics.

Function	Purpose
`calculateAirDensity`	Calculate air density
`calculateAmmoTemperature`	Calculate ammunition temperature
`calculateCoriolisDeflection`	Calculate Coriolis deflection
`calculateCrosswindBallistics`	Calculate crosswind ballistics

optics

Optics and visibility effects.

Function	Purpose
`applyAtmosphericSeeingFX`	Apply the atmospheric seeing post-process
`applyDewOnOpticsFX`	Apply the dew on optics overlay
`applyHeatShimmerFX`	Apply heat shimmer effects
`applyMirageFX`	Apply the mirage refract effect
`applyNightGrain`	Apply night low-light film grain
`applyRainOnOpticsFX`	Apply rain on optics effects
`applySnowBlindnessFX`	Apply the snow blindness overlay
`applySolarGlareFX`	Apply the solar glare veiling effect
`calculateAtmosphericSeeing`	Calculate atmospheric seeing
`calculateAttenuation`	Calculate light attenuation
`calculateDewOnOptics`	Calculate dew on optics
`calculateMirageIntensity`	Calculate mirage intensity
`calculatePrecipitationVisibility`	Calculate visibility in precipitation
`calculateRainOnOptics`	Calculate rain on optics
`calculateSmokePersistence`	Calculate smoke persistence
`calculateSnowBlindness`	Calculate snow blindness
`calculateSolarGlare`	Calculate solar glare
`calculateThermalContrast`	Calculate thermal contrast
`calculateVehicleHeatShimmer`	Calculate vehicle heat shimmer
`managePostProcess`	Manage the shared post-process effects

mobility

Vehicle and ground mobility.

Function	Purpose
`applyFlightTurbulence`	Apply per-frame turbulence forces to aircraft
`calculateEnginePower`	Calculate engine power
`calculateHelicopterLift`	Calculate helicopter lift
`calculateMudAccretion`	Calculate mud accretion
`calculateRiverWaterLevel`	Calculate river water level
`calculateRouteDegradation`	Calculate route degradation
`calculateSoilBearingStrength`	Calculate soil bearing strength
`calculateTraction`	Calculate traction
`updateGroundState`	Update the ground state

environmental

Environmental and seasonal effects.

Function	Purpose
`calculateAvalancheRisk`	Calculate avalanche risk
`calculateBiologicalAmbient`	Calculate biological ambient effects
`calculateCBRNPersistence`	Calculate CBRN persistence
`calculateCropState`	Calculate crop state
`calculateDustSuppression`	Calculate dust suppression
`calculateFireSpreadRisk`	Calculate fire spread risk
`calculateFlashFloodRisk`	Calculate flash flood risk
`calculateFogBaseAltitude`	Calculate the fog base altitude from the dewpoint spread
`calculateFreezeThawCycling`	Calculate freeze-thaw cycling
`calculateFrostOnWindscreens`	Calculate frost on windscreens
`calculateLunarIllumination`	Calculate lunar illumination
`calculateQNH`	Calculate QNH and pressure altitude
`calculateSevereWeather`	Calculate severe weather
`calculateSnowAccumulation`	Calculate snow accumulation
`calculateSpaceWeather`	Calculate space weather
`calculateSurfaceWetness`	Calculate surface wetness from wetting and drying
`classifyBiome`	Classify the climate with the Koppen algorithm
`getBiome`	Get the current biome
`getClimateNormals`	Get the climate normals
`updateSeasonalFoliage`	Update seasonal foliage
`updateSoundPropagation`	Update sound propagation

maritime

Sea state and tides.

Function	Purpose
`calculateCompassDeviation`	Calculate compass deviation
`calculateSeaState`	Calculate the sea state
`calculateTidalPrediction`	Calculate the tidal prediction

physiology

Physiological effects.

Function	Purpose
`applyHeatStressHUD`	Apply the heat stress HUD
`calculateAltitudeAcclimatization`	Calculate altitude acclimatisation
`calculateBatteryTemperatureDerating`	Calculate battery temperature derating
`calculateDehydrationRisk`	Calculate dehydration risk
`calculateHypoxia`	Calculate hypoxia risk from oxygen altitude
`calculateScentDispersion`	Calculate scent dispersion
`calculateUVIndex`	Calculate the UV index

radio

Radio propagation.

Function	Purpose
`calculateIonosphericAbsorption`	Calculate HF ionospheric absorption
`calculateRadioPropagation`	Calculate radio propagation

fx

Visual and audio effects.

Function	Purpose
`applyAtmosphericDust`	Apply airborne dust particles
`applyBreathCondensation`	Apply breath condensation
`applyRainSurfaceDrops`	Apply rain surface drop particles
`applyRainVehicleSound`	Apply rain vehicle sound
`applyVehicleDust`	Apply vehicle dust
`applyWindNoise`	Apply wind noise
`calculateLightningStrikeEffects`	Roll lightning fire ignition and publish the strike position
`checkParticleBudget`	Check the particle source budget
`registerParticleSource`	Register a particle source with the budget tracker
`triggerLightning`	Trigger lightning
`triggerSevereWeatherFX`	Trigger severe weather effects

actions

Player actions and reports.

Function	Purpose
`calculateWeatherReport`	Calculate the weather report
`openAltimeter`	Open the altimeter
`openWeatherReport`	Open the weather report

main

The bootstrapper. It loads the mod and its dependencies.

Compat addons

The compat addons gate on their host mod. Each uses requiredAddons and skipWhenMissingDependencies. A compat addon loads only when its host mod is present.

Addon	Function	Purpose
`compat_ace3`	`integrateKestrel`	Populate ACE3 weather state for the Kestrel
`compat_ace3`	`integrateMedical`	Integrate ACE3 medical
`compat_acm`	`integrateACM`	Integrate ACM
`compat_acm`	`registerHypoxiaDutyFactor`	Register the hypoxia duty factor with ACM
`compat_acre2`	`integrateACRE2`	Integrate ACRE2
`compat_kat`	`integrateKAT`	Integrate KAT
`compat_realweather`	`integrateRealWeather`	Read weather.json and publish real values
`compat_tfar`	`integrateTFAR`	Integrate TFAR