Bridge
Framework
Client

Framework Client

OnPlayerLoaded

Function gets called when the player loads into the server

Framework.OnPlayerLoaded = function()
    -- Player Loaded Into The Server
end

OnPlayerUnload

Function gets called when the player leaves the server

Framework.OnPlayerUnload = function()
    -- Player Left The Server
end

OnJobUpdate

Function gets called when the players job changes

Framework.OnJobUpdate = function()
    -- Player Job Changed
end

OnJobDutyUpdate

Function gets called when the players job duty changes

Framework.OnJobDutyUpdate = function()
    -- Player Job Duty Changed
end

OnGangUpdate

Function gets called when the players gang changes

Framework.OnGangUpdate = function()
    -- Player Gang Changed
end

Player

Framework.Player

returns: Player

local player = Framework.Player
print(player.Firstname, player.Lastname)

CreateCallback

Function Creates Client Callback.

Framework.CreateCallback(name, cb)
  • name: string
  • cb: function(cb, ...)
Framework.CreateCallback('clientcallbackname', function(cb, value1, value2)
    cb(value1, value2)
end)

TriggerCallback

Function Triggers Server Callback

Framework.TriggerCallback(name, cb, ...)
  • name: string
  • cb: function(...)
Framework.TriggerCallback('servercallbackname', function(result1, result2)
    print(result1, result2)
end, value1, value2)

SpawnVehicle

Function Spawns Vehicle

Framework.SpawnVehicle(cb, model, coords, warp)
  • cb: function(netid)
  • model number | string
  • coords? vector3 | vector4
  • warp? boolean
Framework.SpawnVehicle(function(netid)
    local vehicle = NetToVeh(netid)
    SetVehicleNumberPlateText(vehicle, 'MYPLATE')
end, 'dominator')

ToggleDuty

Toggle Job Duty

Framework.ToggleDuty()

Notify

Show Notification Message

Framework.Notify(message, type, length)
  • message: string
  • type info | success | error
  • length number
Framework.Notify('My Notification Message', 'info', 5000)

IsPlayerDead

Check If Player Is Dead

Framework.IsPlayerDead()

returns: boolean

GetStatus

Get Player Status

Framework.GetStatus(key)
  • key: string

returns: number

Framework.GetStatus('hunger')

OpenSociety

Open Society Menu

Framework.OpenSociety(name, type)
  • name: string
  • type: 'job' | 'gang'

returns: number

Framework.OpenSociety('police', 'job')