Documentation
Base Resource

housing

The supplied manifest describes this resource as “VCore - Housing”.

v1.0.0VCore FrameworkGameplay systems

Introduction

The supplied manifest describes this resource as “VCore - Housing”.

5Client Lua
5Server Lua
0Exports
27Events
4SQL tables

No manifest UI page detected.

Dependencies & References

ResourceDetected asPackage status
clothingManifest dependencyIncluded in Base
coreManifest dependencyIncluded in Base
core_gameManifest dependencyIncluded in Base
doorlocksManifest dependencyIncluded in Base
inventoryManifest dependencyIncluded in Base
logsManifest dependencyIncluded in Base
oxmysqlManifest dependencyExternal / prerequisite
shell_modelsManifest dependencyExternal / prerequisite
shellsManifest dependencyIncluded in Base

Cross-resource export calls

ResourceFunctions called
coregetCoreObject
inventoryGetStashItems, OpenStash
logsLog
shellsCreateShell, DeleteShell

Installation / Start Order

The supplied server.cfg enables this resource in the Gameplay systems stage at enabled-resource position 56. Base installation also depends on the global prerequisites and consolidated VCORE_INSTALL.sql documented in Getting Started.

server.cfg
ensure housing

Configuration

Config files

  • config.lua
  • configApartments.lua
  • configHotels.lua
  • configMotels.lua
  • configOffices.lua

Top-level config keys detected

ApartmentAgentJobsApartmentExtrasApartmentGaragesApartmentsApartmentShowersApartmentShowerTimeApartmentsLeasePeriodApartmentsMinAgentsApartmentsRenewalPeriodCostThemeChangeCurrencyDefaultShowerTimeEntryValidationDistanceFridgeDecayMultiplierFridgeSlotsFridgeWeightHotelBuildingsHotelElevatorsHotelElevatorsDescHotelExcludedRoomZonesHotelItemsRocoveryFeeHotelLeasePeriodHotelRenewalPeriodHotelRoomsHotelRoomTypesHotelStashMotelBuildingsMotelItemsRocoveryFeeMotelLeasePeriodMotelRenewalPeriodMotelsMotelStashOfficeAgentJobsOfficeExtrasOfficeGaragesOfficeHelipadOfficesOfficesLeasePeriodOfficesMinAgentsOfficesRenewalPeriodShowCitizenidWhenRaidingStashSlotsStashWeightViewingTime

Events, Exports & Callbacks

Exports

No export definitions were detected.

Callbacks

Server callbacks13
  • VCORE:SetPlayerRoutingBucket
  • apartments:server:getAccessibleGarages
  • apartments:server:getAllGarages
  • apartments:server:getGarageSlots
  • apartments:server:getOwnedLease
  • hotels:server:recoverBelongings
  • housing:server:enterRoom
  • housing:server:enterSession
  • motels:server:recoverBelongings
  • offices:server:getAccessibleGarages
  • offices:server:getAllGarages
  • offices:server:getGarageSlots
  • offices:server:getOwnedLease

Registered network events

Client registered events27
  • VCORE:Client:OnPlayerLoaded
  • VCORE:Client:OnPlayerUnload
  • apartments:client:allowEntry
  • apartments:client:leaseSuccess
  • apartments:client:openBuildingMenu
  • apartments:client:openManageLeaseMenu
  • apartments:client:returnApartmentsWithAccess
  • apartments:client:returnKeyHolders
  • apartments:client:ringApartment
  • apartments:client:showLeaseSetup
  • apartments:client:updateTheme
  • hotels:client:leaseSuccess
  • motels:client:drawOwned
  • motels:client:setRoomLockStatus
  • offices:client:allowEntry
  • offices:client:leaseSuccess
  • offices:client:manageOfficeSignOptions
  • offices:client:openBuildingMenu
  • offices:client:openManageLeaseMenu
  • offices:client:openManageOffice
  • offices:client:returnKeyHolders
  • offices:client:returnOfficesWithAccess
  • offices:client:ringOffice
  • offices:client:selectSignOption
  • offices:client:showLeaseSetup
  • offices:client:updateOfficeSign
  • offices:client:updateTheme

Commands

No commands were detected.

Database / SQL

FileType
apartments.sqlResource SQL file
housing.sqlResource SQL file
motels.sqlResource SQL file
offices.sqlResource SQL file
apartmentshotelsmotelsoffices

The root Base package also ships the consolidated VCORE_INSTALL.sql.

Source Layout

AreaDetected files
Client Lua5
Server Lua5
Other/shared Lua6
JavaScript0
HTML0
CSS0
SQL4

Troubleshooting

  • Confirm all manifest dependencies are started before housing.
  • Check the supplied start-order note above; resources absent from server.cfg need an explicit decision before enabling.
  • If database queries fail, import the consolidated Base SQL and any resource-local SQL listed above.
  • If the UI fails, verify the resource's NUI files and ui_page when one is declared.