API · FF: Zeus

FF: Zeus functions

Curator footer, FPS monitoring, Alt look orders, volunteer/RP service and the dialogs for drones, music, ready room and weapon faults.

59 functions 14 public 7 categories x\FF\addons\zeus_suite FF_zeus_suite.pbo

Volunteer service 15

Offer, accept and release AI bodies for willing players. System internals

Function	Exposure	Purpose	Lines
`volunteerOpen`	public	Opens the RP panel, resolving an attached or selected AI target.	27
`volunteerStart`	public	Starts or stops the opted-in volunteer/RP service on each role.	52
`volunteerClientTick`	internal	Maintains volunteer controls through display and player changes.	29
`volunteerCuratorLoad`	internal	Adds volunteer controls to vanilla Zeus while the service is enabled.	24
`volunteerCut`	internal	volunteerCut operation for the opt-in roleplay service.	33
`volunteerDrawPlayers`	internal	volunteerDrawPlayers operation for the opt-in roleplay service.	26
`volunteerKeyDown`	internal	Handles keys only while an offer or volunteer session is active.	24
`volunteerLoad`	internal	volunteerLoad operation for the opt-in roleplay service.	32
`volunteerOfferHUD`	internal	volunteerOfferHUD operation for the opt-in roleplay service.	31
`volunteerReceive`	internal	volunteerReceive operation for the opt-in roleplay service.	60
`volunteerRefresh`	internal	volunteerRefresh operation for the opt-in roleplay service.	23
`volunteerRelease`	internal	volunteerRelease operation for the opt-in roleplay service.	23
`volunteerRequest`	internal	volunteerRequest operation for the opt-in roleplay service.	65
`volunteerServerTick`	internal	Expires offers, releases invalid sessions and publishes the roster.	28
`volunteerSwitch`	internal	volunteerSwitch operation for the opt-in roleplay service.	17

Alt-look AI ordering and the shared look registry. System internals

Function	Exposure	Purpose	Lines
`lookApply`	internal	Applies a validated server look order on the unit's owner.	17
`lookRequest`	internal	Validates a curator's look orders and forwards them to unit owners.	24
`zeusLookLoad`	internal	Let a curator point selected AI infantry with Alt while the display is open.	54
`zeusLookTick`	internal	Preview the cursor target and periodically send doWatch to each unit owner.	52
`zeusLookUnload`	internal	Remove input, map, and frame handlers when the curator display closes.	23

Curator control of registered Cinematic directors. System internals

Function	Exposure	Purpose	Lines
`musicDirectorApply`	alias	Converts local ZEN fields into a bounded generation-aware curator request.	19
`musicDirectorChoose`	alias	Builds localized controls from current public director metadata without transmitting code.	39
`musicDirectorDialog`	internal	Lists optional Cinematic directors with current track and source diagnostics.	27

Curator dialogs for UAVs, the ready room, weapon faults and the terminal HQ.

Function	Exposure	Purpose	Lines
`readyRoomDialog`	alias	Opens optional curator controls for ready-room lifecycle operations.	17
`weaponFaultDialog`	alias	Configures an explicit targeted or global firearm fault/recovery request.	21
`droneDialog`	internal	Opens optional curator controls for explicitly selected UAVs and live feeds.	33
`droneDialogApply`	alias	Translates curator choices into authenticated Utils requests.	36
`terminalHQ`	alias	Selects a registered terminal for curator communications.	23

Opt-in curator diagnostics toolbar and the operations behind it. System internals

Function	Exposure	Purpose	Lines
`adminToolbar`	public	Shows or hides the opt-in local curator F-key diagnostics toolbar.	47
`adminToolsStop`	public	Removes local diagnostics and restores the player's captured damage setting.	15
`adminMarkersStop`	internal	Removes the local curator unit-marker drawing handler.	11
`adminToolsApply`	internal	Applies a server-authorized curator diagnostic to the local player only.	44
`adminToolsDialog`	internal	Offers opt-in local admin diagnostics to the active curator.	16
`adminToolsRequest`	internal	Authenticates a curator's self-directed admin tools request.	13
`adminToolsTick`	internal	Refreshes nearby marker subjects and releases tools after curator or player changes.	13

Read-only local screens rendered for the curator, in a full view or a bottom preview. System internals

Function	Exposure	Purpose	Lines
`screenPreviewOpen`	public	Opens a registered screen as an independent full view or bottom Zeus preview.	44
`screenPreviewRegister`	public	Registers a local read-only Zeus screen renderer.	15
`screenPreviewStop`	public	Closes the small Zeus preview without closing a full view.	17
`screenPreviewUnregister`	public	Removes a local screen renderer and closes its active views.	16
`screenPreviewDialog`	internal	Selects a locally registered read-only screen and view mode from Zeus.	22
`screenPreviewLoad`	internal	Initializes an independent read-only browser for a registered local screen.	37
`screenPreviewSyncPower`	internal	Registers read-only previews for replicated FF Utils transfer sites.	53
`screenPreviewTick`	internal	Updates open read-only screens and closes them when curator access ends.	29
`screenPreviewUnload`	internal	Releases a preview browser without disturbing another active view.	17

Footer registry, status rates, FPS monitoring and optional service wiring. System internals

Function	Exposure	Purpose	Lines
`fpsSettingsDialog`	public	Opens optional ZEN controls for the shared FPS reporting interval.	15
`loadoutRecoveryDialog`	alias	Opens curator controls to save or restore a player's loadout snapshot.	17
`registerZeusFooterStatus`	public	register a Zeus footer field on the machine that owns its value.	32
`unregisterZeusFooterStatus`	public	remove a footer field registered on this machine.	13
`persistenceZeusInit`	alias	Registers an optional ZEN control for reconnect recovery.	25
`statusRatesRequest`	internal	Sets reporting intervals after server curator/ownership validation.	18
`zenInit`	internal	Registers optional shared Zeus modules when ZEN is available.	40
`zeusFooterClientTick`	internal	Merge replicated and local fields, then size the footer to fit its contents.	48
`zeusFooterInit`	internal	Register FF_Horror's server-owned fields and start one shared updater.	34
`zeusFooterLoad`	internal	Attach a passive footer to the vanilla curator display (also used by ZEN).	29
`zeusFooterServerTick`	internal	Run server callbacks and broadcast changed footer values.	9
`zeusFooterUnload`	internal	Stop local updates when the curator display closes.	15
`zeusFooterUpdate`	internal	Refresh due callbacks in registration order and return their display rows.	24
`zeusFooterWatch`	internal	Fallback for display load/unload events, including repeated Zeus opens.	11
`zeusFpsTick`	internal	Publish current-body FPS at the configured reporting interval.	13