🔄Exports

GetPlayerCharacters

Get all characters belonging to a player.

Usage:

local characters = exports['m-Multicharacter']:GetPlayerCharacters(source)
if characters then
    for _, char in ipairs(characters) do
        print(char.firstname, char.lastname, char.citizenid)
    end
end

Parameters:

• source (number): Player server ID

Returns:

• table|nil: Array of character data or nil if player not found

---

GetCharacterById

Get character data by character ID only. No ownership verification.

Usage:

local character = exports['m-Multicharacter']:GetCharacterById('ABC12345')
if character then
    print('Found:', character.firstname, character.lastname)
    print('Money:', character.money, 'Bank:', character.bank)
end

Parameters:

• characterId (string): Character identifier (citizenid)

Returns:

• table|nil: Character data or nil if not found

---

DeleteCharacter

Delete a character with ownership verification. Automatically cleans related data.

Usage:

local success = exports['m-Multicharacter']:DeleteCharacter(source, 'ABC12345')
if success then
    print('Character deleted successfully')
else
    print('Failed to delete - character not found or not owned by player')
end

Parameters:

• source (number): Player server ID

• characterId (string): Character identifier to delete

Returns:

• boolean: true if deleted, false if failed

---

UpdateCharacterData

Update a specific field in character data. Works with both ESX and QBCore tables.

Usage:

-- Update money
exports['m-Multicharacter']:UpdateCharacterData('ABC12345', 'money', 5000)

-- Update job
exports['m-Multicharacter']:UpdateCharacterData('ABC12345', 'job', 'police')

-- Update bank
exports['m-Multicharacter']:UpdateCharacterData('ABC12345', 'bank', 10000)

Parameters:

• characterId (string): Character identifier

• key (string): Database column name to update

• value (any): New value

Returns:

• boolean: true if updated, false if failed

---

GetPlayerMaxSlots

Get maximum character slots for a player. Checks custom slots configuration and database.

Usage:

local maxSlots = exports['m-Multicharacter']:GetPlayerMaxSlots(source)
print('Player can have', maxSlots, 'characters')

Parameters:

• source (number): Player server ID

Returns:

• number: Maximum slots (default 4)

---

SetPlayerMaxSlots

Set maximum character slots for a specific player. Saves to database.

Usage:

local success = exports['m-Multicharacter']:SetPlayerMaxSlots(source, 8)
if success then
    print('Player now has 8 character slots')
end

Parameters:

• source (number): Player server ID

• slots (number): Number of slots (must be >= 1)

Returns:

• boolean: true if updated, false if failed

---

HasAvailableSlots

Check if player can create more characters.

Usage:

if exports['m-Multicharacter']:HasAvailableSlots(source) then
    -- Allow character creation
    TriggerClientEvent('openCharacterCreation', source)
else
    -- Block creation
    TriggerClientEvent('notify', source, 'Maximum characters reached')
end

Parameters:

• source (number): Player server ID

Returns:

• boolean: true if can create more, false if at max

---

ForceLogout

Force player back to character selection screen.

Usage:

exports['m-Multicharacter']:ForceLogout(source)

Parameters:

• source (number): Player server ID

Returns:

• boolean: true if successful, false if failed