Exports

Awoken Apartments exposes a small set of server-side exports for cross-resource integration (typically MDT / dispatch / housing UI scripts).

There are no client-side exports.

Server exports

`getPlayerRoom`

Returns the apartment a given player is currently assigned to.

local room = exports['awoken_apartments']:getPlayerRoom(src)
-- {
--     slotId     = 12,
--     groupId    = 'pink_cage',
--     groupLabel = 'Pink Cage Motel',
--     roomLabel  = 'Room 12',
-- }
-- OR nil if the player has no slot assigned

number

required

Player server ID.

number

The internal apartment slot index.

string

Motel group ID (matches a key in Config.MotelGroups). May be nil if the room isn’t in a group.

string

Human-readable motel name (e.g., “Pink Cage Motel”).

string

Human-readable room label (e.g., “Room 12”).

`GetAddress`

Look up an apartment address by player identifier.

local addr = exports['awoken_apartments']:GetAddress('license:abc123...')
-- {
--     slotId    = 12,
--     label     = 'Room 12',
--     citizenid = 'ABC1234',
-- }
-- OR nil

string

required

Per-player identifier - license on ESX, license on qbox/qbcore.

`GetAddressByCitizenId`

Look up an address by citizenid (qbox/qbcore character ID).

local addr = exports['awoken_apartments']:GetAddressByCitizenId('ABC1234')
-- {
--     identifier = 'license:abc123...',
--     slotId     = 12,
--     label      = 'Room 12',
-- }
-- OR nil

string

required

Character ID (qbox/qbcore).

`GetAllAddresses`

Return the entire address registry as a table keyed by identifier.

local all = exports['awoken_apartments']:GetAllAddresses()
-- {
--     ['license:abc...'] = { slotId = 12, label = 'Room 12', citizenid = 'ABC1234' },
--     ['license:def...'] = { slotId = 47, label = 'Lodge 3',  citizenid = 'DEF5678' },
--     ...
-- }

Use this for MDT bulk lookups, server-status dashboards, etc.

Common integration recipes

MDT - show resident's apartment in their profile

-- in your MDT server-side, when looking up a player:
local addr = exports['awoken_apartments']:GetAddressByCitizenId(playerCitizenId)
if addr then
    profile.address = addr.label
end

Dispatch - display apartment as call location

-- when generating a call for a player:
local room = exports['awoken_apartments']:getPlayerRoom(callerSrc)
if room then
    call.location = ('%s - %s'):format(room.groupLabel, room.roomLabel)
end

Job UI - list all residents of a motel

local all = exports['awoken_apartments']:GetAllAddresses()
local pinkCageResidents = {}
for identifier, addr in pairs(all) do
    -- filter by label substring or load Config.Apartments to check the group
    if addr.label:find('Pink Cage') then
        pinkCageResidents[#pinkCageResidents + 1] = addr
    end
end

Get Started

Awoken Scripts

Server exports

`getPlayerRoom`

`GetAddress`

`GetAddressByCitizenId`

`GetAllAddresses`

Common integration recipes

​Server exports

​getPlayerRoom

​GetAddress

​GetAddressByCitizenId

​GetAllAddresses

​Common integration recipes

Server exports

`getPlayerRoom`

`GetAddress`

`GetAddressByCitizenId`

`GetAllAddresses`

Common integration recipes