Types

Here you can find all types, which are defined in this resource. Usage with client and server export

--- @class WarehouseData
--- @field id number The unique warehouse identifier
--- @field label string The name of the warehouse
--- @field location vector3 The location of the warehouse
--- @field targetLocation vector3 The target location for interactions
--- @field maxOwnedWarehouses number Maximum number of warehouses that can be owned for this warehouse type
--- @field availableBoxTypes string[] Available box types for this warehouse
--- @field pricing WarehousePricing The pricing configuration
--- @field blip WarehouseBlipData The blip data for the warehouse
--- @field search table Search configuration

---@class WarehouseInfo : WarehouseData
---@field owns boolean
---@field ownedBoxType string?
---@field available boolean
---@field reason string
---@field totalOwned number
---@field boxes table<string, WarehouseBoxData>

--- @class WarehousePricing
--- @field purchasePrice number One-time purchase price
--- @field rentPrice number Weekly rent price
--- @field deposit number Security deposit for rentals

--- @class WarehouseBlipData
--- @field enabled boolean Whether the blip is enabled
--- @field label string The name of the blip
--- @field sprite number The sprite ID of the blip
--- @field display number The display type of the blip
--- @field scale number The scale of the blip
--- @field color number The color of the blip
--- @field shortRange boolean Whether the blip is short range

--- @class WarehouseBoxData
--- @field label string The display name of the box type
--- @field slots number Number of inventory slots
--- @field maxWeight number Maximum weight capacity in grams
--- @field priceMultiplier number Price multiplier for this box type

--- @class WarehouseSettings
--- @field rentCollectionDay number Day of week for rent collection (1-7)
--- @field rentCollectionHour number Hour of day for rent collection (0-23)
--- @field gracePeriodDays number Days before first warning
--- @field warningIntervalDays number Days between warnings
--- @field sellbackPercentage number Percentage of purchase price returned when selling (0.0-1.0)