API · FF: Cinematic

FF: Cinematic functions

Camera paths, overlay renderer, gravity pulses and the shared music playback and director services. Presentation only, no gameplay side effects.

53 functions 29 public 8 categories x\FF\addons\cinematic FF_cinematic.pbo

Music director 10

Catalogues, pools, priority events and timed forced selections. System internals

Function	Exposure	Purpose	Lines
`musicDirectorControl`	public	Applies explicit server-local selection, priority, timed-force and source controls.	49
`musicDirectorStart`	public	Registers an opt-in server music director without activating client audio.	28
`musicDirectorState`	public	Returns a public director descriptor suitable for the local music follower.	14
`musicDirectorStop`	public	Removes one server director and its shared timeline; followers receive silence.	19
`musicCatalog`	internal	Normalizes track catalogues and pools without requiring any themed soundtrack.	37
`musicDirectorAdminReply`	internal	Displays whitelisted server feedback for curator music commands.	12
`musicDirectorAdminRequest`	alias	Authenticates bounded curator commands and rejects stale director incarnations.	37
`musicDirectorCommand`	internal	Normalizes the bounded primitive command shared by native and curator director controls.	23
`musicDirectorPublishCatalogs`	internal	Publishes only safe catalogue metadata for optional local curator interfaces.	17
`musicDirectorTick`	internal	Advances registered server directors and publishes only changed primitive timelines.	53

The local follower: source descriptors, holds, fades and seeking. System internals

Function	Exposure	Purpose	Lines
`musicHold`	public	Adds/removes a local external music-channel hold before another system takes ownership.	17
`musicStart`	public	Acquires the local music follower with an explicit source and channel gate.	46
`musicStop`	public	Stops the named follower, with optional ownership-token protection.	21
`musicOffset`	internal	Computes synchronized seek offsets and rejects expired one-shot playback.	15
`musicOverrides`	internal	Advances priority completion and queued timed overrides using an authoritative clock.	23
`musicPlan`	internal	Plans normal, descending-rank and completed-one-shot transitions.	22
`musicRelease`	internal	Relinquishes only the follower's owned channel, optionally yielding without touching foreign audio.	24
`musicRequest`	internal	Validates a synchronized local music descriptor without invoking game audio.	16
`musicSelect`	internal	Selects and schedules a generic track with no-repeat pool rotation and ranked transitions.	41
`musicSelection`	internal	Normalizes a generic base/forced mood selection.	15
`musicTick`	internal	Follows a shared timeline with late-join seeks, fades, one-shots and explicit external-channel gates.	83

Named overlays, weighted frames, fades and cleanup. System internals

Function	Exposure	Purpose	Lines
`overlayFade`	public	Changes a named overlay's numeric fade or local fade callback with optional token protection.	18
`overlayStart`	public	Starts/replaces a named local animated overlay and returns its ownership token.	27
`overlayStatus`	public	Returns the local control, owner and token for a named overlay.	14
`overlayStop`	public	Removes a named overlay only when its optional ownership token matches.	25
`overlayStopAll`	public	Removes only Cinematic-owned overlays and their worker.	12
`overlayConfig`	internal	Validates local animated-picture configuration and bounds animation costs.	35
`overlayTick`	internal	Renders bounded animated overlays without scheduled scripts or global texture state.	66

Physical briefing consoles with synchronized slides and a readiness roster. System internals

Function	Exposure	Purpose	Lines
`briefingRegister`	public	Registers an opt-in synchronized physical briefing screen and slide deck.	36
`briefingUnregister`	public	Removes a briefing screen and its shared state.	18
`briefingHandleRequest`	internal	Revalidates an authenticated briefing request and updates server-owned state.	41
`briefingPublishSites`	internal	Publishes public briefing screen metadata for current and joining clients.	18
`briefingRequest`	internal	Authenticates a player request for a registered briefing screen.	14
`briefingServerTick`	internal	Publishes synchronized slides and the eligible players' readiness roster.	36

Face-camera planning, staging and the vehicle scene driver. System internals

Function	Exposure	Purpose	Lines
`driveScene`	public	Sends a vehicle's local AI crew to a supplied scene destination.	38
`facecamBroadcast`	public	Starts server staging and sends the synchronized facecam plan to current viewers.	20
`facecamPlan`	public	Plans weighted face-camera appearances across configurable scene blocks.	44
`facecamRestore`	public	Restores a participant staged by Cinematic, including their original vehicle seat.	38
`facecamStage`	public	Temporarily stages a local participant and schedules restoration.	39
`facecamStart`	public	Starts one server-owned facecam staging schedule from a supplied plan.	41
`facecamStop`	public	Cancels the server staging schedule and restores its participants.	17
`facecamView`	public	Plays a facecam plan locally against the supplied synchronized start time.	69
`facecamViewStop`	public	Stops the local facecam viewer, clears its caption and releases its camera.	19
`facecamClientStop`	internal	Stops a viewer when the authoritative server cancels its facecam schedule.	13
`facecamReceive`	internal	Accepts a server facecam session and starts its local viewer on the next frame.	21

Full-screen image-card sequences with owned timing and cleanup. System internals

Function	Exposure	Purpose	Lines
`splashStart`	public	Plays an opt-in sequence of full-screen image cards with owned cleanup.	39
`splashStop`	public	Stops the local splash sequence, releasing its UI and optional music hold.	21
`splashTick`	internal	Advances image cards using local monotonic time and bounded CBA frame handling.	35

Bezier frame preparation and the shared camera driver. System internals

Function	Exposure	Purpose	Lines
`animateCamera`	public	Animates a supplied camera with weighted Bezier frames.	42
`cameraPath`	public	Owns a local camera and delegates movement to the shared animator.	34
`prepareCameraPath`	public	Validates and expands weighted camera frames without changing game state.	30

Request and local rendering of gravity waves. System internals

Function	Exposure	Purpose	Lines
`gravityPulse`	public	Broadcast one or more visual pulses. No physics, freeze, or damage.	103
`gravityPulseLocal`	internal	Local-only particles, light and post-processing for a single travelling wave.	108