Reference · Contracts
Events & variables
What crosses the network, and what you can inspect.
CBA events
Names are FF_<component>_<event>. Horror's systems use the FFATM_, FFPP_ and FFSC_ prefixes. Use global
JIP events for state a later player must receive; use owner events for request/response.
| Event | Direction | Purpose |
|---|---|---|
FF_horror_soulShieldRequest | client → server | Request to consume a shield capsule for a corpse. |
FF_horror_soulShieldConsume | server → owner | Authority check and inventory consumption. |
FF_horror_soulShieldResult | server → client | Outcome of a shield request. |
FF_horror_soulShieldApplied | server → clients | A shield was applied; wake ceiling lifted. |
FF_horror_zeusSoulStatus | client → Zeus | Soul roster entry for the curator map. |
FF_horror_zeusSoulCommand | Zeus → client | Apply a recovery action to a soul player. |
FF_horror_flyingSpawn | any → server | Schedule an arrival. |
FF_horror_spawnFX | server → clients | Render flight and impact effects. |
FF_horror_spawnPlaced | server → clients | A placed unit entered the arrival pipeline. |
FF_horror_spawnCommand | Zeus → server | Arrival settings and source commands. |
FF_horror_hordeControl | client → server | Horde create/edit/pause/resume/stop. |
FF_horror_aiBalanceReveal | server → owner | Reveal players on a new AI owner. |
FF_horror_skullCreate / skullAttackEvent / skullCommand / skullHit / skullKill | server ↔ clients | Skull actor lifecycle and per-client rendering. |
FF_horror_registerSkull / unregisterSkull | any → server | Register or retire a skull prop. |
FF_horror_gravityPulse | any → server | Request a pulse job. |
FF_horror_gravityPulseLocal | server → clients | Render a pulse wave locally. |
FF_horror_faultyVision / faultyVisionReplace / faultyVisionCancel | server → unit owner | Apply or cancel optic conversion. |
FF_horror_wardrobeReset / wardrobeSetPolicy | server → clients | Rebuild the wardrobe cache after a policy change. |
FF_horror_aiBalanceReveal | server → owner | Grant player knowledge to transferred AI. |
FF_zeus_volunteer* | client ↔ server | Volunteer service offers, replies and session control. |
FF_utils_readyRoomRequest / readyRoomReply | client ↔ server | Ready-room packets: ready, answers, vote, chat, curator actions. |
FF_utils_readyRoomServerReleased / readyRoomReleased | server → clients | Release with the frozen skip flag and participant UID list. |
FF_utils_readyRoomAudioChanged | local client | The room took or released its music bed. |
FF_utils_powerSupplyChanged | server | Supply edge for a transfer site: `[siteID, connected, state, source, transfer]`. |
FF_utils_solarSolvedChanged | server | Commissioning state for a solar console: `[ID, solved, console]`. |
FF_utils_solarAcknowledged | server → client | Puzzle acknowledgement with generation, sequence, operation and reason. |
FF_utils_terminalPhaseChanged / terminalServiceChanged / terminalExported | server | Terminal lifecycle, service and archive events. |
FF_utils_terminalAcknowledged | server → client | Private terminal view for the requesting body. |
FF_utils_terminalTransmission | server | A channel message was accepted: `[channel, player, callsign, text, isHQ]`. |
FF_utils_fnc_droneRequest / droneReply | client ↔ server | UAV registration, assignment and feed requests with server feedback. |
FF_cinematic_musicHold | local client | External owner claims or releases the music channel. |
FF_spectator_fnc_commandRequest / commandReply | client ↔ server | Spectator command broker: validated typed operations only. |
FF_spectator_fnc_registerRequest / registrationReply | client ↔ server | Viewer session registration and role confirmation. |
FF_utils_* | internal | Utils-internal events use the same component prefix. |
State keys
Read these from mission scripts freely. Write only where the table says so; internal keys are owned by their system.
| Key | Scope | Meaning |
|---|---|---|
FF_horror_state | local | Current soul state hash map. Nil while alive. |
FF_horror_cbrnVisualsSuspended | local | Set while the soul sequence runs so CBRN effects pause. |
FF_horror_cbrnActive | local | True while CBRN simulation runs on this machine. |
FF_horror_cbrnZones | per client / broadcast | Additional runtime hazard zones. |
FF_horror_spawnPending | unit variable | Public marker for third-party scripts while a unit is in flight. |
FF_horror_spawnShared | server | Shared automatic-arrival options. |
FF_horror_aiBalanceExclude | group/unit variable | Exclude a group or unit from AI balancing. |
FF_horror_skullFrozen | mission | Publish to freeze skull motion for photos in multiplayer. |
FF_horror_skullDestination / FF_horror_skullMode | mission | Scripted skull commands; the functions above are the supported path. |
FFPP_enabled / FFPP_epoch / FFPP_snapshots / FFPP_pending | server | Persistence state and epoch guard. |
FFPP_ready | client | Client finished applying a restore plan. |
FFATM_reports / FFATM_autoEnabled / FFATM_override / FFATM_priority | server | Atmosphere report queue and mood control. |
FFATM_localTrack / FFATM_localMode | client | Currently playing track and mode. |
FFATM_shotEvents | client | Rolling window of local gunfire events. |
FFSC_entities / FFSC_overlayIntensity | server / local | Active scare controllers and local stress contribution. |
FF_Overlay1_fade / FF_Overlay2_fade | local | Shared overlay inputs (1 = hidden). |
FF_horror_wardrobePolicy / wardrobeConfig / wardrobeActive | policy / local | Wardrobe policy and runtime state. |
FF_utils_droneRegistered / droneSettings / droneStatus | vehicle + broadcast | UAV registration flag, per-UAV settings and JIP-retained status. |
FF_utils_readyRoomSettings / readyRoomState / readyRoomRecords | server | Room policy, live phase and the private answer map. |
FF_utils_weaponFaultSettings / weaponFaultState | server / client | Repair policy and the client display snapshot with a monotonic revision. |
FF_utils_powerSites / FF_utils_powerState | broadcast / object | Transfer site metadata and per-object lever, charge, trip and supply snapshot. |
FF_utils_solarSites / FF_utils_solarState | broadcast / object | Console metadata and the public challenge plus matrix. |
FF_utils_terminalSites / FF_utils_terminalState | broadcast / object | Terminal metadata and phase, power and service values. |
FF_cinematic_musicPlayer / FF_cinematic_musicHolds | local client | Follower descriptor, active holds and the owned channel volume. |
FF_cinematic_musicDirectorStates / musicDirectorCatalogs | server / broadcast | Director snapshots and public catalogue metadata (no callbacks). |
FF_cinematic_overlays / overlayPFH / overlayGeneration | local client | Active overlays, their worker and the callback generation guard. |
FF_spectator_config | server | Spectator slots, controller policy, admins and the allowCode flag. |