Skip to Content
Cobalt

cobalt_housing

Properties and who can enter them.

GetProperty

Server

Returns a property by id, or nil when it does not exist.

exports.cobalt_housing:GetProperty(id)
ParameterTypeOptionalDescription
idintegerNo
ReturnsDescription
HousingProperty?
Example
local property = exports.cobalt_housing:GetProperty(1)

FindProperties

Server

Properties whose name contains query, ignoring case, sorted by id. limit defaults to 25, which is also the most it returns. Empty when query is under 2 characters.

exports.cobalt_housing:FindProperties(query, limit)
ParameterTypeOptionalDescription
querystringNo
limitintegerYes
ReturnsDescription
HousingProperty[]
Example
local properties = exports.cobalt_housing:FindProperties(
    'SELECT * FROM players WHERE citizenid = ?',
    10
)

GetOwnedProperties

Server

Returns the properties a character owns.

exports.cobalt_housing:GetOwnedProperties(citizenid)
ParameterTypeOptionalDescription
citizenidstringNo
ReturnsDescription
HousingPropertySummary[]
Example
local propertySummaries = exports.cobalt_housing:GetOwnedProperties('ABC12345')

HasAccess

Server

Whether the character owns the property.

exports.cobalt_housing:HasAccess(citizenid, propertyId)
ParameterTypeOptionalDescription
citizenidstringNo
propertyIdintegerNo
ReturnsDescription
boolean
Example
local ok = exports.cobalt_housing:HasAccess('ABC12345', 1)

On this page