Usage Examples

Usage Examples

Server-side Example

-- Example script to add reputation XP for mining
local playerId = 1
local category = 'mining'
local amount = 50

-- Add XP (single character)
exports['b2_reputation']:addReputationXPSingle(playerId, category, amount)

-- Add XP (multi-character)
exports['b2_reputation']:addReputationXPMulti(playerId, category, amount)

-- Get XP
local xpSingle = exports['b2_reputation']:getReputationXPSingle(playerId, category)
local xpMulti = exports['b2_reputation']:getReputationXPMulti(playerId, category)

-- Calculate reputation level
local levelSingle = exports['b2_reputation']:calculateReputationLevel(playerId, category)
local levelMulti = exports['b2_reputation']:calculateReputationLevel(playerId, category)

print("Single Character - XP: ", xpSingle, "Level: ", levelSingle)
print("Multi Character - XP: ", xpMulti, "Level: ", levelMulti)

Client-side Example

Since the exports are server-side, you would typically call them from the server and handle client notifications or updates accordingly.

-- Client script to show reputation level
RegisterNetEvent('b2_reputation:showReputationLevel')
AddEventHandler('b2_reputation:showReputationLevel', function(level)
    -- Replace with your preferred notification system
    print("Your reputation level is: ", level)
end)

Initializing Player Data

To ensure player data is initialized correctly on first connection, make sure the following event handler is included. This is included in the b2_reputation system, so there should be no need for you to use it anywhere else:

AddEventHandler('playerConnecting', function(name, setKickReason, deferrals)
    local src = source
    local id = getPlayerIdentifierOrCharId(src)
    if not id then
        return
    end

    if Config.MultiCharacter then
        MySQL.Async.execute('INSERT IGNORE INTO user_reputation (character_id, mining, fishing, weed_harvesting) VALUES (@id, 0, 0, 0)', {
            ['@id'] = id
        })
    else
        MySQL.Async.execute('INSERT IGNORE INTO player_reputation (player_id, mining, fishing, weed_harvesting) VALUES (@id, 0, 0, 0)', {
            ['@id'] = id
        })
    end
end)

Absolutely! Let's expand on how to integrate a new reputation category into the B2 Reputation System, including updating the SQL table and the config.lua file.

---

Integrating A New Reputation

Step 1: Add the Reputation to the SQL Table

Depending on your framework and whether you're using a single-character or multi-character setup, you will need to modify the appropriate SQL table. Here’s how to do it:

Single Character

To add a new reputation category, let's say "hunting", to the SQL table:

ALTER TABLE user_reputation ADD COLUMN hunting INT NOT NULL DEFAULT 0;

Multi Character

ALTER TABLE player_reputation ADD COLUMN hunting INT NOT NULL DEFAULT 0;

Step 2: Add the Reputation to the Config.lua File

Next, you need to add the new reputation category to the config.lua file with the XP required for each level.

Here is an example of adding a new "hunting" reputation category:

Config = {}

-- Framework configuration: qbcore, qbox, esx
Config.Framework = 'qbcore'

-- Toggle for multicharacter system
Config.MultiCharacter = true

-- Define reputation categories and XP required for each level
Config.ReputationLevels = {
    mining = {
        [1] = 100,
        [2] = 300,
        [3] = 600,
        [4] = 1000
    },
    fishing = {
        [1] = 50,
        [2] = 150,
        [3] = 300,
        [4] = 500
    },
    weed_harvesting = {
        [1] = 200,
        [2] = 500,
        [3] = 900,
        [4] = 1500
    },
    hunting = {
        [1] = 100,
        [2] = 250,
        [3] = 500,
        [4] = 800,
        [5] = 1200  -- Example with 5 levels
    }
}

Example Usage

Here's an example of how to use the new "hunting" reputation category in a script.

Server-side Example

-- Example script to add reputation XP for hunting
local playerId = 1
local category = 'hunting'
local amount = 75

-- Add XP (single character)
exports['b2_reputation']:addReputationXPSingle(playerId, category, amount)

-- Add XP (multi-character)
exports['b2_reputation']:addReputationXPMulti(playerId, category, amount)

-- Get XP
local xpSingle = exports['b2_reputation']:getReputationXPSingle(playerId, category)
local xpMulti = exports['b2_reputation']:getReputationXPMulti(playerId, category)

-- Calculate reputation level
local levelSingle = exports['b2_reputation']:calculateReputationLevel(playerId, category)
local levelMulti = exports['b2_reputation']:calculateReputationLevel(playerId, category)

print("Single Character - Hunting XP: ", xpSingle, "Level: ", levelSingle)
print("Multi Character - Hunting XP: ", xpMulti, "Level: ", levelMulti)

---

By following these steps, you can seamlessly add new reputation categories to the B2 Reputation System. If you need further customization or assistance, feel free to ask!