Camera: Exports & Events

Camera idsCopy Anchor Link

Every camera is addressed by its id from config/cameras.lua, e.g. pacific_vault, fleeca_legion or vangelico_1.

Client exportsCopy Anchor Link

OpenCopy Anchor Link

Opens the camera list. It is not tied to a terminal, so the viewer stays open even if the player walks away. That makes it the right choice for your own tablet, phone or MDT. The server checks Access first; without access the player gets an error notification and nothing opens.

exports["hype-camera"]:Open()

CloseCopy Anchor Link

Closes the viewer and the list: destroys the camera, removes the picture filter, restores the radar and removes the viewer on the server. Call it when you have to pull a player out of the cameras (cuffs, a cutscene, another menu opening). While a camera is watched, death and ragdoll already close the viewer on their own.

exports["hype-camera"]:Close()

IsOpenCopy Anchor Link

Returns true while the camera list or a camera is on screen. Check it before opening your own menus to avoid overlaps.

local open = exports["hype-camera"]:IsOpen()

GetViewingCameraCopy Anchor Link

Returns the id of the camera being watched, or nil while only the list is open or nothing is watched.

local id = exports["hype-camera"]:GetViewingCamera() -- "pacific_lobby" or nil

Server exportsCopy Anchor Link

SetCameraOnlineCopy Anchor Link

Switches a camera online or offline, for example to cut the cameras during a robbery. Players watching it see SIGNAL LOST and the list shows it as offline. A camera switched off this way stays off until you switch it on again. Switching a damaged camera on brings it back right away.

exports["hype-camera"]:SetCameraOnline("pacific_vault", false)

Returns boolean: false when the camera id does not exist.

DestroyCameraCopy Anchor Link

Takes a camera offline as damaged, the same as if it was shot. Players watching it see DAMAGED with a countdown, nearby players see the sparks (with Destroy.effects), and the cameraDestroyed event is triggered. It comes back on its own when the time is up. This export works even when Destroy.enabled is false.

exports["hype-camera"]:DestroyCamera("fleeca_legion", 300)

Returns boolean: false when the camera id does not exist or the camera is already offline.

IsCameraOnlineCopy Anchor Link

Returns true when the camera exists and is neither switched off nor damaged.

if exports["hype-camera"]:IsCameraOnline("vangelico_1") then
    -- the jewelry store is being watched
end

GetViewersCopy Anchor Link

Returns the server ids of players watching cameras. With an id, only the viewers of that camera; without one, everyone watching any camera. Players looking at the list only are not counted.

local all = exports["hype-camera"]:GetViewers()
local watchers = exports["hype-camera"]:GetViewers("pacific_vault")

Returns number[]: a list of player server ids.

EventsCopy Anchor Link

hype-camera:server:cameraDestroyedCopy Anchor Link

Triggered on the server when a camera is shot or taken down with DestroyCamera. Use it to alert dispatch or write a log.

AddEventHandler('hype-camera:server:cameraDestroyed', function(id, source, coords, label)
    print(('%s was shot by %s at %s'):format(label, source or 'script', coords))
end)

State bagCopy Anchor Link

The server shares the offline cameras through a global state bag, so both sides can read the same list. It is read only.

local offline = GlobalState["hype-camera:offline"] or {}

for id, value in pairs(offline) do
    if value == true then
        print(id, 'switched off')
    else
        print(id, 'damaged, back at', value) -- os.time
    end
end

Online cameras are not in the table.

CommandsCopy Anchor Link

/camerastatus pacific_vault 0

Bridge exportsCopy Anchor Link

The framework bridges in frameworks/ and the modules in modules/ are open source. If your character system is customized, change how the script reads players there. Face recognition reads its data from GetCharacterInfo.

SendNotifyCopy Anchor Link

Shows a notification with the resource set in Notifications (okokNotify, ps-ui or ox_lib). On the server, the first argument is the player; pass -1 to notify everyone.

exports["hype-camera"]:SendNotify("Security Cameras", "Camera feed restored.", 5000, "success")

exports["hype-camera"]:SendNotify(source, "Security Cameras", "The bank cameras are down!", 5000, "error")

GetModulesCopy Anchor Link

Returns the module table of the side it is called on. With a name, only that module: "Notify" on both sides, "Target" on the client.

local notify = exports["hype-camera"]:GetModules("Notify")
notify.SendNotify(source, "Security Cameras", "Hello!", 5000, "success")