About

WX Bridge is an advanced system for FiveM that allows you to bridge multiple frameworks. With WX Bridge, you don't have to write your own support for multiple framework-dependent functions, such as retrieving a player's job. You can use snippets from this system or add the entire system as a dependency, and then use it with exports.

Usage

Choose your framework in configs/bridge_config.lua

-- client.lua
local PlayerData = exports.wx_bridge:GetPlayerData()
print(json.encode(PlayerData, {
    indent = true
}))

Available Exports:

Client

Function	Description	Parameters	Return Type
`exports.wx_bridge:GetPlayerData()`	Returns current player's data, like character info (name, job, etc.).	None	table
`exports.wx_bridge:IsPlayerLoaded()`	Returns `true` if the player has chosen their character.	None	boolean
`exports.wx_bridge:SetPlayerData(key, value)`	Modifies the current player's data.	`key` (string), `value` (any)	None
`exports.wx_bridge:OpenInventory()`	Opens the inventory through the framework.	None	None
`exports.wx_bridge:ShowNotification(text)`	Shows a notification through the framework.	`text` (string)	None
`exports.wx_bridge:Dispatch(code, title, message, blip, jobs, important)`	Client side function for police dispatch	`code` (string), `title` (string), `message` (string), `blip` (number), `jobs` (table), `important` (boolean \| number)	None
`exports.wx_bridge:GetJob()`	Returns player's job name	None	string
`exports.wx_bridge:GetJobGrade()`	Returns player's job grade number	None	number
`exports.wx_bridge:HasItem(item_name)`	Returns boolean and item count - Checks if player has given item in inventory	`item_name` (string)	boolean, number
`exports.wx_bridge:GetInventory()`	Returns player's inventory contents	None	table
`exports.wx_bridge:CloseMenu()`	Closes any open menu	None	None

Server

Available Functions

Function	Description	Parameters	Return Type
`exports.wx_bridge:GetPlayer(id)`	Returns player object (like xPlayer in ESX).	`id` (number)	table
`exports.wx_bridge:GetAllPlayers()`	Returns all online players.	None	table
`exports.wx_bridge:GetPlayerJob(id)`	Returns player's job.	`id` (number)	string
`exports.wx_bridge:GetPlayerJobGrade(id)`	Returns player's job grade number.	`id` (number)	number
`exports.wx_bridge:HasPermission(playerId)`	Returns boolean - check if player has one of the configured admin groups.	`playerId` (number)	boolean
`exports.wx_bridge:AddMoney(playerId, amount)`	Adds money to player. (with most frameworks to their inventory)	`playerId` (number), `amount` (number)	None
`exports.wx_bridge:RemoveMoney(playerId, amount)`	Removes money from player. (with most frameworks from their inventory)	`playerId` (number), `amount` (number)	None
`exports.wx_bridge:RemoveBankMoney(playerId, amount)`	Removes money from player's bank.	`playerId` (number), `amount` (number)	None
`exports.wx_bridge:GetMoney(playerId)`	Retrieves player's money (with most frameworks from their inventory)	`playerId` (number)	number
`exports.wx_bridge:GetBankMoney(playerId)`	Retrieves player's money from bank.	`playerId` (number)	number
`exports.wx_bridge:TransferMoney(from, to, amount)`	Transfers bank money from one player to another	`from` (number), `to` (number), `amount` (number)	boolean, string
`exports.wx_bridge:GetItem(playerId, item_name)`	Retrieves info about an item from player's inventory.	`playerId` (number), `item_name` (string)	table
`exports.wx_bridge:CanCarryItem(playerId, item_name, amount)`	Returns boolean - Checks if player can carry the given item and count.	`playerId` (number), `item_name` (string), `amount` (number)	boolean
`exports.wx_bridge:SetJob(playerId, job_name, job_grade)`	Set player's job.	`playerId` (number), `job_name` (string), `job_grade` (number)	None
`exports.wx_bridge:GetIdentifier(playerId)`	Returns player's rockstar identifier.	`playerId` (number)	string
`exports.wx_bridge:GetPlayerCoords(playerId)`	Returns the coords of given player ID.	`playerId` (number)	vector3

TODO

More frameworks (ND_Core, ox_core)
More functions for QB Core

Contributing

Contributions are welcome! If you have any suggestions or improvements, please submit a pull request or open an issue.

License

WX Bridge is licensed under the MIT License. See the LICENSE file for more details.

Support

If you encounter any issues, feel free to open an issue. Do not open issues with questions on how to use this.

nwvh/wx_bridge