Added events for when server forces a reconcile

Author: Tshadow05

Runtime/Code/Player/Character/MovementSystem/CharacterMovement.cs

@@ -122,7 +122,7 @@ public bool disableInput {
 	private bool crouchInput;
 
 	//Prediction
-	private bool queueReplay = false;
+	private bool queueForcedReconcile = false;
 #endregion
 
 #region SYNC DATA
@@ -293,9 +293,9 @@ public void RunMovementTick(bool isReplay = false){
 		Move(currentMoveState.currentMoveInput);
 
 		//Queue after a movement tick so we have the updated position and velocity
-		if(isServerOnly && queueReplay){
-			predictedMovement.ForceReplay();
-			queueReplay = false;
+		if(isServerOnly && queueForcedReconcile){
+			queueForcedReconcile = false;
+			predictedMovement.ForceReconcile();
 		}
 
 		OnEndMove?.Invoke(currentMoveState, isReplay);
@@ -897,7 +897,8 @@ public void TeleportAndLook(Vector3 position, Vector3 lookVector) {
 			//Teleport Locally
 			TeleportInternal(position, lookVector);
 			if(isServerAuth && isServerOnly){
-				this.queueReplay = true;
+				Debug.Log("Queueing Forced Reconcile");
+				this.queueForcedReconcile = true;
 			}
 		} else if(!isServerAuth && isServerOnly){
 			//Tell client to teleport
@@ -1001,7 +1002,7 @@ public void SetImpulse(Vector3 impulse){
 			//Locally
 			SetImpulseInternal(impulse);
 			if(isServerAuth && isServerOnly){
-				this.queueReplay = true;
+				this.queueForcedReconcile = true;
 			}
 		} else if(!isServerAuth && isServerOnly){
 			//Tell client

Runtime/Code/Player/Character/MovementSystem/ClientPrediction/AirshipPredictedController.cs

@@ -42,6 +42,9 @@ public abstract class AirshipPredictedController<T> : NetworkBehaviour, IPredict
     [Tooltip("Optimization. Reduce the number of reconciles by only reconciling every N frames")]
     public int checkReconcileEveryNthFrame = 4;
 
+    [Tooltip("If true the object will replay after a forced reconcile. If false the object will clear its history and start over from the point of the server")]
+    public bool replayForcedReconciles = false;
+
     [Tooltip("Applying server corrections one frame ahead gives much better results. We don't know why yet, so this is an option for now.")]
     public int serverSerializationOffset = 1;
     public int replayTickOffset = 0;
@@ -119,6 +122,8 @@ public abstract class AirshipPredictedController<T> : NetworkBehaviour, IPredict
 #endregion
 
 #region VIRTUAL
+    public virtual void OnServerForceReconcile(){}
+    public virtual void OnClientForcedReconcile(){}
     public virtual string friendlyName => "Prediction: " + gameObject.GetInstanceID();
     public virtual float guid => gameObject.GetInstanceID();
 
@@ -233,10 +238,10 @@ protected virtual void OnPhysicsTick() {
 
 
 #region PREDICTION
-    private bool forceNextReplay = false;
-    public void ForceReplay(){
+    private bool forceNextReconcile = false;
+    public void ForceReconcile(){
         if(isServerOnly){
-            forceNextReplay = true;
+            forceNextReconcile = true;
         }
     }
 
@@ -325,19 +330,26 @@ protected void OnReceivedState(int serverTick, T serverState, bool forceReplay)
 
         if(forceReplay){
             int forcedIndex;
-            if(stateHistory.Count <= 2){
-                //Shouldn't this be apply state so it actually saves into the history?
-                //ApplyState(serverState);
-                SnapTo(serverState);
-                return;
-            } else if (Sample(stateHistory, serverTick, out T before, out forcedIndex)) {
+            if(!replayForcedReconciles || stateHistory.Count <= 2){
+                print("FORCING RECONCILE");
+                stateHistory.Clear();
+                ApplyState(serverState);
+            }
+            // else if(stateHistory.Count <= 2){
+            //     //Shouldn't this be apply state so it actually saves into the history?
+            //     //ApplyState(serverState);
+            //     SnapTo(serverState);
+            // } 
+            else if (Sample(stateHistory, serverTick, out T before, out forcedIndex)) {
+                print("FORCING REPLAY");
                 AirshipPredictionManager.instance.QueueReplay(this, serverState, lastRecorded.tick - 1 + replayTickOffset, forcedIndex);
-                return;
             } else {
                 // something went very wrong. sampling should've worked.
                 Debug.LogError("Unable to sample with a forced replay at tick: " + serverTick);
                 PrintHistory();
             }
+            OnClientForcedReconcile();
+            return;
         }
 
         // correction requires at least 2 existing states for 'before' and 'after'.
@@ -504,8 +516,11 @@ public override void OnSerialize(NetworkWriter writer, bool initialState) {
         writer.WriteInt(serverTick);
 
         //Pass a bool to signify if client MUST replay
-        writer.WriteBool(forceNextReplay);
-        forceNextReplay = false;
+        writer.WriteBool(forceNextReconcile);
+        if(forceNextReconcile){
+            OnServerForceReconcile();
+            forceNextReconcile = false;
+        }
 
         //Let the child class serialize its data
         SerializeState(writer);
@@ -527,8 +542,11 @@ public override void OnDeserialize(NetworkReader reader, bool initialState) {
         //Get server tick
         SetServerTick(reader.ReadInt());
 
-        //Must we replay?
-        var forceReplay = reader.ReadBool();
+        //Must we force to the server?
+        var forceReconcile = reader.ReadBool();
+        if(forceReconcile){
+            OnServerForceReconcile();
+        }
 
         //print("GOT server tick: " + serverTick + " predictedTick: " + predictedTick + " offset: " + offset +  " offsetTime: " + NetworkTime.predictionErrorUnadjusted);
 
@@ -549,7 +567,7 @@ public override void OnDeserialize(NetworkReader reader, bool initialState) {
         //print("Deserialize time: " + timestamp + " readerTime: " + serverDeltaTime);
         // process received state
         try{
-            OnReceivedState(serverTick, newState, forceReplay);
+            OnReceivedState(serverTick, newState, forceReconcile);
         }catch(Exception e){
             Debug.LogError("Error on recieved state: " + e.Message + " trace: " + e.StackTrace);
         }

Runtime/Code/Player/Character/MovementSystem/ClientPrediction/AirshipPredictionManager.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using Mirror;
+using UnityEditorInternal;
 using UnityEngine;
 
 public class AirshipPredictionManager : MonoBehaviour {
@@ -47,6 +48,7 @@ internal class RigidbodyState{
         public Quaternion currentRotation;
         public Vector3 lastPosition;
         public Quaternion lastRotation;
+        public int snapTicks = 0;
 
         public RigidbodyState(Rigidbody rigid, Transform graphicsHolder){
             this.rigid = rigid;
@@ -108,6 +110,12 @@ public void RegisterRigidbody(Rigidbody rigid, Transform graphicsHolder) {
     public void UnRegisterRigidbody(Rigidbody rigid) {
         this.currentTrackedRigidbodies.Remove(rigid.GetInstanceID());
     }
+
+    public void SnapRigidbody(Rigidbody rigid, int numberOfTicks = 1){
+        if(this.currentTrackedRigidbodies.TryGetValue(rigid.GetInstanceID(), out RigidbodyState state)){
+            state.snapTicks = numberOfTicks;
+        }
+    }
 #endregion
 
 #region UPDATE
@@ -188,6 +196,12 @@ public void InterpolateBodies(){
         //TODO: Sort the rigidbodies by depth (how deep in heirarchy?) so that we update nested rigidbodies in the correct order
         foreach(var kvp in currentTrackedRigidbodies){
             var rigidData = kvp.Value;
+            if(rigidData.snapTicks > 0){
+                print("Snapping rigidbody");
+                rigidData.snapTicks--;
+                rigidData.lastPosition = rigidData.currentPosition;
+                rigidData.lastRotation = rigidData.currentRotation;
+            }
             // rigidData.graphicsHolder.SetPositionAndRotation(
             //     Vector3.Lerp(rigidData.lastPosition, rigidData.currentPosition, interpolationTime), 
             //     Quaternion.Lerp(rigidData.lastRotation, rigidData.currentRotation, interpolationTime)

Runtime/Code/Player/Character/MovementSystem/ClientPrediction/CharacterMovement/AirshipPredictedCharacterMovement.cs

@@ -16,7 +16,8 @@ public class AirshipPredictedCharacterMovement : AirshipPredictedController<Char
     [Header("Character References")]
     public CharacterMovement movement;
 
-    [Header("Variables")]
+    [Header("Character Variables")]
+    public bool snapPositionOnReconcile = true;
 
 #endregion
 
@@ -195,6 +196,20 @@ public override void SnapTo(CharacterMovementState newState){
         }
     }
 
+    public override void OnClientForcedReconcile() {
+        if(snapPositionOnReconcile){
+            print("Telling prediction to snap");
+            //Snap the movement so it doesn't lerp to the forced position
+            AirshipPredictionManager.instance.SnapRigidbody(this.movement.rigidbody, 5);
+        }
+    }
+
+    public override void OnServerForceReconcile() {
+        if(!replayForcedReconciles){
+            this.recievedInputs.Clear();
+        }
+    }
+
     public override void OnReplayStarted(AirshipPredictedState initialState, int historyIndex){
         if(showLogs){
             print("Replay start: " + initialState.tick);