Merge pull request #5 from neos7/development

Updated readme

Author: NeoS7

README.md

@@ -63,6 +63,47 @@ The value in milliseconds used by each client to check if its preset requires to
 `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
+
+### Exports
+
+Remember that exports require the resource to be called “vstancer”
+
+```csharp
+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#:
+```csharp
+Exports["vstancer"].SetVstancerPreset(vehicle,offset_f,rotation_f,offset_r,rotation_r);
+```
+Lua:
+```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#:
+```csharp
+float[] preset = Exports["vstancer"].GetVstancerPreset(vehicle);
+```
+Lua:
+```lua
+local preset = exports.vstancer:GetVstancerPreset(vehicle);
+```
+
 [Source](https://github.com/neos7/fivem-vstancer)
 [Download](https://github.com/neos7/fivem-vstancer/releases)
 I am open to any kind of feedback. Report suggestions and bugs you find.

Vstancer.Client/Vstancer.cs

@@ -17,6 +17,7 @@ public class Vstancer : BaseScript
         private static readonly string ScriptName = "VStancer";
 
         #region CONFIG_FIEDS
+        private static float fDecorPrecision = 0.001f;
         private static float editingFactor = 0.01f;
         private static float maxSyncDistance = 150.0f;
         private static float frontMaxOffset = 0.25f;
@@ -427,11 +428,7 @@ private void RemoveDecorators(int vehicle)
         /// <returns></returns>
         private float[] GetVstancerPreset(int vehicle)
         {
-            VstancerPreset preset = null;
-            if (vehicle == currentVehicle && currentPreset != null)
-                preset = currentPreset;
-            else preset = CreatePreset(vehicle);
-
+            VstancerPreset preset = (vehicle == currentVehicle && currentPreset != null) ? currentPreset : CreatePreset(vehicle);
             int frontCount = preset.FrontWheelsCount;
 
             return new float[] {
@@ -524,7 +521,7 @@ private void UpdateFloatDecorator(int vehicle, string name, float currentValue,
             if (DecorExistOn(vehicle, name))
             {
                 float decorValue = DecorGetFloat(vehicle, name);
-                if (Math.Abs(currentValue - decorValue) > 0.001f)
+                if (Math.Abs(currentValue - decorValue) > fDecorPrecision)
                 {
                     DecorSetFloat(vehicle, name, currentValue);
                     if (debug)
@@ -533,7 +530,7 @@ private void UpdateFloatDecorator(int vehicle, string name, float currentValue,
             }
             else // Decorator doesn't exist, create it if required
             {
-                if (Math.Abs(currentValue - defaultValue) > 0.001f)
+                if (Math.Abs(currentValue - defaultValue) > fDecorPrecision)
                 {
                     DecorSetFloat(vehicle, name, currentValue);
                     if (debug)

Vstancer.Client/VstancerPreset.cs

@@ -5,6 +5,7 @@ namespace Vstancer.Client
 {
     public class VstancerPreset : IEquatable<VstancerPreset>
     {
+        public static float Precision { get; private set; } = 0.001f;
         public int WheelsCount { get; private set; }
         public int FrontWheelsCount { get; private set; }
 
@@ -150,10 +151,10 @@ public bool Equals(VstancerPreset other)
 
             for (int index = 0; index < WheelsCount; index++)
             {
-                if (Math.Abs(DefaultOffsetX[index] - other.DefaultOffsetX[index]) > 0.001f
-                    || Math.Abs(DefaultRotationY[index] - other.DefaultRotationY[index]) > 0.001f
-                    || Math.Abs(OffsetX[index] - other.OffsetX[index]) > 0.001f
-                    || Math.Abs(RotationY[index] - other.RotationY[index]) > 0.001f)
+                if (Math.Abs(DefaultOffsetX[index] - other.DefaultOffsetX[index]) > Precision
+                    || Math.Abs(DefaultRotationY[index] - other.DefaultRotationY[index]) > Precision
+                    || Math.Abs(OffsetX[index] - other.OffsetX[index]) > Precision
+                    || Math.Abs(RotationY[index] - other.RotationY[index]) > Precision)
                     return false;
             }
             return true;

dist/config.ini

@@ -8,7 +8,7 @@ timer=1000
 debug=false
 
 #Enables the /vstancer command
-exposeCommand=true
+exposeCommand=false
 
 #Enable the "vstancer:toggleMenu" event
 exposeEvent=false