Bridge
Framework
Player

Framework Player

source

Player source

returns: number

local player = Framework.GetPlayer(source)
print(player.source)

Identifier

Player identifier

returns: string

Framework.Player.Identifier

Name

Player name

returns: string

Framework.Player.Name

Firstname

Player firstname

returns: string

Framework.Player.Firstname

Lastname

Player lastname

returns: string

Framework.Player.Lastname

Date Of Birth

Player Date Of Birth

returns: string

Framework.Player.DateOfBirth

Gender

Player Gender

returns: string

Framework.Player.Gender

Job

Player job

returns: table

  • Name: string
  • Label: string
  • Duty: boolean
  • Boss: boolean
  • Grade: table
    • Name: string
    • Level: number
Framework.Player.Job
-- returns: {"Boss":false,"Duty":false,"Grade":{"Level":1,"Name":"Officer"},"Label":"Law Enforcement","Name":"police"}
 
Framework.Player.Job.Name
-- returns: police 
 
Framework.Player.Job.Label
-- returns: Law Enforcement 
 
Framework.Player.Job.Duty
-- returns: false 
 
Framework.Player.Job.Boss
-- returns: false 
 
Framework.Player.Job.Grade
-- returns: {"Level":1,"Name":"Officer"}
 
Framework.Player.Job.Grade.Name
-- returns: Officer
 
Framework.Player.Job.Grade.Level
-- returns: 1

Gang

Player gang

returns: table

  • Name: string
  • Label: string
  • Boss: boolean
  • Grade: table
    • Name: string
    • Level: number
Framework.Player.Gang
-- returns: {"Boss":false,"Grade":{"Level":1,"Name":"Enforcer"},"Label":"My Gang Name","Name":"mygang"}
 
Framework.Player.Gang.Name
-- returns: mygang 
 
Framework.Player.Gang.Label
-- returns: My Gang Name
 
Framework.Player.Gang.Boss
-- returns: false 
 
Framework.Player.Gang.Grade
-- returns: {"Level":1,"Name":"Enforcer"}
 
Framework.Player.Gang.Grade.Name
-- returns: Enforcer
 
Framework.Player.Gang.Grade.Level
-- returns: 1

Metadata

Player Metadata

returns: table

Framework.Player.Metadata

SetJob

Set Player job

Player.SetJob(job, grade)
  • job: string
  • grade number | string

returns: boolean

local player = Framework.GetPlayer(source)
player.SetJob('police', 0)

SetDuty

Set Player job duty

Player.SetDuty(duty)
  • duty: boolean
local player = Framework.GetPlayer(source)
player.SetDuty(false)

SetGang

Set Player gang

Player.SetGang(gang, grade)
  • gang: string
  • grade number | string

returns: boolean

local player = Framework.GetPlayer(source)
player.SetGang('mygang', 0)

HasJob

Check if player has job and or grade and is on duty or not

Framework.HasJob(job, player, duty)
  • job: string | table
  • player: Player
  • duty?: boolean

returns: boolean

Framework.HasJob('police', Framework.Player)
 
Framework.HasJob({ ['police'] = 1 }, Framework.Player)
 
Framework.HasJob('police', Framework.Player, true)
 
Framework.HasJob({ ['police'] = 1 }, Framework.Player, true)

HasGang

Check if player has gang and or grade

Framework.HasGang(gang, player)
  • gang: string | table
  • player: Player

returns: boolean

Framework.HasGang('mygang', Framework.Player)
 
Framework.HasGang({ ['mygang'] = 1 }, Framework.Player)

AddMoney

Add Player Money

Player.AddMoney(type, amount)
  • type: cash | bank | other
  • amount number

returns: boolean

local player = Framework.GetPlayer(source)
player.AddMoney('cash', 100)

RemoveMoney

Remove Player Money

Player.RemoveMoney(type, amount)
  • type: cash | bank | other
  • amount number

returns: boolean

local player = Framework.GetPlayer(source)
player.RemoveMoney('cash', 100)

GetMoney

Get Player Money

Player.GetMoney(type)
  • type: cash | bank | other

returns: number

local player = Framework.GetPlayer(source)
player.GetMoney('cash')

Accounts

Gets Player Account Balance

Player.Accounts[name]
  • name: string

returns: number

-- Cash
Framework.Player.Accounts['cash']
 
-- Bank
Framework.Player.Accounts['bank']
 
-- Other
Framework.Player.Accounts['crypto']

GetStatus

Get Player Status

Player.GetStatus(key)
  • key: string

returns: number

local player = Framework.GetPlayer(source)
player.GetStatus('hunger')

SetStatus

Set Player Status

Player.SetStatus(key, value)
  • key: string
  • value: number
local player = Framework.GetPlayer(source)
player.SetStatus('hunger', 100)

GetMetaData

Get Player Metadata

Player.GetMetaData(key)
  • key?: string
local player = Framework.GetPlayer(source)
 
-- Get All Metadata
player.GetMetaData()
 
-- Get Specific Metadata key
player.GetMetaData('mykey')

SetMetaData

Set Player Metadata

Player.SetMetaData(key, value)
  • key: string
  • value: any
local player = Framework.GetPlayer(source)
player.SetMetaData('mykey', 'myvalue')

HasLicense

Check If Player Has License

Player.HasLicense(name)
  • name: string

returns: boolean

local player = Framework.GetPlayer(source)
player.HasLicense('driver')

GetLicenses

Get Player Licenses

Player.GetLicenses()

returns: table<string, boolean>

local player = Framework.GetPlayer(source)
player.GetLicenses()

AddLicense

Add License To Player

Player.AddLicense(name)
  • name: string
local player = Framework.GetPlayer(source)
player.AddLicense('driver')

RemoveLicense

Remove License From Player

Player.RemoveLicense(name)
  • name: string
local player = Framework.GetPlayer(source)
player.RemoveLicense('driver')