feat(server): full vehicle persistence #621
Conversation
server/vehicle-persistence.lua
Outdated
| @@ -1,3 +1,6 @@ | |||
| local persistence = GetConvarInt('qbx:enableVehiclePersistence', 0) | |||
There was a problem hiding this comment.
This is a breaking change. Either keep the convar as a string an overload the meaning (right now values are 'true' or 'false. We could add 'full' as well. OR add a new true/false convar which controls whether vehicles are persisted between restarts.
There was a problem hiding this comment.
FYI, values "true" and "false" are interpreted as 1 and 0 respectively by GetConvarInt. But at this point this can actually be replaced by the new GetConvarBool I believe, which is available since artifact 10543 — we require 10731.
server/vehicle-persistence.lua
Outdated
| print('Vehicle persistence mode ' .. persistence) | ||
|
|
server/vehicle-persistence.lua
Outdated
| }) | ||
| exports.qbx_core:EnablePersistence(veh) | ||
| Entity(veh).state:set('vehicleid', id, false) | ||
| SetVehicleDoorsLocked(veh, 2) |
There was a problem hiding this comment.
Use qbx_vehiclekeys for this, as setting it directly bypasses checks and such that qbx_vehiclekeys does. Best to make it a config function of core so that people can input other key systems they might be running
There was a problem hiding this comment.
Yeah I see, but there's no export in qbx_vehiclekeys to lock a car ?
There was a problem hiding this comment.
You'll have to create one. Just extract the implementation of qb-vehiclekeys:server:setVehLockState into an export.
There was a problem hiding this comment.
Okey I see, I'll create a pr in qbx_vehiclekeys then.
server/vehicle-persistence.lua
Outdated
| model = model, | ||
| props = props | ||
| }) | ||
| exports.qbx_core:EnablePersistence(veh) |
There was a problem hiding this comment.
qbx.spawnVehicle already sets this.
server/vehicle-persistence.lua
Outdated
|
|
||
| lib.callback.register('qbx_core:server:getVehiclesToSpawn', function() | ||
| local vehicles = {} | ||
| local query = 'SELECT id, plate, coords FROM player_vehicles WHERE state = 0' |
There was a problem hiding this comment.
Use https://docs.qbox.re/resources/qbx_vehicles/exports/server#getplayervehicles rather than directly querying the sql table
server/vehicle-persistence.lua
Outdated
| lib.callback.register('qbx_core:server:getVehiclesToSpawn', function() | ||
| local vehicles = {} | ||
| local query = 'SELECT id, plate, coords FROM player_vehicles WHERE state = 0' |
There was a problem hiding this comment.
Rather than being queried by every player. This data should be queried on server startup and cached. Then, as vehicles get spawned, the cache gets smaller and smaller.
server/vehicle-persistence.lua
Outdated
| RegisterNetEvent('qbx_core:server:spawnVehicle', function(id, coords) | ||
| local vehicle = exports.qbx_vehicles:GetPlayerVehicle(id) | ||
| if not vehicle then return end | ||
| spawnVehicle(coords, id, vehicle.modelName, vehicle.props) |
There was a problem hiding this comment.
This is an exploitable event. Needs a server side check. Once a cache exists, you can use it to verify that the id vehicle exists in cache near the specified coords
server/vehicle-persistence.lua
Outdated
| ---@return boolean | ||
| local function isVehicleSpawned(plate) | ||
| for _, vehicle in pairs(GetGamePool('CVehicle')) do |
There was a problem hiding this comment.
GetGamePool returns an array so it's best to use a numeric for loop here instead of pairs.
server/vehicle-persistence.lua
Outdated
| if not vehicles then return end | ||
|
|
||
| for _, vehicle in ipairs(vehicles) do |
There was a problem hiding this comment.
vehicles is an array, use a numeric for loop instead of this.
|
I know this isn’t the right place to ask questions, but I have one. Let’s say a car stopped and I pushed it into the water. If no one is in the seats and a server restart happens at that moment, when I spawn back into the server, will the car still be in the water or not? What I’m asking is: does this save the car’s coords / and stuff on a restart? or just saves it if someone is in a seat ? |
|
Actually the position is saved only when there's a player in the car. |
Ahh. Then I have to look at implementing that on my end. Thanks for the reply. |
|
Not really I can implement that now |
|
Thanks for that. That would be a really cool feat to have on this so no vehicles will be misplaced after a restart., I think you can do that using txAdmin events... |
server/vehicle-persistence.lua
Outdated
| local vehicle = vehicles[i] | ||
| if vehicle.coords and vehicle.props and vehicle.props.plate and | ||
| not isVehicleSpawned(vehicle.props.plate) then |
There was a problem hiding this comment.
This being on the next line makes it look weird with the line below. Better to keep this on one line instead.
|
Sorry for the ping, @CodexisPhantom I just remembered something while editing mine. Could you make it so that the vehicle's health and other properties are saved on restart? This way, if the vehicle gets damaged or destroyed while no one is inside, it won’t respawn with the health value saved when someone was in it. If you can implement vehicle health saving on restart, this should be complete. |
Description
This pull request will add the possibility to qbox users to enable a full vehicle persistence so that cars never despawn even after server restart. I tested this code with 10 people on a clean qbox server.
The convar
qbx:enableVehiclePersistencehas been modified :Checklist