Master | Development |
---|---|
An attempt to use the features from ikt's VStancer as resource for FiveM servers to synchronize the edited vehicles with all the players. It is built using FiveM API and MenuAPI.
When a client edits a vehicle, it will be automatically synchronized with all the players. If a vehicle is reset to the default values it will stop from being synchronized. The synchronization is made using decorators.
The default key to open the menu is F6
- Edit X Position of the wheels' bones (Track Width)
- Edit Y Rotation of the wheels' bones (Camber)
When a preset is created for the first time, it will use the current wheels' state as default. So in case of damaged vehicles (e.g. deformed wheels), the default values might be incorrect. Workaround: If a vehicle is damaged, be sure to fix it before to enter it and create a preset. (e.g. reset preset, fix the vehicle, exit the vehicle and enter again)
Once FiveM exposes extra-natives to edit SubHandlingData
fields at runtime, the script will allow to edit XYZ rotation using the native handling fields of CCarHandlingData
such as fToeFront
, fToeRear
, fCamberFront
, fCamberRear
, fCastor
. (This will also improve a lot performances as such values won't need to be set each tick)
vstancer_preset
Prints the preset of the current vehicle
vstancer_decorators
Prints the info about decorators on the current vehicle
vstancer_decorators <int>
Prints the info about decorators on the vehicle with the specified int as local handle
vstancer_print
Prints the list of all the vehicles with any decorator of this script
vstancer_range <float>
Sets the specified float as the maximum distance used to refresh wheels of the vehicles with decorators
vstancer_debug <bool>
Enables or disables the logs to be printed in the console
vstancer
Toggles the menu, this command has to be enabled in the config
toggleMenu=167
The Control to toggle the Menu, default is 167 which is F6 (check the controls list)
FloatStep=0.01
The step used to increase and decrease a value
frontMaxOffset=0.25
The max value you can increase or decrease the front Track Width
frontMaxCamber=0.20
The max value you can increase or decrease the front Camber
rearMaxOffset=0.25
The max value you can increase or decrease the rear Track Width
rearMaxCamber=0.20
The max value you can increase or decrease the rear Camber
ScriptRange=150.0
The max distance within which each client refreshes others clients' vehicles
timer=1000
The value in milliseconds used by each client to check if its preset requires to be synched again
debug=false
Enables the debug mode, which prints some logs in the console
exposeCommand=false
Enables the /vstancer command to toggle the menu
exposeEvent=false
Enable the "vstancer:toggleMenu" event to toggle the menu
Remember that exports require the resource to be called “vstancer”
private void SetVstancerPreset(int vehicle, float off_f, float rot_f, float off_r, float rot_r, object defaultFrontOffset = null, object defaultFrontRotation = null, object defaultRearOffset = null, object defaultRearRotation = null);
private float[] GetVstancerPreset(int vehicle);
SET
Note that when using the SetVstancerPreset
, the default values are optional and the script will get them itself if you don't pass them.
This is an example of how to set a vstancer preset on a vehicle:
C#:
Exports["vstancer"].SetVstancerPreset(vehicle,offset_f,rotation_f,offset_r,rotation_r);
Lua:
exports["vstancer"]:SetVstancerPreset(vehicle,offset_f,rotation_f,offset_r,rotation_r)
GET
When using the GetVstancerPreset
the returned array will contain the following floats in order: off_f, rot_f, off_r, rot_r, off_f_def, rot_f_def, off_r_def, rot_r_def.
This is an example of how to get a vstancer preset (in case you want to store them):
C#:
float[] preset = Exports["vstancer"].GetVstancerPreset(vehicle);
Lua:
local preset = exports["vstancer"]:GetVstancerPreset(vehicle);
Source Download I am open to any kind of feedback. Report suggestions and bugs you find.
Open the postbuild.bat
and edit the path of the resource folder. If in Debug configuration, the post build event will copy the following files to the specified path: the built assembly of the script, the config.ini
, the __resource.lua
.
The script uses MenuAPI by Vespura to render the UI, it uses FiveM built-in resource dependency, so the script will only work if MenuAPI resource is found and running and comes already with a built assembly so that it's ready to use.
- VStancer by ikt: https://github.com/E66666666/GTAVStancer
- FiveM by CitizenFX: https://github.com/citizenfx/fivem
- MenuAPI by Vespura: https://github.com/TomGrobbe/MenuAPI
- GTADrifting members: https://gtad.club/
- All the testers