Skip to content

Latest commit

 

History

History
78 lines (68 loc) · 2.55 KB

README.md

File metadata and controls

78 lines (68 loc) · 2.55 KB
Raw

enc0ded-persistent-vehicles

This mod prevents vehicles from disappearing in OneSync multiplayer servers. It can also respawn vehicles in their previous location after a server restart.

Requirements

FiveM Version >=2443 OneSync - This mod will not work without OneSync.

Installation

Download or clone from repo. Place the enc0ded-persistent-vehicles folder in your resources folder. Open config.lua and configure to your needs. Start the resource.

start enc0ded-persistent-vehicles

Usage

To make a vehicle persistent, pass its entity to the event below in a client script. For example if you are using ESX you can put this in the call back of the ESX.Game.SpawnVehicle function.

  # client event
  TriggerEvent('persistent-vehicles/register-vehicle', entity)

To update a persistent vehicle, pass its entity to the event below in a client script. For example if you are using ESX you can put this in the call back of the ESX.Game.SetVehicleProperties function.

  # client event
 TriggerEvent('persistent-vehicles/server/update-vehicle', entity)

Stop a vehicle from being persistent and allow it to be removed as normal. Does not delete the vehicle. Call this when a player puts away a vehicle. Also remember to call this on your admin delete vehicle commands.

  # client event
  TriggerEvent('persistent-vehicles/forget-vehicle', entity)

If you enable repopulate on reboot then you need to call the server event below before your server shuts down. This will ensure that the vehicles spawn in the exact same location when the server comes back online.

# server event
TriggerEvent('persistent-vehicles/save-vehicles-to-file')

Alternatively you can stop the resource which will do this automatically.

# server event
StopResource('enc0ded-persistent-vehicles')

Server Console Commands

Cull persistent vehicles

pv-cull <number of vehicles>

Unpersist vehicles

pv-forget-all

Get number of vehicles spawned on the map

pv-num-spawned

Get number of vehicles registered as persistent

pv-num-registered

Toggle console debugging messages

pv-toggle-debugging

Save all persistent vehicles to file. Can be called before reboot.

pv-save-to-file

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Support

Discord

License

MIT