Commands and Exports — Biohazard Creator | Quasar Store

Commands#

Biohazard Creator registers one command and one keybind. There are no console commands: outbreaks are started and stopped from the creator, or by Auto Start.

Command	Where	Description
`/biohazardcreator`	In game	Opens the creator: design, save, start, stop and delete outbreaks. Needs the ACE `command.biohazardcreator` while `Config.RequireAce` is on. Renamed with `Config.CreatorCommand`.
`Z` · `+biohazard_scoreboard`	Keybind	Shows or hides the kill ranking during an outbreak. Players can rebind it under Settings → Key Bindings → FiveM.

The /biohazard <seconds | stop> command from the first version no longer exists. Save the outbreak you want as a preset and press Start in the creator.

Server Exports#

For reading progression from your own scripts — a level badge on a HUD, a Discord leaderboard, a reward for reaching a rank.

GetProfile

A connected player's full profile, the same one the phone app shows. Returns nil without a source; a player who has never played gets a level-1 profile.

lua

local profile = exports['qs-biohazard']:GetProfile(source)
if profile then
    print(profile.name, profile.level, profile.rank, profile.position)
end

Field	Holds
`identifier` · `name`	From GetIdentifier and GetDisplayName.
`level` · `rank` · `maxLevel`	The level, the rank key (such as `'hunter'`), and whether the cap is reached.
`xp` · `xpIntoLevel` · `xpForLevel` · `progress`	Total XP, XP into the current level, XP that level needs, and progress from 0 to 1.
`kills` · `infections` · `bestKills` · `mvps`	Lifetime totals, and the most kills in a single outbreak.
`games` · `wins` · `losses` · `winRate`	Outbreaks played, survived, lost, and the win rate as a percentage.
`position` · `totalPlayers`	Place on the XP leaderboard, out of every player on record.

GetLeaderboard

The top players, straight from the database. limit is 1 to 100 (default Config.Phone.LeaderboardMax); sortBy is 'level' (default), 'kills', 'wins', 'games' or 'mvps', with ties broken by XP.

lua

local rows = exports['qs-biohazard']:GetLeaderboard(10, 'kills')
for i, row in ipairs(rows) do
    print(i, row.name, row.kills)
end

-- each row: identifier, name, xp, level, kills, infections,
--           games, wins, losses, best_kills, mvps

Client Events#

Listen to these from any resource to react to an outbreak — hide a HUD, pause a weather sync, silence a dispatch script. The server sends them: listen, never trigger them yourself.

lua

RegisterNetEvent('biohazard:start', function(data)
    -- an outbreak started, or this player joined one already running
    print(data.label, data.remaining, data.area.type) -- seconds left · 'world' or 'zone'
end)

RegisterNetEvent('biohazard:stop', function(data)
    print(data.endedAsZombie) -- true if this player finished as a zombie
end)

Event	When	Data
`biohazard:start`	An outbreak starts, or the player connects during one.	`id` (preset, or nil), `label`, `remaining`, `area`, `ambience`, `zombie`, `horde`, `infection`
`biohazard:stop`	The outbreak ends, by timer, Stop event or a resource stop.	`endedAsZombie`
`biohazard:onBecomeZombie`	The player has just been infected.	—
`biohazard:scoreboard`	Every `Config.Scoreboard.BroadcastMs` during an outbreak, and on start, stop and every infection.	`running`, `remaining`, `rows` — each `{ id, name, kills, zombie, level }`
`biohazard:phone:profileUpdate`	The outbreak ends and the player's XP is saved.	The profile from GetProfile, plus `xpGained` and `lastEvent` `{ kills, infections, survived, mvp }`

On a zone event, biohazard:start reaches every player, including those far from the zone. Check data.area.type before hiding anything for players who are not taking part.

Commands#

Biohazard Creator registers one command and one keybind. There are no console commands: outbreaks are started and stopped from the creator, or by Auto Start.

Command	Where	Description
`/biohazardcreator`	In game	Opens the creator: design, save, start, stop and delete outbreaks. Needs the ACE `command.biohazardcreator` while `Config.RequireAce` is on. Renamed with `Config.CreatorCommand`.
`Z` · `+biohazard_scoreboard`	Keybind	Shows or hides the kill ranking during an outbreak. Players can rebind it under Settings → Key Bindings → FiveM.

The /biohazard <seconds | stop> command from the first version no longer exists. Save the outbreak you want as a preset and press Start in the creator.

Server Exports#

For reading progression from your own scripts — a level badge on a HUD, a Discord leaderboard, a reward for reaching a rank.

GetProfile

A connected player's full profile, the same one the phone app shows. Returns nil without a source; a player who has never played gets a level-1 profile.

lua

local profile = exports['qs-biohazard']:GetProfile(source)
if profile then
    print(profile.name, profile.level, profile.rank, profile.position)
end

Field	Holds
`identifier` · `name`	From GetIdentifier and GetDisplayName.
`level` · `rank` · `maxLevel`	The level, the rank key (such as `'hunter'`), and whether the cap is reached.
`xp` · `xpIntoLevel` · `xpForLevel` · `progress`	Total XP, XP into the current level, XP that level needs, and progress from 0 to 1.
`kills` · `infections` · `bestKills` · `mvps`	Lifetime totals, and the most kills in a single outbreak.
`games` · `wins` · `losses` · `winRate`	Outbreaks played, survived, lost, and the win rate as a percentage.
`position` · `totalPlayers`	Place on the XP leaderboard, out of every player on record.

GetLeaderboard

lua

local rows = exports['qs-biohazard']:GetLeaderboard(10, 'kills')
for i, row in ipairs(rows) do
    print(i, row.name, row.kills)
end

-- each row: identifier, name, xp, level, kills, infections,
--           games, wins, losses, best_kills, mvps

Client Events#

Listen to these from any resource to react to an outbreak — hide a HUD, pause a weather sync, silence a dispatch script. The server sends them: listen, never trigger them yourself.

lua

RegisterNetEvent('biohazard:start', function(data)
    -- an outbreak started, or this player joined one already running
    print(data.label, data.remaining, data.area.type) -- seconds left · 'world' or 'zone'
end)

RegisterNetEvent('biohazard:stop', function(data)
    print(data.endedAsZombie) -- true if this player finished as a zombie
end)

Event	When	Data
`biohazard:start`	An outbreak starts, or the player connects during one.	`id` (preset, or nil), `label`, `remaining`, `area`, `ambience`, `zombie`, `horde`, `infection`
`biohazard:stop`	The outbreak ends, by timer, Stop event or a resource stop.	`endedAsZombie`
`biohazard:onBecomeZombie`	The player has just been infected.	—
`biohazard:scoreboard`	Every `Config.Scoreboard.BroadcastMs` during an outbreak, and on start, stop and every infection.	`running`, `remaining`, `rows` — each `{ id, name, kills, zombie, level }`
`biohazard:phone:profileUpdate`	The outbreak ends and the player's XP is saved.	The profile from GetProfile, plus `xpGained` and `lastEvent` `{ kills, infections, survived, mvp }`

On a zone event, biohazard:start reaches every player, including those far from the zone. Check data.area.type before hiding anything for players who are not taking part.

Commands#

Biohazard Creator registers one command and one keybind. There are no console commands: outbreaks are started and stopped from the creator, or by Auto Start.

Command	Where	Description
`/biohazardcreator`	In game	Opens the creator: design, save, start, stop and delete outbreaks. Needs the ACE `command.biohazardcreator` while `Config.RequireAce` is on. Renamed with `Config.CreatorCommand`.
`Z` · `+biohazard_scoreboard`	Keybind	Shows or hides the kill ranking during an outbreak. Players can rebind it under Settings → Key Bindings → FiveM.

The /biohazard <seconds | stop> command from the first version no longer exists. Save the outbreak you want as a preset and press Start in the creator.

Server Exports#

For reading progression from your own scripts — a level badge on a HUD, a Discord leaderboard, a reward for reaching a rank.

GetProfile

A connected player's full profile, the same one the phone app shows. Returns nil without a source; a player who has never played gets a level-1 profile.

lua

local profile = exports['qs-biohazard']:GetProfile(source)
if profile then
    print(profile.name, profile.level, profile.rank, profile.position)
end

Field	Holds
`identifier` · `name`	From GetIdentifier and GetDisplayName.
`level` · `rank` · `maxLevel`	The level, the rank key (such as `'hunter'`), and whether the cap is reached.
`xp` · `xpIntoLevel` · `xpForLevel` · `progress`	Total XP, XP into the current level, XP that level needs, and progress from 0 to 1.
`kills` · `infections` · `bestKills` · `mvps`	Lifetime totals, and the most kills in a single outbreak.
`games` · `wins` · `losses` · `winRate`	Outbreaks played, survived, lost, and the win rate as a percentage.
`position` · `totalPlayers`	Place on the XP leaderboard, out of every player on record.

GetLeaderboard

lua

local rows = exports['qs-biohazard']:GetLeaderboard(10, 'kills')
for i, row in ipairs(rows) do
    print(i, row.name, row.kills)
end

-- each row: identifier, name, xp, level, kills, infections,
--           games, wins, losses, best_kills, mvps

Client Events#

Listen to these from any resource to react to an outbreak — hide a HUD, pause a weather sync, silence a dispatch script. The server sends them: listen, never trigger them yourself.

lua

RegisterNetEvent('biohazard:start', function(data)
    -- an outbreak started, or this player joined one already running
    print(data.label, data.remaining, data.area.type) -- seconds left · 'world' or 'zone'
end)

RegisterNetEvent('biohazard:stop', function(data)
    print(data.endedAsZombie) -- true if this player finished as a zombie
end)

Event	When	Data
`biohazard:start`	An outbreak starts, or the player connects during one.	`id` (preset, or nil), `label`, `remaining`, `area`, `ambience`, `zombie`, `horde`, `infection`
`biohazard:stop`	The outbreak ends, by timer, Stop event or a resource stop.	`endedAsZombie`
`biohazard:onBecomeZombie`	The player has just been infected.	—
`biohazard:scoreboard`	Every `Config.Scoreboard.BroadcastMs` during an outbreak, and on start, stop and every infection.	`running`, `remaining`, `rows` — each `{ id, name, kills, zombie, level }`
`biohazard:phone:profileUpdate`	The outbreak ends and the player's XP is saved.	The profile from GetProfile, plus `xpGained` and `lastEvent` `{ kills, infections, survived, mvp }`

On a zone event, biohazard:start reaches every player, including those far from the zone. Check data.area.type before hiding anything for players who are not taking part.

Commands#

Biohazard Creator registers one command and one keybind. There are no console commands: outbreaks are started and stopped from the creator, or by Auto Start.

Command	Where	Description
`/biohazardcreator`	In game	Opens the creator: design, save, start, stop and delete outbreaks. Needs the ACE `command.biohazardcreator` while `Config.RequireAce` is on. Renamed with `Config.CreatorCommand`.
`Z` · `+biohazard_scoreboard`	Keybind	Shows or hides the kill ranking during an outbreak. Players can rebind it under Settings → Key Bindings → FiveM.

The /biohazard <seconds | stop> command from the first version no longer exists. Save the outbreak you want as a preset and press Start in the creator.

Server Exports#

For reading progression from your own scripts — a level badge on a HUD, a Discord leaderboard, a reward for reaching a rank.

GetProfile

A connected player's full profile, the same one the phone app shows. Returns nil without a source; a player who has never played gets a level-1 profile.

lua

local profile = exports['qs-biohazard']:GetProfile(source)
if profile then
    print(profile.name, profile.level, profile.rank, profile.position)
end

Field	Holds
`identifier` · `name`	From GetIdentifier and GetDisplayName.
`level` · `rank` · `maxLevel`	The level, the rank key (such as `'hunter'`), and whether the cap is reached.
`xp` · `xpIntoLevel` · `xpForLevel` · `progress`	Total XP, XP into the current level, XP that level needs, and progress from 0 to 1.
`kills` · `infections` · `bestKills` · `mvps`	Lifetime totals, and the most kills in a single outbreak.
`games` · `wins` · `losses` · `winRate`	Outbreaks played, survived, lost, and the win rate as a percentage.
`position` · `totalPlayers`	Place on the XP leaderboard, out of every player on record.

GetLeaderboard

lua

local rows = exports['qs-biohazard']:GetLeaderboard(10, 'kills')
for i, row in ipairs(rows) do
    print(i, row.name, row.kills)
end

-- each row: identifier, name, xp, level, kills, infections,
--           games, wins, losses, best_kills, mvps

Client Events#

Listen to these from any resource to react to an outbreak — hide a HUD, pause a weather sync, silence a dispatch script. The server sends them: listen, never trigger them yourself.

lua

RegisterNetEvent('biohazard:start', function(data)
    -- an outbreak started, or this player joined one already running
    print(data.label, data.remaining, data.area.type) -- seconds left · 'world' or 'zone'
end)

RegisterNetEvent('biohazard:stop', function(data)
    print(data.endedAsZombie) -- true if this player finished as a zombie
end)

Event	When	Data
`biohazard:start`	An outbreak starts, or the player connects during one.	`id` (preset, or nil), `label`, `remaining`, `area`, `ambience`, `zombie`, `horde`, `infection`
`biohazard:stop`	The outbreak ends, by timer, Stop event or a resource stop.	`endedAsZombie`
`biohazard:onBecomeZombie`	The player has just been infected.	—
`biohazard:scoreboard`	Every `Config.Scoreboard.BroadcastMs` during an outbreak, and on start, stop and every infection.	`running`, `remaining`, `rows` — each `{ id, name, kills, zombie, level }`
`biohazard:phone:profileUpdate`	The outbreak ends and the player's XP is saved.	The profile from GetProfile, plus `xpGained` and `lastEvent` `{ kills, infections, survived, mvp }`

On a zone event, biohazard:start reaches every player, including those far from the zone. Check data.area.type before hiding anything for players who are not taking part.

Commands andExports

Commands#

Server Exports#

Client Events#

Commands andExports

Commands#

Server Exports#

Client Events#

Commands andExports

Commands#

Server Exports#

Client Events#

Commands andExports

Commands#

Server Exports#

Client Events#