Framework Server

OnPlayerLoaded

Function gets called when the player loads into the server

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

source: number

OnPlayerUnload

Function gets called when the player leaves the server

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

source: number

OnJobUpdate

Function gets called when the players job changes

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

source: number

OnJobDutyUpdate

Function gets called when the players job duty changes

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

source: number
duty: boolean

OnGangUpdate

Function gets called when the players gang changes

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

source: number

CreateCallback

Function Creates Server Callback.

Framework.CreateCallback(name, cb)

name: string
cb: function(source cb, ...)

Framework.CreateCallback('servercallbackname', function(source, cb, value1, value2)
    cb(value1, value2)
end)

TriggerCallback

Function Triggers Client Callback

Framework.TriggerCallback(source, name, cb, ...)

source: number
name: string
cb: function(...)

Framework.TriggerCallback(source, 'clientcallbackname', function(result1, result2)
    print(result1, result2)
end, value1, value2)

CreateUseableItem

Framework.CreateUseableItem(name, cb)

name: string
cb: function(source, item, data)
- source: number
- item: string
- data: table
  - weight: number
  - count: number
  - slot: number
  - name: string
  - metadata: table
  - label: string

Framework.CreateUseableItem('itemname', function(source, item, data)
    -- Item Is Useable
end)

GetPlayer

Framework.GetPlayer(source)

source: number

returns: Player | nil

GetPlayerByIdentifier

Framework.GetPlayerByIdentifier(identifier)

identifier: string

returns: Player | nil

DoesJobExist

Framework.DoesJobExist(job, grade)

job: string
grade: string | number

returns: boolean

Framework.DoesJobExist('jobname', 0)

DoesGangExist

Framework.DoesGangExist(gang, grade)

gang: string
grade: string | number

returns: boolean

Framework.DoesGangExist('gangname', 0)

RegisterSociety

Framework.RegisterSociety(name, type)

name: string
type: 'job' | 'gang'

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

SocietyGetMoney

Framework.SocietyGetMoney(name, type)

name: string
type: 'job' | 'gang'

returns: number

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

SocietyAddMoney

Framework.SocietyAddMoney(name, type, amount)

name: string
type: 'job' | 'gang'
amount: number

returns: boolean

Framework.SocietyAddMoney('police', 'job', 100)

SocietyRemoveMoney

Framework.SocietyRemoveMoney(name, type, amount)

name: string
type: 'job' | 'gang'
amount: number

returns: boolean

Framework.SocietyRemoveMoney('police', 'job', 100)

Notify

Show Notification Message

Framework.Notify(source, message, type, length)

source number
message: string
type info | success | error
length number

Framework.Notify(source, 'My Notification Message', 'info', 5000)

IsPlayerDead

Check If Player Is Dead

Framework.IsPlayerDead(source)

source number

returns: boolean

HasPermission

Check If A Player Has Specific Permissions

Framework.HasPermission(source, permission)

source number
permission string | table

returns: boolean

Framework.HasPermission(source, "admin")
 
Framework.HasPermission(source, {"admin", "user"})