Skip to content

Commit

Permalink
fix!: changing time to be double
Browse files Browse the repository at this point in the history 
BREAKING CHANGE: time fields are now double instead of float
  • Loading branch information
@James-Frowen
James-Frowen committed Feb 11, 2024
1 parent 10c5300 commit e632c85
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 37 deletions.
20 changes: 10 additions & 10 deletions Assets/NetworkPositionSync/Runtime/InterpolationTime.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ public class InterpolationTime
/// <summary>
/// The time value that the client uses to interpolate
/// </summary>
private float _clientTime;
private double _clientTime;

/// <summary>
/// The client will multiply deltaTime by this scale time value each frame
Expand Down Expand Up @@ -97,27 +97,27 @@ public class InterpolationTime
private float _clientDelay;

// Used for debug purposes. Move along...
private float _latestServerTime;
private double _latestServerTime;

/// <summary>
/// Timer that follows server time
/// </summary>
public float ClientTime
public double ClientTime
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _clientTime;
}
/// <summary>
/// Returns the last time received by the server
/// </summary>
public float LatestServerTime
public double LatestServerTime
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _latestServerTime;
}

[System.Obsolete("Use Time instead")]
public float InterpolationTimeField
public double InterpolationTimeField
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => Time;
Expand All @@ -126,7 +126,7 @@ public float InterpolationTimeField
/// <summary>
/// Current time to use for interpolation
/// </summary>
public float Time
public double Time
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _clientTime - _clientDelay;
Expand Down Expand Up @@ -170,7 +170,7 @@ public void OnUpdate(float deltaTime)
_clientTime += deltaTime * clientScaleTime;
}

public bool IsMessageOutOfOrder(float newServerTime)
public bool IsMessageOutOfOrder(double newServerTime)
{
return newServerTime < _latestServerTime;
}
Expand All @@ -179,7 +179,7 @@ public bool IsMessageOutOfOrder(float newServerTime)
/// Updates <see cref="clientScaleTime"/> to keep <see cref="ClientTime"/> in line with <see cref="LatestServerTime"/>
/// </summary>
/// <param name="serverTime"></param>
public void OnMessage(float serverTime)
public void OnMessage(double serverTime)
{
// only check this if we are initialized
if (initialized)
Expand Down Expand Up @@ -231,7 +231,7 @@ public void Reset()
/// <summary>
/// Initializes and resets the system.
/// </summary>
private void InitNew(float serverTime)
private void InitNew(double serverTime)
{
_clientTime = serverTime;
clientScaleTime = 1;
Expand Down Expand Up @@ -261,7 +261,7 @@ private float CalculateTimeScale(float diff)
else if (diff < negativeThreshold) // Server is falling behind us, we need to slow down.
// *2 here because we want to slow down faster,
// if we dont there wont be any new snapshots to interpolate towards and game will be jittery
return 1 - _scaleModifier * 4;
return 1 - (_scaleModifier * 4);

else // Server and client are on par ("close enough"). Run at normal speed.
return 1;
Expand Down
8 changes: 4 additions & 4 deletions Assets/NetworkPositionSync/Runtime/SyncPositionBehaviour.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ internal bool NeedsUpdate()
/// Applies a state update on the server instance.
/// <para>Called on server.</para>
/// </summary>
internal void ApplyOnServer(TransformState state, float time)
internal void ApplyOnServer(TransformState state, double time)
{
// This should not happen. throw an Exception to disconnect the attacker
if (!clientAuthority)
Expand All @@ -80,7 +80,7 @@ internal void ApplyOnServer(TransformState state, float time)
/// Applies a state update on the client instance.
/// <para>Called on client.</para>
/// </summary>
internal void ApplyOnClient(TransformState state, float time)
internal void ApplyOnClient(TransformState state, double time)
{
// Not host.
// Host will have already handled movement in servers code
Expand Down Expand Up @@ -311,7 +311,7 @@ public void OnStopClient()
public void OnStopServer()
{
// null check incase OnStopClient is called first
if (_system !=null)
if (_system != null)
_system.Behaviours.RemoveBehaviour(this);
_system = null;
}
Expand All @@ -335,7 +335,7 @@ private void Update()
/// <para>Adds to buffer for interpolation</para>
/// </summary>
/// <param name="state"></param>
private void AddSnapShotToBuffer(TransformState state, float serverTime)
private void AddSnapShotToBuffer(TransformState state, double serverTime)
{
// dont apply on local owner
if (IsLocalClientInControl)
Expand Down
6 changes: 3 additions & 3 deletions Assets/NetworkPositionSync/Runtime/SyncPositionBehaviour_Debug.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,11 +60,11 @@ private void Update()
markers[i].SetActive(true);
markers[i].transform.SetPositionAndRotation(snapshot.state.position, snapshot.state.rotation);
var pos = snapshot.state.position;
var hash = pos.x * 501 + pos.z;
markers[i].GetComponent<Renderer>().material.color = Color.HSVToRGB((hash * 20) % 1, 1, 1);
var hash = (pos.x * 501) + pos.z;
markers[i].GetComponent<Renderer>().material.color = Color.HSVToRGB(hash * 20 % 1, 1, 1);
var snapshotTime = _system.TimeSync.InterpolationTimeField;

var absTimeDiff = Mathf.Abs(snapshotTime - (float)snapshot.time);
var absTimeDiff = Mathf.Abs((float)(snapshotTime - snapshot.time));
var sizeFromDiff = Mathf.Clamp01((maxTime - absTimeDiff) / maxTime);
var scale = sizeFromDiff * MaxScale;
markers[i].transform.localScale = Vector3.one * scale;
Expand Down
30 changes: 15 additions & 15 deletions Assets/NetworkPositionSync/Runtime/SyncPositionSystem.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,10 @@ public class SyncPositionSystem : MonoBehaviour
[Header("Snapshot Interpolation")]
[Tooltip("Number of ticks to delay interpolation to make sure there is always a snapshot to interpolate towards. High delay can handle more jitter, but adds latancy to the position.")]
public float TickDelayCount = 2;

[Tooltip("How much to modify the timescale of interpolation clock when ahead or behind the server")]
public float TimeScaleModifier = 0.01f;

[Tooltip("SendToAll option skips visibility and sends position to all ready connections.")]
public SyncMode syncMode = SyncMode.SendToAll;

Expand Down Expand Up @@ -270,7 +270,7 @@ public void Update()
ClientUpdate(timer.Delta);
}

private void ServerUpdate(float time)
private void ServerUpdate(double time)
{
if (!ServerActive) return;

Expand Down Expand Up @@ -309,7 +309,7 @@ private void ClientUpdate(float deltaTime)
TimeSync.OnUpdate(deltaTime);
}

internal void SendUpdateToAll(float time)
internal void SendUpdateToAll(double time)
{
// dont send message if no behaviours
if (Behaviours.Dictionary.Count == 0)
Expand Down Expand Up @@ -343,7 +343,7 @@ internal void SendUpdateToAll(float time)
/// Loops through all players, followed by all dirty objects and checks if the player object can see each one
/// </summary>
/// <param name="time"></param>
internal void SendUpdateToObservers_PlayerDirty(float time)
internal void SendUpdateToObservers_PlayerDirty(double time)
{
// dont send message if no behaviours
if (Behaviours.Dictionary.Count == 0)
Expand Down Expand Up @@ -382,7 +382,7 @@ internal void SendUpdateToObservers_PlayerDirty(float time)
/// ...except this one packs data once.
/// </summary>
/// <param name="time"></param>
internal void SendUpdateToObservers_PlayerDirty_PackOnce(float time)
internal void SendUpdateToObservers_PlayerDirty_PackOnce(double time)
{
// dont send message if no behaviours
if (Behaviours.Dictionary.Count == 0)
Expand Down Expand Up @@ -441,7 +441,7 @@ private PooledNetworkWriter GetWriterFromPool_Behaviours(SyncPositionBehaviour b
/// Loops through all dirty objects, and then their observers and then writes that behaviouir to a cahced writer
/// </summary>
/// <param name="time"></param>
internal void SendUpdateToObservers_DirtyObservers(float time)
internal void SendUpdateToObservers_DirtyObservers(double time)
{
// dont send message if no behaviours
if (Behaviours.Dictionary.Count == 0)
Expand Down Expand Up @@ -477,7 +477,7 @@ internal void SendUpdateToObservers_DirtyObservers(float time)
/// <para>But Packs once and copies bytes</para>
/// </summary>
/// <param name="time"></param>
internal void SendUpdateToObservers_DirtyObservers_PackOnce(float time)
internal void SendUpdateToObservers_DirtyObservers_PackOnce(double time)
{
// dont send message if no behaviours
if (Behaviours.Dictionary.Count == 0)
Expand Down Expand Up @@ -518,7 +518,7 @@ internal void SendUpdateToObservers_DirtyObservers_PackOnce(float time)

private Dictionary<INetworkPlayer, PooledNetworkWriter> writerPool = new Dictionary<INetworkPlayer, PooledNetworkWriter>();

private PooledNetworkWriter GetWriterFromPool(float time, INetworkPlayer player)
private PooledNetworkWriter GetWriterFromPool(double time, INetworkPlayer player)
{
if (!writerPool.TryGetValue(player, out var writer))
{
Expand Down Expand Up @@ -606,30 +606,30 @@ internal void ServerHandleNetworkPositionMessage(INetworkPlayer _, NetworkPositi
public class Timer
{
private readonly Stopwatch stopwatch = Stopwatch.StartNew();
private float _previous;
private double _previous;
private float _delta;
private float _now;
private double _now;

public float Delta
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _delta;
}
public float Now
public double Now
{
[MethodImpl(MethodImplOptions.AggressiveInlining)]
get => _now;
}

private float GetNow()
private double GetNow()
{
return (float)(stopwatch.Elapsed.TotalMilliseconds / 1000f);
return (double)(stopwatch.Elapsed.TotalMilliseconds / 1000.0);
}

public void Update()
{
_now = GetNow();
_delta = _now - _previous;
_delta = (float)(_now - _previous);
_previous = _now;
}
}
Expand Down
44 changes: 39 additions & 5 deletions Assets/NetworkPositionSync/Runtime/SyncSettings.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
using Mirage;
using Mirage.Serialization;
using UnityEngine;
using static JamesFrowen.PositionSync.SyncPacker;

namespace JamesFrowen.PositionSync
{
Expand Down Expand Up @@ -55,9 +56,9 @@ public class SyncSettings
public int bitCount = 10;

// Data Packers.
public VarFloatPacker CreateTimePacker()
public VarDoublePacker CreateTimePacker()
{
return new VarFloatPacker(timePrecision, blockSize);
return new VarDoublePacker(timePrecision, blockSize);
}
public VarVector3Packer CreatePositionPacker()
{
Expand All @@ -72,7 +73,7 @@ public QuaternionPacker CreateRotationPacker()
public class SyncPacker
{
// packers
private readonly VarFloatPacker timePacker;
private readonly VarDoublePacker timePacker;
private readonly VarVector3Packer positionPacker;
private readonly QuaternionPacker rotationPacker;
private readonly int blockSize;
Expand All @@ -87,7 +88,7 @@ public SyncPacker(SyncSettings settings)
includeCompId = settings.IncludeComponentIndex;
}

public void PackTime(NetworkWriter writer, float time)
public void PackTime(NetworkWriter writer, double time)
{
timePacker.Pack(writer, time);
}
Expand All @@ -110,7 +111,7 @@ public void PackNext(NetworkWriter writer, SyncPositionBehaviour behaviour)
}


public float UnpackTime(NetworkReader reader)
public double UnpackTime(NetworkReader reader)
{
return timePacker.Unpack(reader);
}
Expand Down Expand Up @@ -150,6 +151,39 @@ internal bool TryUnpackNext(PooledNetworkReader reader, out NetworkBehaviour.Id
return false;
}
}



/// <summary>
/// Packs a float using <see cref="ZigZag"/> and <see cref="VarIntBlocksPacker"/>
/// </summary>
public sealed class VarDoublePacker
{
private readonly int _blockSize;
private readonly double _precision;
private readonly double _inversePrecision;

public VarDoublePacker(double precision, int blockSize)
{
_precision = precision;
_blockSize = blockSize;
_inversePrecision = 1 / precision;
}

public void Pack(NetworkWriter writer, double value)
{
var scaled = (int)Math.Round(value * _inversePrecision);
var zig = ZigZag.Encode(scaled);
VarIntBlocksPacker.Pack(writer, zig, _blockSize);
}

public double Unpack(NetworkReader reader)
{
var zig = (uint)VarIntBlocksPacker.Unpack(reader, _blockSize);
var scaled = ZigZag.Decode(zig);
return scaled * _precision;
}
}
}

//[Serializable]
Expand Down

0 comments on commit e632c85

Please sign in to comment.