Exports
A quick reference for all server and client exports exposed by kartik-properties. For hooks you can listen to or trigger, see Events. Use these to read property data or trigger core behaviour from other resources, dispatch systems, MDTs, phones, dashboards, etc.
All exports are called on the kartik-properties resource:
exports['kartik-properties']:<ExportName>(...)🗂️ Available exports
| Side | Export | Purpose |
|---|---|---|
| Server | GetCitizenProperties | Owned + leased properties for one citizen |
| Server | GetAllProperties | Global registry of every property |
| Server | GetPropertyById | A single property by id |
| Server | GetPlayerProperties | Raw owned-property rows for a citizen |
| Server | GetCompanyFunds | Bank balance of a real-estate company |
| Server | IsPlayerInProperty | The property a player is currently inside |
| Server | AddFurnitureItem | Register a furniture definition at runtime |
| Server | GetPlayerHousingData | Phone-ready housing records for a citizen |
| Server | GetPropertyHousingData | Phone-ready housing data for one property |
| Server | GrantHousingKey | Give a citizen a key |
| Server | RevokeHousingKey | Take a citizen's key away |
| Server | SetPropertyLocked | Lock / unlock a property's front door |
| Server | AssignStarterApartment | Lease a starter unit to a player |
| Server | IsPropertyGarage | Garage API: is this a property garage id? |
| Server | GetPropertyGarage | Garage API: one garage record |
| Server | GetPropertyGarages | Garage API: a citizen's usable garages |
| Server | CanUsePropertyGarage | Garage API: access check |
| Server | GetPropertyGarageVehicles | Garage API: vehicles parked there |
| Server | GetPropertyGarageSlots | Garage API: used / total slots |
| Client | EnterProperty | Walk the local player into a property |
| Client | GiveVehicleKeys | Hand vehicle keys to the local player |
| Client | RemoveVehicleKeys | Revoke vehicle keys from the local player |
🔌 MDT integration
The three read-only server exports, GetCitizenProperties, GetAllProperties and GetPropertyById, are framework-agnostic views over the property cache, designed so external tools can display a citizen's holdings without touching the kp_* tables directly.
kartik-mdt ships a bridge (bridge/properties/server/kartik-properties.lua) that reads through these exports and maps them into the MDT's citizen-profile and global-registry views. No configuration is required beyond having both resources started.