Exports (Developer API)

Client events

prism_deathscreen:onDeath

Triggered when the local player enters the deathscreen (dies).

AddEventHandler('prism_deathscreen:onDeath', function(data)
    -- data can be nil
    -- data.weapon: string? (example: "WEAPON_PISTOL")
end)

Parameters

• data (table | nil)
  • weapon (string | nil) — weapon hash name, e.g. "WEAPON_PISTOL"

prism_deathscreen:onSpawn

Triggered when the local player respawns / leaves the deathscreen.

AddEventHandler('prism_deathscreen:onSpawn', function()
end)

State bag

prismDead (configurable)

When enabled via Config.DeathStatebag, the resource updates a player state bag on death/respawn.

local isDead = Player(serverId).state.prismDead

Do I need exports?

In most servers, no.

• Normal setup: install prism_deathscreen, configure it, and (optionally) add the correct migration shared_script to your ambulance job (see the Installation page).
• Most integrations are handled by the migration include, so you don’t have to call anything manually.

Migration include (recommended “API”)

If you are integrating into an existing ambulance job, the recommended approach is to include the matching migration file in that job’s fxmanifest.lua.

-- ESX
shared_script "@prism_deathscreen/migration/esx_ambulancejob.lua"
 
-- Wasabi
shared_script "@prism_deathscreen/migration/wasabi_ambulance.lua"
 
-- QB
shared_script "@prism_deathscreen/migration/qb-ambulancejob.lua"
 
-- QBX
shared_script "@prism_deathscreen/migration/qbx_ambulancejob.lua"

Custom framework / custom ambulance job

If you don’t use one of the supported ambulance jobs, you can still use prism_deathscreen as a standalone death UI.

• Start the resource
• Configure timers / respawn points in shared/config.lua
• If you want deeper job-specific behavior, use the migration files as a reference for what needs to be hooked in your own job resource.