Skip to content
Version 2.32.0
↓ Get the launcher

ICameraOverride interface

Exclusive takeover of the game camera for a free camera. Main thread only. One holder at a time; a second TryAcquire returns false. The framework ends the override on a zone change, a cutscene, the game’s own camera mode opening, a disconnect, the holder’s unload, or an exception in the holder’s Frame handler, and raises Released with the reason. The camera is never placed more than 60 m from the local player, whatever the holder asks for.

public interface ICameraOverride
name description
IsOverridden { get; } True while any holder has the camera.
event Released Raised after an override ends, with the reason.
LookAtCamera() Turns the local player’s head toward the camera until disposed; the previous look-at state is restored on dispose (and on unload). Works with or without an override.
TryAcquire(…) Takes the camera, starting at the game camera’s current pose. False when another holder has it, the game camera is not available, or the free camera is turned off on this client.
TryProjectToScreen(…) Where world appears on screen through the camera that renders NOW: the free camera while any holder has it, else the game’s own camera. Screen pixels with the origin top-left (the same space as TryPickEntity); see InFront for points behind the camera. One projection, no allocation — fine every frame for a handful of markers. False (point = default) when there is no camera (not in the world). Works with or without an override. Main thread.