FastTravelPlugin: switch to DisableCollisions + added admin debug helper (#154)

* FastTravelPlugin: switch to DisableCollisions

* added admin only registerOnlineExtra for debugging

* losing admin in session isnt possible

* teleporting disabled when debug window open

* some more clean up

Author: C1XTZ

FastTravelPlugin/FastTravelConfiguration.cs

@@ -1,15 +1,14 @@
 using AssettoServer.Server.Configuration;
 using JetBrains.Annotations;
-using YamlDotNet.Core;
 using YamlDotNet.Serialization;
 
 namespace FastTravelPlugin;
 
 [UsedImplicitly(ImplicitUseKindFlags.Assign, ImplicitUseTargetFlags.WithMembers)]
 public class FastTravelConfiguration : IValidateConfiguration<FastTravelConfigurationValidator>
 {
-    [YamlMember(Description = "Requires CSP version 0.2.8 (3424) which fixed disabling collisions online. \nSetting this to false will lower the version requirement to 0.2.0 (2651) but clients on versions below 0.2.3-preview211 will not have disabled collisions")]
-    public bool RequireCollisionDisable { get; set; } = true;
+    [YamlMember(Description = "Requires CSP version 0.2.8 (3424) which fixed disabling collisions online. \nSetting this to false will lower the version requirement to 0.2.0 (2651) and clients will not have disabled collisions when teleporting.")]
+    public bool DisableCollisions { get; set; } = true;
 
     [YamlMember(Description = "Available zoom levels. Last one should show the full track.\nIf map image is shown, prioritize matching the track to the map image.\nDon't change the values if using Shutoko Revival Project")]
     public List<int> MapZoomValues = [100, 1000, 4000, 15000];
@@ -18,8 +17,8 @@ public class FastTravelConfiguration : IValidateConfiguration<FastTravelConfigur
     public List<int> MapMoveSpeeds = [1, 5, 20, 0];
 
     [YamlMember(Description = "Show the map.png of the track layout when in the last zoom level.\nDon't change if using Shutoko Revival Project")]
-    public bool ShowMapImage = true;
+    public bool ShowMapImage { get; set; } = true;
 
-    [YamlMember(Description = "Last zoom level has a fixed position, the track should be aligned to the center of the screen.\nIf map image is shown, prioritize aligning the track with the map image.\nDon't change the values if using Shutoko Revival Project")] 
+    [YamlMember(Description = "Last zoom level has a fixed position, the track should be aligned to the center of the screen.\nIf map image is shown, prioritize aligning the track with the map image.\nDon't change the values if using Shutoko Revival Project")]
     public List<int> MapFixedTargetPosition = [-2100, 0, 3200];
 }

FastTravelPlugin/FastTravelConfigurationValidator.cs

@@ -13,7 +13,7 @@ public FastTravelConfigurationValidator()
             .Equal(cfg => cfg.MapZoomValues.Count)
             .WithMessage("MapMoveSpeeds and MapZoomValues must contain the same number of values");
         RuleFor(cfg => cfg.MapZoomValues)
-            .Must(x =>x.SequenceEqual(x.Order().ToList()))
+            .Must(x => x.SequenceEqual(x.Order().ToList()))
             .WithMessage("Values should not be lower than previous ones");
         RuleFor(cfg => cfg.MapMoveSpeeds)
             .Must(x => x[..^1].SequenceEqual(x[..^1].Order().ToList()))

FastTravelPlugin/FastTravelModule.cs

@@ -13,6 +13,7 @@ protected override void Load(ContainerBuilder builder)
 
     public override FastTravelConfiguration ReferenceConfiguration => new()
     {
+        DisableCollisions = false,
         MapZoomValues = [100, 200, 400, 600],
         MapMoveSpeeds = [1, 2, 3, 0],
         ShowMapImage = false,

FastTravelPlugin/FastTravelPlugin.cs

@@ -22,35 +22,35 @@ public FastTravelPlugin(FastTravelConfiguration configuration,
         AiSpline? aiSpline = null)
     {
         _aiSpline = aiSpline ?? throw new ConfigurationException("FastTravelPlugin does not work with AI traffic disabled");
-        
-        if (configuration.RequireCollisionDisable && serverConfiguration.CSPTrackOptions.MinimumCSPVersion < CSPVersion.V0_2_8)
+
+        if (configuration.DisableCollisions && serverConfiguration.CSPTrackOptions.MinimumCSPVersion < CSPVersion.V0_2_8)
         {
             throw new ConfigurationException("FastTravelPlugin needs a minimum required CSP version of 0.2.8 (3424)");
         }
-        
-        if (!configuration.RequireCollisionDisable && serverConfiguration.CSPTrackOptions.MinimumCSPVersion < CSPVersion.V0_2_0)
+
+        if (!configuration.DisableCollisions && serverConfiguration.CSPTrackOptions.MinimumCSPVersion < CSPVersion.V0_2_0)
         {
             throw new ConfigurationException("FastTravelPlugin needs a minimum required CSP version of 0.2.0 (2651)");
         }
 
-        // Include Client Reconnection Script
         if (!serverConfiguration.Extra.EnableClientMessages)
         {
             throw new ConfigurationException("FastTravelPlugin requires ClientMessages to be enabled");
         }
-        
+
         var luaPath = Path.Join(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "lua", "fasttravel.lua");
-        
+
         using var streamReader = new StreamReader(luaPath);
-        var reconnectScript = streamReader.ReadToEnd();
-        scriptProvider.AddScript(reconnectScript, "fasttravel.lua", new Dictionary<string, object>
+        var fasttravelScript = streamReader.ReadToEnd();
+        scriptProvider.AddScript(fasttravelScript, "fasttravel.lua", new Dictionary<string, object>
         {
             ["mapFixedTargetPosition"] = $"\"{JsonSerializer.Serialize(configuration.MapFixedTargetPosition)}\"",
             ["mapZoomValues"] = $"\"{JsonSerializer.Serialize(configuration.MapZoomValues)}\"",
             ["mapMoveSpeeds"] = $"\"{JsonSerializer.Serialize(configuration.MapMoveSpeeds)}\"",
-            ["showMapImg"] = configuration.ShowMapImage ? "true" : "false"
+            ["showMapImg"] = configuration.ShowMapImage ? "true" : "false",
+            ["disableCollisions"] = configuration.DisableCollisions ? "true" : "false"
         });
-        
+
         cspClientMessageTypeManager.RegisterOnlineEvent<FastTravelPacket>(OnFastTravelPacket);
     }
 
@@ -59,11 +59,11 @@ private void OnFastTravelPacket(ACTcpClient client, FastTravelPacket packet)
         var (splinePointId, _) = _aiSpline.WorldToSpline(packet.Position);
 
         var splinePoint = _aiSpline.Points[splinePointId];
-        
-        var direction = - _aiSpline.Operations.GetForwardVector(splinePoint.Id);
+
+        var direction = -_aiSpline.Operations.GetForwardVector(splinePoint.Id);
         if (direction == Vector3.Zero)
             direction = new Vector3(1, 0, 0);
-        
+
         client.SendPacket(new FastTravelPacket
         {
             Position = packet.Position,