Exports
- Added
- Updated
Server side
playerHasVehicles
Check whether one player has the required stored vehicles.
| Argument | Type | Description |
|---|---|---|
playerId | integer | Player server ID |
requiredVehicles | table<string, REC_HeistPrep.Server.Class.HeistPrepConfig.RequiredVehicle> | Map each model to { count = number } |
Returns boolean.
exports.REC_HeistPrep:playerHasVehicles(playerId, requiredVehicles)
getPreparedVehicles
Get stored vehicle counts by model.
| Argument | Type | Description |
|---|---|---|
playerId | integer | Player server ID |
Returns table<string, integer>|nil.
exports.REC_HeistPrep:getPreparedVehicles(playerId)
addPreparedVehicles
Add stored vehicles by model and count.
| Argument | Type | Description |
|---|---|---|
playerId | integer | Player server ID |
vehicles | table<string, integer> | Model counts, such as { adder = 2 } |
Returns boolean.
exports.REC_HeistPrep:addPreparedVehicles(playerId, vehicles)
register
Registers the heist’s vehicle requirements for display in the preparation menu.
| Argument | Type |
|---|---|
heistPrepConfig | REC_HeistPrep.Server.Class.HeistPrepConfig |
Returns: boolean.
exports.REC_HeistPrep:register(heistPrepConfig)
unregister
Removes a registered heist requirement by key.
| Argument | Type |
|---|---|
key | string |
Returns: boolean.
exports.REC_HeistPrep:unregister(key)
playersHasVehicles
Checks the combined stored vehicles of multiple players against the required counts.
| Argument | Type |
|---|---|
playerIds | integer[] |
requiredVehicles | table<string, REC_HeistPrep.Server.Class.HeistPrepConfig.RequiredVehicle> |
Returns: boolean.
exports.REC_HeistPrep:playersHasVehicles(playerIds, requiredVehicles)
getVehicleLabel
Returns the configured model label, or nil if no label is configured.
| Argument | Type |
|---|---|
model | string |
Returns: string|nil.
exports.REC_HeistPrep:getVehicleLabel(model)
removePreparedVehicles
Consumes the required stored vehicles. Insufficient stock leaves the stored vehicles unchanged.
| Argument | Type |
|---|---|
playerId | integer |
requiredVehicles | table<string, REC_HeistPrep.Server.Class.HeistPrepConfig.RequiredVehicle> |
Returns: boolean.
exports.REC_HeistPrep:removePreparedVehicles(playerId, requiredVehicles)
removePreparedVehiclesFromPlayers
Consumes the required vehicles from multiple players’ combined stock. Insufficient stock leaves it unchanged.
| Argument | Type |
|---|---|
playerIds | integer[] |
requiredVehicles | table<string, REC_HeistPrep.Server.Class.HeistPrepConfig.RequiredVehicle> |
Returns: boolean.
exports.REC_HeistPrep:removePreparedVehiclesFromPlayers(playerIds, requiredVehicles)
getStoredVehicles
Returns individual stored vehicles with uid, model, vehType, label, plate and createdAt; saved condition data is omitted.
| Argument | Type |
|---|---|
playerId | integer |
filterModels? | string|string[] |
Returns: REC_HeistPrep.Server.Main.GetStoredVehicles.Return[]|nil.
exports.REC_HeistPrep:getStoredVehicles(playerId, filterModels)
requestVehicleSelection
Opens the player’s vehicle selection UI and waits for a selection. Failure or cancellation returns nil and an optional reason.
| Argument | Type |
|---|---|
playerId | integer |
filterModels? | string|string[] |
Returns: { uid: string, model: string, plate: string, }|nil, string?.
exports.REC_HeistPrep:requestVehicleSelection(playerId, filterModels)
spawnStoredVehicle
Spawns the stored vehicle with its saved condition and returns its network ID. The stored record is consumed only after a successful spawn. This call yields.
| Argument | Type |
|---|---|
playerId | integer |
uid | string |
coords | vector3 |
heading | number |
Returns: integer|nil, string?.
exports.REC_HeistPrep:spawnStoredVehicle(playerId, uid, coords, heading)
requestAndSpawnVehicle
Waits for vehicle selection, then spawns it at options.coords/options.heading. Success consumes the stored record; failure returns nil and an optional reason.
| Argument | Type |
|---|---|
playerId | integer |
options | { filterModels?: string|string[], coords: vector3, heading: number, } |
Returns: { uid: string, model: string, plate: string, netId: integer, }|nil, string?.
exports.REC_HeistPrep:requestAndSpawnVehicle(playerId, options)