Framework — Server

Functions

GetResourceName

Returns the framework resource name.

local name = Bridge.Framework.GetResourceName()
-- Returns: string (always "default")

Description: Returns the name of the Framework module resource. Used for internal identification. Always returns "default" for the built-in Framework module.

Example:

local resourceName = Bridge.Framework.GetResourceName()
print('Framework resource: ' .. resourceName)

GetIsFrameworkAdmin

Checks if a player has admin permissions.

local isAdmin = Bridge.Framework.GetIsFrameworkAdmin(src)
-- Returns: boolean

Parameter	Type	Description
src	number	Player server ID

GetPlayerIdentifier

Returns a player’s identifier.

local id = Bridge.Framework.GetPlayerIdentifier(src)
-- Returns: string

Parameter	Type	Description
src	number	Player server ID

GetPlayer

Returns the raw framework player object.

local player = Bridge.Framework.GetPlayer(src)
-- Returns: table (framework-specific player object)

Parameter	Type	Description
src	number	Player server ID

GetPlayerByIdentifier

Returns a player object by their identifier string.

local player = Bridge.Framework.GetPlayerByIdentifier(identifier)
-- Returns: table | nil

Parameter	Type	Description
identifier	string	Player identifier

GetPlayerSource

Returns a player’s server ID from a framework player object.

local src = Bridge.Framework.GetPlayerSource(player)
-- Returns: number

Parameter	Type	Description
player	table	Framework player object

GetFrameworkJobs

Returns all registered jobs in the framework.

local jobs = Bridge.Framework.GetFrameworkJobs()
-- Returns: table

GetPlayerName

Returns a player’s character name.

local name = Bridge.Framework.GetPlayerName(src)
-- Returns: string

Parameter	Type	Description
src	number	Player server ID

GetPlayerDob

Returns a player’s date of birth.

local dob = Bridge.Framework.GetPlayerDob(src)
-- Returns: string

Parameter	Type	Description
src	number	Player server ID

GetPlayers

Returns all currently connected players.

local players = Bridge.Framework.GetPlayers()
-- Returns: table

GetPlayerJobData

Returns a player’s job data.

local job = Bridge.Framework.GetPlayerJobData(src)
-- Returns: table { name, label, grade, gradeLabel, isBoss, duty, type }

Parameter	Type	Description
src	number	Player server ID

GetPlayerDuty

Returns whether a player is on duty.

local onDuty = Bridge.Framework.GetPlayerDuty(src)
-- Returns: boolean

Parameter	Type	Description
src	number	Player server ID

SetPlayerDuty

Sets a player’s duty status.

Bridge.Framework.SetPlayerDuty(src, duty)

Parameter	Type	Description
src	number	Player server ID
duty	boolean	Duty status

SetPlayerJob

Sets a player’s job.

Bridge.Framework.SetPlayerJob(src, job, grade)

Parameter	Type	Description
src	number	Player server ID
job	string	Job name
grade	number	Job grade

GetPlayerPhone

Returns a player’s phone number.

local phone = Bridge.Framework.GetPlayerPhone(src)
-- Returns: string

Parameter	Type	Description
src	number	Player server ID

GetPlayerGang

Returns a player’s gang data.

local gang = Bridge.Framework.GetPlayerGang(src)
-- Returns: table

Parameter	Type	Description
src	number	Player server ID

GetPlayersByJob

Returns all online players with a given job.

local players = Bridge.Framework.GetPlayersByJob(job)
-- Returns: table

Parameter	Type	Description
job	string	Job name

GetPlayerMetadata

Returns player metadata for a key.

local meta = Bridge.Framework.GetPlayerMetadata(src, key)

Parameter	Type	Description
src	number	Player server ID
key	string	Metadata key

SetPlayerMetadata

Sets player metadata for a key.

Bridge.Framework.SetPlayerMetadata(src, key, value)

Parameter	Type	Description
src	number	Player server ID
key	string	Metadata key
value	any	Value to set

AddStress

Adds stress to a player.

Bridge.Framework.AddStress(src, amount)

Parameter	Type	Description
src	number	Player server ID
amount	number	Amount to add

RemoveStress

Removes stress from a player.

Bridge.Framework.RemoveStress(src, amount)

Parameter	Type	Description
src	number	Player server ID
amount	number	Amount to remove

AddHunger

Adds hunger to a player.

Bridge.Framework.AddHunger(src, amount)

Parameter	Type	Description
src	number	Player server ID
amount	number	Amount to add

AddThirst

Adds thirst to a player.

Bridge.Framework.AddThirst(src, amount)

Parameter	Type	Description
src	number	Player server ID
amount	number	Amount to add

GetHunger

Returns a player’s hunger level.

local hunger = Bridge.Framework.GetHunger(src)
-- Returns: number

Parameter	Type	Description
src	number	Player server ID

GetThirst

Returns a player’s thirst level.

local thirst = Bridge.Framework.GetThirst(src)
-- Returns: number

Parameter	Type	Description
src	number	Player server ID

GetIsPlayerDead

Returns whether a player is dead.

local dead = Bridge.Framework.GetIsPlayerDead(src)
-- Returns: boolean

Parameter	Type	Description
src	number	Player server ID

RevivePlayer

Revives a player.

Bridge.Framework.RevivePlayer(src)

Parameter	Type	Description
src	number	Player server ID

AddAccountBalance

Adds money to a player’s account.

Bridge.Framework.AddAccountBalance(src, accountType, amount)

Parameter	Type	Description
src	number	Player server ID
accountType	string	Account type (e.g. ‘cash’, ‘bank’)
amount	number	Amount to add

RemoveAccountBalance

Removes money from a player’s account.

Bridge.Framework.RemoveAccountBalance(src, accountType, amount)

Parameter	Type	Description
src	number	Player server ID
accountType	string	Account type
amount	number	Amount to remove

GetAccountBalance

Returns a player’s balance for a given account type.

local balance = Bridge.Framework.GetAccountBalance(src, accountType)
-- Returns: number

Parameter	Type	Description
src	number	Player server ID
accountType	string	Account type

GetJobCount

Returns the number of online players with a specific job.

local count = Bridge.Framework.GetJobCount(job)
-- Returns: number

Parameter	Type	Description
job	string	Job name

GetJobCountTotal

Returns the total count of online players across multiple jobs.

local count = Bridge.Framework.GetJobCountTotal(jobs)
-- Returns: number

Parameter	Type	Description
jobs	table	Array of job name strings

GetPlayerSourcesByJob

Returns the server IDs of all players with a specific job.

local sources = Bridge.Framework.GetPlayerSourcesByJob(job)
-- Returns: table (array of server IDs)

Parameter	Type	Description
job	string	Job name

AddJobCount

Registers a player to a job in the job count tracking system.

local success = Bridge.Framework.AddJobCount(src, jobName)
-- Returns: boolean

Parameter	Type	Description
src	number	Player server ID
jobName	string	Job name to register

Description: This function tracks when a player joins a job. It updates the internal job count cache and global state. Returns true if successfully added, false if already registered or invalid parameters.

Example:

if Bridge.Framework.AddJobCount(src, 'police') then
    print('Player registered to police job')
end

SearchJobCountBySource

Returns the current job name for a player in the job count system.

local jobName = Bridge.Framework.SearchJobCountBySource(src)
-- Returns: string | nil

Parameter	Type	Description
src	number	Player server ID

Description: Looks up a player’s current job from the internal job count tracking system. Returns the job name if found, or nil if the player is not registered to any job.

Example:

local job = Bridge.Framework.SearchJobCountBySource(src)
if job then
    print('Player is registered to: ' .. job)
end

RemoveJobCount

Unregisters a player from a job in the job count tracking system.

local success = Bridge.Framework.RemoveJobCount(src, jobName)
-- Returns: boolean

Parameter	Type	Description
src	number	Player server ID
jobName	string \| nil	Job name to unregister from (optional, auto-detected if not provided)

Description: Removes a player from job tracking. If jobName is not provided, the function will automatically detect the player’s current job. This function is called automatically when a player changes jobs or disconnects. Returns true on success, false if player or job not found.

Example:

-- Remove from specific job
Bridge.Framework.RemoveJobCount(src, 'police')
 
-- Or auto-detect and remove from current job
Bridge.Framework.RemoveJobCount(src)

Events

community_bridge:Server:OnPlayerLoaded

Fired when a player finishes loading.

RegisterNetEvent('community_bridge:Server:OnPlayerLoaded', function(src)
    -- src: player server ID
end)

community_bridge:Server:OnPlayerUnload

Fired when a player disconnects or unloads.

RegisterNetEvent('community_bridge:Server:OnPlayerUnload', function(src)
    -- src: player server ID
end)

community_bridge:Server:OnPlayerJobChange

Fired when a player’s job changes.

RegisterNetEvent('community_bridge:Server:OnPlayerJobChange', function(src, jobData)
    -- src: player server ID
    -- jobData: table { name, label, grade, gradeLabel, isBoss, duty, type }
end)

Compatibility Client