API for Modders

Plugin class

BepInEx plugin entry point. Binds config entries for Bloom and Sickness, patches all Harmony targets, and initializes the custom production API at load.

Cache static class

Controller refs filled by Harmony postfixes. Consumers read e.g. IFZAPI.Cache.Buildings; null until the game has constructed each controller.

Hooks / events

Time static class

Time-of-day helpers. Hour / Sunrise / Sunset / IsNight / NightBlend(transitionHours). Fires once per in-game day at sunset/sunrise.

Hooks / events

Vfx static class

Shared smoke prefab cache + pooled point-light flash system. CloneSmokeAt clones the game's work-site smoke; Flash creates a one-shot point-light that fades with quadratic falloff.

GlowFx static class

Shared additive-glow primitives for 'real glow/bloom' looks (muzzle flashes, tower lamps, beacons, headlights, flares). A Unity Light illuminates surfaces but never blooms on its own; a bright additive sprite at the source does. Centralised here so every mod reuses ONE additive material + shader-resolve + mesh set instead of each re-deriving it.

BloomControl static class

Drives the game's own PPv2 Bloom up at night so emissive sources actually glow. A Unity light illuminates surfaces but emits no bright pixel; bloom is what makes a bright pixel bleed. We boost Bloom on the game's existing ColorSwitcher.ppVolume profile (no camera-layer matching) and restore the captured original on disable. High threshold = only bright HDR emissive blooms, so the dark scene stays readable. Coexists with DarkerNights (which drives ColorGrading / AutoExposure on the same profile — different settings, no clobber).

Reflect static class

Cached AccessTools.Field lookups shared across all consumer mods. Drops ~5-15 static FieldInfo declarations per mod.

FloatParam static class

PostProcessing v2 FloatParameter has a public value field. Wrapping the boxed-getter dance keeps DarkerNights / future lighting mods simpler.

Wine static class

JIT-safety guards for the game's Proton/Wine Mono runtime. The FIRST time Mono compiles a method it can fail to load a callee's IL body and throw BadImageFormatException: 'Method has zero rva'. A DELEGATE invocation is never inlined by Mono, so routing the risky access through one of these guards keeps the cold callee behind a real call boundary.

Combat static class

Per-character outgoing-damage multiplier registry. Additive API surface: writers (e.g. SquadTraits veterancy) set a factor by Character.Id; the sole GetDamage patcher (SquadMoveFire) multiplies its result by it. Default 1f => zero effect until something writes, so no mod is coupled to this.

Production static class

Custom production recipe API for IFZ mods. This static class provides a way for mods to inject custom production recipes into buildings without causing Harmony patch collisions. The API handles all the patching internally and manages both real (local container) and virtual (global container) resource inputs.

RecipeDef sealed class

Definition for a custom production recipe.

ResourceInput struct

Structure representing a resource input in a recipe.

ProductionUI static class

Sole patcher of ProductionBar.RefreshBar — the single injection point for the building info-panel 'SELECT PRODUCTION' rows. RefreshBar rebuilds a row from scratch every call (Clear() destroys the input ResourcePanels / output ProductionCycles, then GetCostPairs/GetProfitPairs repopulate them), so any mod that tweaks a row's icons or labels must re-do it on EVERY refresh. Two Harmony patches on one method crash under Wine (zero-rva, see wine-double-patch-zero-rva) and build.sh fatal-gates the collision — so consumer mods must NOT patch RefreshBar themselves. Subscribe to RowRefreshed instead.

Hooks / events

Radio static class

Shared radio helper. A mod calls it to push ONE message into the vanilla radio — cloud bubble + transmission log + optional call audio — and ONLY when a mod calls it. It never patches, and never mutates, the vanilla radio. Message colour travels as TextMeshPro rich-text markup INSIDE the message string, so the game's own per-message type→colour styling (e.g. danger = white text + highlight box) is left completely intact ('typelocked').

RadioSource enum

WHO's talking — drives the persistent-log speaker + mumble voice. NPC first so zero-value = NPC.

RadioSeverity enum

Legacy severity preset kept for back-compat callers. New code passes a colour hex to Radio.Message directly.

SaveStore static class

Per-save persistence for mods, keyed on the map's stable SaveHandler.Coordinates — NOT SaveInfo.Name, which embeds the in-game clock and drifts every day. That drift silently re-baselines a mod's per-save state on every reload (it bit Expanded Farming and ElderPop before this helper existed: each reload looked like a brand-new save). Layout: one JSON blob per (save, modId) at {SavesDirPath}/.ifzmods/{coordsKey}/{modId}.json — i.e. BESIDE the game's Saves dir (so it travels when a user copies their whole Saves folder) but NOT inside IFZ's per-save timestamped folders — those are recreated on every manual save, so anything written inside one is invisible to the next save of the same game. The coords key is stable across every reload/re-save of the same base location, which is exactly what per-save mod state needs. Serialization is UnityEngine.JsonUtility (Wine-safe, no Newtonsoft): pass a [Serializable] type with PUBLIC FIELDS. JsonUtility does not serialize Dictionary<,> — use a List field instead. All methods are null/exception-safe and no-op when no save is active (see HasSave), so a mod may call them freely without guarding for the main-menu / pre-load window.

SicknessCoordinator static class

The arbiter that stops multiple mods (ExtendedHealth, ElderPop, ...) from independently rolling sickness on the same pop and stacking into a death wave. Consumer mods RegisterSource(modId, fn) once at load; fn returns a per-pop, per-day chance in [0,1] (or <=0 for 'no opinion'). Once per in-game day, at sunset (Time.OnSunset), this runs ONE roll per adult/non-dead/non-sick citizen: merges every registered source's chance (Max or SumClamped — CombineMode), rolls once, and caps the day's total NEW infections to a shared fraction of the population (MaxNewSickPerDayFraction, min 1) so no combination of mods can out-sick the vanilla die-chance/medicine/treatment-bed pipeline in one day. All actual sickness still goes through the game's own SicknessController.MakeCharacterSick, so existing recovery/death machinery is untouched — this only gates WHO gets sick and WHEN.

Hooks / events

Panels static class

Consumer entry point. Register a builder once; it re-runs on every Game-scene load.

PanelContext sealed class

Builder context passed to the Action<PanelContext> callback. Creates a ModWindow and returns it.

ModWindow sealed partial class

A single in-game window with header, body, and row-based layout. Supports drag, resize, collapse, and toggle.

ListRegion sealed class

A vertical container for ListRow items. Created by ModWindow.List().

ListRow sealed class

A horizontal row inside a ListRegion. Created by ListRegion.Row().

Theme struct

A color and layout configuration applied to windows and their elements.

SizeMode struct

Sizing mode for a window: AutoHeight (content-driven), Fixed, or Resizable.

IconKind enum

Icon types rendered by IconGraphic.

IconGraphic sealed class

A MaskableGraphic that draws icons (play, pause, prev, next, shuffle, list, lock, disc) as vector shapes.

GraphKind enum

Graph types rendered by GraphGraphic.

GraphGraphic sealed class

A MaskableGraphic that draws line or bar graphs from a list of float values.

GraphHandle struct

Handle to update graph values, range, and color.

ResizeGrip sealed class

Bottom-right drag grip that resizes Target within [Min, Max]. Fires Resized on end-drag.

PointerHold sealed class

Tracks whether a pointer is held (down/up). Implements IPointerDownHandler, IPointerUpHandler.

HoverTooltip sealed class

Shows/hides a Tooltip GameObject on pointer enter/exit.

DraggablePanel sealed class

Makes a panel draggable by pointer. Implements IPointerDownHandler, IDragHandler, IEndDragHandler.

CameraZoomHoverBlocker sealed class

Blocks camera zoom movement while pointer hovers over the panel. Implements IPointerEnterHandler, IPointerExitHandler.

WindowStore static class

Persists window state (position, size, collapsed, visible) to a JSON file under the DLL directory.

WindowState struct (Serializable)

Serializable snapshot of a window's state for persistence.

LabelHandle struct

Handle to update a label's text or color.

ValueRow struct

Handle to update a value row's text or color.

BarHandle struct

Handle to update a bar's fill, color, or label.

ButtonHandle struct

Handle to update a button's interactability or label.

SliderHandle struct

Handle to get/set a slider's value.

ToggleHandle struct

Handle to get/set a toggle's state.

InputHandle struct

Handle to get/set an input field's text.

SeparatorHandle struct

Handle for a separator (no members).

Plugin class

BepInEx plugin entry point for IFZModDialog. Exists so consumer mods can BepInDependency on it for load order, and to own the shared logger.

DialogOption class

One choice on a radio prompt: a button label and the C# callback run when the player picks it.

RadioPrompt static class

Fire the game's native radio transmission modal with 1–4 player-choice buttons, and route each click to a C# callback. Uses the real transmission lifecycle (load → show → play → answer → close), so audio and UI teardown are handled by the game.