Developer API 2.0#

Everything on Developer API still works. This page covers what 2.0 adds.

Character status#

Characters passed to exports, hooks and events also carry:

{
    status = 'active',          -- 'active' | 'dead' | 'trashed' | 'pending' | 'denied'
    dead = { at = 1761580000, reason = 'Shot during the bank job' },     -- or nil
    trash = { at = 1761580000, purgeAt = 1762184800 },                    -- or nil
    approval = { state = 'pending', at = 1761580000, reason = nil },      -- or nil
    nameRequest = { firstname = 'Jon', lastname = 'Carter', reason = '...', state = 'pending', note = nil, at = 0 }, -- or nil
    fields = { ... },           -- card fields from RegisterCardField
    scene = 'Mission Row PD',   -- label of the scene location, or nil
}

Only active characters that are not disabled can be played.

Server exports#

target is a server id, a license, discord:<id> or fivem:<id>. The last two need the player to have joined once. AddSlots and the other slot exports accept the same targets.

RegisterCardField#

exports['koja-multicharacter']:RegisterCardField({
    id = 'arrests',
    label = 'Arrests',
    icon = 'gavel',
    order = 10,
    badge = false,
    tone = nil,
    resolve = function(character, src)
        local count = MySQL.scalar.await('SELECT COUNT(*) FROM mdt_arrests WHERE charid = ?', { character.charId })
        if count == 0 then return nil end
        return count, 'last 30 days'
    end,
})

resolve runs every time the character list loads, so keep it fast. Fields are removed when your resource stops.

Hooks#

exports['koja-multicharacter']:RegisterHook('sceneLocation', function(src, character)
    local house = MyHousing.GetMainHouse(character.charId)
    if house then
        return { label = house.label, ped = house.frontDoor, hour = 20 }
    end
end)

exports['koja-multicharacter']:RegisterHook('buildScene', function(src, character)
    local pet = MyPets.GetActive(character.charId)
    return pet and { pet = pet.model } or nil
end)

Server events#

Client exports#

Scene hook context: { slot, charId, ped, base = vec4, location, season, status, data }.

exports['koja-multicharacter']:RegisterSceneHook(function(ped, context)
    if not context.data.pet then return end
    local model = joaat(context.data.pet)
    RequestModel(model)
    while not HasModelLoaded(model) do Wait(0) end
    local spot = GetOffsetFromEntityInWorldCoords(ped, 0.9, 0.4, -1.0)
    local pet = CreatePed(28, model, spot.x, spot.y, spot.z, context.base.w, false, true)
    FreezeEntityPosition(pet, true)
    return function() DeleteEntity(pet) end
end)

Arrival context: { coords, character, ped, sound(name), title(), sleep(ms), camera(vec3, fov), track(entity), skipped() }. sleep returns false once the player skips. Entities passed to track and cameras made with camera are removed when the cutscene ends, and the player is put on coords afterwards.