Events

Events other resources can listen to (hooks) or trigger (to drive kartik-properties UI and flows). Everything the tablet does internally goes through permission-checked callbacks; the events below are the ones meant for integration.

🟦 Client: listenCopy Anchor Link

client:enteredPropertyCopy Anchor Link

AddEventHandler('kartik-properties:client:enteredProperty', function(propertyId) end)

Fired after the local player finishes entering a property. Covers instanced shells, IPL interiors and walk-in yard zones.

client:leftPropertyCopy Anchor Link

AddEventHandler('kartik-properties:client:leftProperty', function(propertyId) end)

Fired when the local player leaves a property's interior or walk-in zone, whether by exiting, being kicked, or the session ending.

Example: HUD / weather sync

AddEventHandler('kartik-properties:client:enteredProperty', function(id)
    exports['my-hud']:SetLocation(('Property #%d'):format(id))
    TriggerEvent('qb-weathersync:client:DisableSync')
end)

AddEventHandler('kartik-properties:client:leftProperty', function()
    exports['my-hud']:ClearLocation()
    TriggerEvent('qb-weathersync:client:EnableSync')
end)

🟦 Client: triggerCopy Anchor Link

client:openAppCopy Anchor Link

TriggerClientEvent('kartik-properties:client:openApp', source, route, tabletType, extra)

Opens the property tablet on a given screen.

Common routes:

-- phone app button → open the listings screen
TriggerEvent('kartik-properties:client:openApp', 'listings')

Screens the player's role can't see are still hidden; every action is re-checked on the server.

client:openManagerCopy Anchor Link

TriggerClientEvent('kartik-properties:client:openManager', source, propertyId, isController)

Opens a single property's management record, the same screen as Manage Property at the door. The screen only shows what the player is to that property (owner, tenant or keyholder).

client:useLockpickCopy Anchor Link

TriggerClientEvent('kartik-properties:client:useLockpick', source)

Starts a lockpick attempt on the nearest locked property door (skill check, then the server resolves it and may trip the alarm). Use it when your inventory handles the lockpick item itself.

client:forceExitPropertyCopy Anchor Link

TriggerClientEvent('kartik-properties:client:forceExitProperty', source, propertyId)

Makes the player leave propertyId if they are inside it (shell, IPL or walk-in). Does nothing otherwise.

client:highlightPropertyZoneCopy Anchor Link

TriggerClientEvent('kartik-properties:client:highlightPropertyZone', source, propertyId)

Draws the property's yard-zone polygon for about 10 seconds. The player gets an error notification if the property has no yard zone.

client:notifyCopy Anchor Link

TriggerClientEvent('kartik-properties:client:notify', source, message, msgType)

Shows a notification in the tablet's style. msgType is 'success', 'error' or 'inform'.

client:spawnInStarter / client:starterUnavailableCopy Anchor Link

TriggerClientEvent('kartik-properties:client:spawnInStarter', source, propertyId, entranceCoords)
TriggerClientEvent('kartik-properties:client:starterUnavailable', source)

The end of the new-character flow. spawnInStarter ends the tutorial session, enters the starter unit, fires the framework's OnPlayerLoaded, and opens the clothing menu when Config.Clothing.OpenOnStarterSpawn is on. starterUnavailable does the same without entering a unit, for when no starter stock is left.

🟥 Server: listenCopy Anchor Link

server:dispatchAlertCopy Anchor Link

AddEventHandler('kartik-properties:server:dispatchAlert', function(propertyId, coords, isMonitored, reason) end)

Fired whenever a forced-entry signal reaches a property with power on. This is the hook for your police dispatch.

A ready-to-edit handler ships in bridge/dispatch/server/server.lua (with a commented ps-dispatch example). Signals are suppressed while the property's breaker is tripped (see Security Subsystem).

AddEventHandler('kartik-properties:server:dispatchAlert', function(propertyId, coords, isMonitored, reason)
    if not isMonitored then return end
    exports['ps-dispatch']:CustomAlert({
        coords = vector3(coords.x, coords.y, coords.z),
        message = ('Property alarm (%s)'):format(reason),
        dispatchCode = '10-33',
    })
end)

server:evictedCopy Anchor Link

AddEventHandler('kartik-properties:server:evicted', function(leaseId, tenantCid) end)

Fired after a tenant is evicted, either for unpaid rent in the billing sweep or by the landlord. By this point the tenant's keys are revoked and their stashes are impounded.

server:blockSoldCopy Anchor Link

AddEventHandler('kartik-properties:server:blockSold', function(blockId, buyerCompanyId, price) end)

Block mode only. Fired when a land block changes hands on the market.

server:playerUnloadedCopy Anchor Link

AddEventHandler('kartik-properties:server:playerUnloaded', function(src) end)

Fired by the framework bridge when a character logs out (QBCore, Qbox or ESX), so you can clean up per-player state without depending on a specific framework's event.

🔗 RelatedCopy Anchor Link

• Exports
• Inventory item hook kartik-properties.useItem (alias usePropertyKey): see Items