Module sv_bridge

Bridge

Functions

GetPlayerIdentifier (src) GetPlayerIdentifier function.
GetCharacterId (src) GetCharacterId function.
GetPlayerName (src) GetPlayerName function.
GetPlayerJob (src) GetPlayerJob function.
GetPlayerJobLabel (src) GetPlayerJobLabel function.
GetPlayerJobGrade (src) GetPlayerJobGrade function.
AddMoney (src, amount, type, reason) AddMoney function.
RemoveMoney (src, amount, type, reason) RemoveMoney function.
GetPlayerMoney (src, type) GetPlayerMoney function.
GetPlayers () GetPlayers function.

GetFramework

GetPlayerFromSource (src) GetPlayerFromSource function.
RegisterUsableItem (item, cb) RegisterUsableItem function.
jones_util:server:playerloaded PlayerLoaded event.
jones_util:server:playerlogout PlayerUnloaded event.
jones_util:server:setjob JobUpdated event.
jones_util:server:setsubjob GangUpdated event.
GetFramework () GetFramework function.
UseItem (event, item, inventory, slot, data) UseItem function.
SetPlayerJob (src, job, grade) SetPlayerJob function.
GetJobs () GetJobs function.


Functions

GetPlayerIdentifier (src)
GetPlayerIdentifier function. This function returns the player's identifier from a source.

Parameters:

  • src The source. number

Returns:

    string
GetCharacterId (src)
GetCharacterId function. This function returns the player's character id from a source.

Parameters:

  • src The source. number

Returns:

    number
GetPlayerName (src)
GetPlayerName function. This function returns the player's name from a source.

Parameters:

  • src The source. number

Returns:

    string
GetPlayerJob (src)
GetPlayerJob function. This function returns the player's job from a source.

Parameters:

  • src The source. number

Returns:

    string
GetPlayerJobLabel (src)
GetPlayerJobLabel function. This function returns the player's job label from a source.

Parameters:

  • src The source. number

Returns:

    string
GetPlayerJobGrade (src)
GetPlayerJobGrade function. This function returns the player's job grade from a source.

Parameters:

  • src The source. number

Returns:

    number
AddMoney (src, amount, type, reason)
AddMoney function. This function adds money to a player.

Parameters:

  • src The source. number
  • amount The amount. number
  • type The type. string
  • reason The reason. string

Usage:

    exports.jones_util:AddMoney(1, 100, "cash", "reason")
RemoveMoney (src, amount, type, reason)
RemoveMoney function. This function removes money from a player.

Parameters:

  • src The source. number
  • amount The amount. number
  • type The type. string
  • reason The reason. string

Usage:

    exports.jones_util:RemoveMoney(1, 100, "cash", "reason")
GetPlayerMoney (src, type)
GetPlayerMoney function. This function returns the player's money.

Parameters:

  • src The source. number
  • type The type. string

Returns:

    number

Usage:

    local money = exports.jones_util:GetPlayerMoney(1, "cash")
GetPlayers ()
GetPlayers function. This function returns all players.

Returns:

    table

GetFramework

GetPlayerFromSource (src)
GetPlayerFromSource function. This function returns the player from a source.

Parameters:

  • src The source. number

Returns:

    table

Usage:

    local player = exports.jones_util:GetPlayerFromSource(1)
RegisterUsableItem (item, cb)
RegisterUsableItem function. This function registers a usable item.

Parameters:

  • item The item. string
  • cb The callback. function

Usage:

    exports.jones_util:RegisterUsableItem("item", function(...) end)
jones_util:server:playerloaded
PlayerLoaded event. This event is triggered when a player is loaded.

param:

  • source The player's source. number
  • xPlayer The player's xPlayer. table
  • ... The arguments. any

Usage:

    AddEventHandler("jones_util:server:playerloaded", function(source, xPlayer, ...) end)
jones_util:server:playerlogout
PlayerUnloaded event. This event is triggered when a player is unloaded.

param:

  • source The player's source. number
  • ... The arguments. any

Usage:

    AddEventHandler("jones_util:server:playerlogout", function(source, ...) end)
jones_util:server:setjob
JobUpdated event. This event is triggered when a player's job is updated.

param:

  • source The player's source. number
  • job The player's job table. table
  • job The player's job table. table

Usage:

    AddEventHandler("jones_util:server:setjob", function(source, job) end)
jones_util:server:setsubjob
GangUpdated event. This event is triggered when a player's gang is updated.

param:

  • source The player's source. number
  • gang The player's gang table. table
  • gang The player's gang table. table

Usage:

    AddEventHandler("jones_util:server:setsubjob", function(source, gang) end)
GetFramework ()
GetFramework function. This function returns the framework.

Returns:

    name string, object table

Usage:

    local FrameworkName, FrameworkObject = exports.jones_util:GetFramework()
UseItem (event, item, inventory, slot, data)
UseItem function. This function is triggered when a player uses an item.

Parameters:

  • event The event. string
  • item The item. table
  • inventory The inventory. table
  • slot The slot. number
  • data The data. any

Usage:

    ox_inventory item export
SetPlayerJob (src, job, grade)
SetPlayerJob function. This function sets a player's job.

Parameters:

  • src The source. number
  • job The job. string
  • grade The grade. number

Usage:

    exports.jones_util:SetPlayerJob(1, "police", 1)
GetJobs ()
GetJobs function. This function returns all jobs including gangs.

Returns:

    table

Usage:

    local jobs = exports.jones_util:GetJobs()
generated by LDoc 1.5.0 Last updated 2024-05-13 19:05:24