Movements overhaul #2189

tornac1234 · 2024-10-30T11:39:45Z

Reason for PR 🤔:

Current state of vehicles movements is really poor, both for regular play, and for testing the brand new #2106.
+ the network optimization behind movements is currently really poor and mostly random
Latest rework of movements (after modpocalypse) messed up movements sync, and it was never that suitable for Nitrox.

Benefits of the PR 🤩:

Will drastically improve movements for players and vehicles:

Only 30 packets/second are now required per tracked unit (players and vehicles) which is a lot better than it used to be (it had even poorer visible performance)
Packets will be lighter than before
New system is adaptable to poorer connections (there are two settings for the automatically adjusted latency system)
While having different latency between players might cause a bit of frustration (e.g being hit on another player screen while they're still safe on their own screen), it is the best compromise between performance and playability.

Tasks for myself 🍙🍜🍣 (I kept the best ones 😋):

Reimplement channels in LiteNetLib (we always had a setting in packets but we never actually fed it to LiteNetLib)
Create a new dedicated MovementReplicator MonoBehaviour responsible for reproducing players and vehicles movements, while automatically taking variable latency into account
Deprecate our old system (delete the old packets and MultiplayerCyclops (etc) behaviours)
Make some classes inheriting from MovementReplicator for the Cyclops, Seamoth and Exosuit to have their animations working accordingly with the replicated movement.
Have players be set to at the right position when they're driving a vehicle (vehicles packets' might require at least one more field or two for steering wheel and throttle data (can probably be reduced to a byte for the angles, and a bool for appliedThrottle), but as long as we know it's a cyclops, we can hardcode the relative localposition to avoid sending that data

Tasks assigned to @Jannify 🍕🍔🍟 (thanks for proposing your help 😀):

Finally make use of VehicleOnPilotModeChanged packet to be the trigger of a remote player entering/exitting a vehicle (and no longer have a very weird logic like the current Vehicles.UpdateVehiclePosition)
Ensure remote players remain in place during the driving (that I supposedly fixed with cyclops movement PR)
Rework docking and undocking accordingly to the new movement system (a trigger must be sent to start the animations, during which remote players will ignore incoming data for the vehicles involved)

Translations to be added to Weblate 📜🌐:

NitroxBandwidthSettings: Bandwidth Settings
NitroxHigherForUnstable_Tooltip: Give a higher value for more unstable connections
NitroxSettingsLatencyUpdatePeriod: Latency Update Period (s)
NitroxSettingsSafetyLatencyMargin: Safety Latency Margin (ms)

Context images for the translations:

…timization), added a setting to adjust movement latency

… with reduced packet load

…s latency managing, and files cleanup

…w one integrated in the new movement system

…being set correctly

tornac1234 · 2024-11-03T12:19:35Z

This PR is now ready for both tests and reviews :)

NitroxClient/Communication/Packets/Processors/VehicleDockingProcessor.cs

NitroxClient/GameLogic/MobileVehicleBay.cs

NitroxClient/GameLogic/Settings/NitroxPrefs.cs

NitroxClient/GameLogic/Settings/NitroxSettingsManager.cs

NitroxClient/GameLogic/Vehicles.cs

NitroxClient/MonoBehaviours/Vehicles/ExosuitMovementReplicator.cs

NitroxClient/MonoBehaviours/Vehicles/SeaMothMovementReplicator.cs

dartasen · 2024-11-10T11:48:03Z

Translations string has been added to Weblate, modified the format a bit so it matches with existing keys :

Nitrox_Settings_Bandwidth Bandwidth Settings
Nitrox_Settings_HigherForUnstable_Tooltip Give a higher value for unstable connections
Nitrox_Settings_LatencyUpdatePeriod Latency Update Period (s)
Nitrox_Settings_SafetyLatencyMargin Safety Latency Margin (ms)

NitroxPatcher/Patches/Dynamic/Exosuit_GetVelocity_Patch.cs

NitroxClient/GameLogic/SimulationOwnership.cs

… being deleted when the vehicle is gone, being too far from the piloting chair, destroying a cyclop's objects would bug for players outside the cyclops, remote player wrong rotation in bases

Coding-Hen

Typical merged it a few minutes before I finished the review I was doing. Sorry for being slow but thought I would still comment them. Good code!

Coding-Hen · 2024-11-10T17:09:34Z

NitroxClient/GameLogic/TimeManager.cs

@@ -111,10 +111,11 @@ public void ProcessUpdate(TimeChange packet)

        latestRegistrationTime = DateTimeOffset.FromUnixTimeMilliseconds(packet.UpdateTime);
        latestRegisteredTime = packet.CurrentTime;
-
+
+        // We don't want to have a big DeltaTime when processing a time skip so we calculate it beforehands


Suggested change

// We don't want to have a big DeltaTime when processing a time skip so we calculate it beforehands

// We don't want to have a big DeltaTime when processing a time skip so we calculate it beforehand

NitroxClient/GameLogic/MobileVehicleBay.cs

Coding-Hen · 2024-11-12T18:44:26Z

NitroxClient/MonoBehaviours/MovementBroadcaster.cs

+
+    public void Update()
+    {
+        float currentTime = (float)this.Resolve<TimeManager>().RealTimeElapsed;


Do we need this to be cast to float or can we have it as it is for the evaluation of the if?

Coding-Hen · 2024-11-12T18:51:44Z

NitroxClient/MonoBehaviours/MovementReplicator.cs

+
+        if (latency > maxAllowedLatency)
+        {
+            maxAllowedLatency = latency + SafetyLatencyMargin;


This calculation seems strange to me, we are saying are we higher than the max allowed and then resetting that. It feels like if it's the max allowed we shouldn't go past this. Interested in others thoughts

Coding-Hen · 2024-11-12T18:57:20Z

NitroxClient/MonoBehaviours/MovementReplicator.cs

+            }
+        }
+
+        float occurrenceTime = time + INTERPOLATION_TIME + maxAllowedLatency;


With this won't this calculation be different for everyone and so mean each client has them out of sync?

Coding-Hen · 2024-11-12T22:33:38Z

NitroxServer/Communication/Packets/Processors/VehicleMovementsPacketProcessor.cs

+            if (simulationOwnershipData.GetPlayerForLock(movementData.Id) != player)
+            {
+                Log.WarnOnce($"Player {player.Name} tried updating {movementData.Id}'s position but they don't have the lock on it");
+                // TODO: In the future, add "packet.Data.RemoveAt(i);" and "continue;" to prevent those abnormal situations


Would this not be an easy thing to do now? Why wait?

* Changed movement replicator's buffer to be a LinkedList (very good optimization), added a setting to adjust movement latency * Huge improvements to get a smooth movements for seamoths and exosuits with reduced packet load * Reimplement channels into LiteNetLib * First attempt at implementing a variable latency adaptor * Fix channels (again), add two settings for better control of movements latency managing, and files cleanup * Deprecate the current vehicle animation system and replace it by a new one integrated in the new movement system * Fix seamoth enter sound playing all over the map, cyclops driver not being set correctly * Restore driver state of other players when connecting to a server * Fix remotely driven exosuits' animations * Fix a possible divide by zero from TimeManager.DeltaTime * Refactor docking code to bring it up to new standard * Decouple docking patches from Vehicles.cs * Supress MovementReplicator during (un)docking * Fix docking processor * Few corrections for docking and simulation ownership * Refactors and little corrections here and there * Add a movement broadcast rate limiter * Fix bugs: not being able to drive a vehicle, rate limiter entries not being deleted when the vehicle is gone, being too far from the piloting chair, destroying a cyclop's objects would bug for players outside the cyclops, remote player wrong rotation in bases --------- Co-authored-by: Jannify <[email protected]>

tornac1234 added 7 commits October 26, 2024 13:39

WIP

3e7c40e

Changed movement replicator's buffer to be a LinkedList (very good op…

67dbc24

…timization), added a setting to adjust movement latency

Huge improvements to get a smooth movements for seamoths and exosuits…

7d56989

… with reduced packet load

Reimplement channels into LiteNetLib

e3c364f

First attempt at implementing a variable latency adaptor

e762c9c

Fix channels (again), add two settings for better control of movement…

ee9b937

…s latency managing, and files cleanup

Deprecate the current vehicle animation system and replace it by a ne…

f8569e0

…w one integrated in the new movement system

tornac1234 added Type: bug Area: vehicles Related to vehicles (seamoth, cyclops, prawn) Complexity: hard Requires deep understanding and/or hard to setup and verify Area: player Related to player character actions Type: enhancement labels Nov 1, 2024

tornac1234 and others added 9 commits November 1, 2024 18:07

Fix seamoth enter sound playing all over the map, cyclops driver not …

fa4b1ae

…being set correctly

Restore driver state of other players when connecting to a server

8852d26

Fix remotely driven exosuits' animations

e5bc3a8

Fix a possible divide by zero from TimeManager.DeltaTime

0d4b2d3

Refactor docking code to bring it up to new standard

5eed7ed

Decouple docking patches from Vehicles.cs

a4c41ef

Supress MovementReplicator during (un)docking

f145902

Fix docking processor

d9ed3db

Few corrections for docking and simulation ownership

8f38ff0

Jannify requested changes Nov 7, 2024

View reviewed changes

Measurity reviewed Nov 10, 2024

View reviewed changes

NitroxPatcher/Patches/Dynamic/Exosuit_GetVelocity_Patch.cs Outdated Show resolved Hide resolved

NitroxClient/GameLogic/SimulationOwnership.cs Outdated Show resolved Hide resolved

NitroxClient/GameLogic/SimulationOwnership.cs Outdated Show resolved Hide resolved

tornac1234 added 2 commits November 10, 2024 21:01

Refactors and little corrections here and there

cbdad29

Add a movement broadcast rate limiter

3211798

dartasen mentioned this pull request Nov 11, 2024

Movement Overhaul #2073

Closed

8 tasks

tornac1234 added this to the 1.8 milestone Nov 11, 2024

Fix bugs: not being able to drive a vehicle, rate limiter entries not…

b6b86ca

… being deleted when the vehicle is gone, being too far from the piloting chair, destroying a cyclop's objects would bug for players outside the cyclops, remote player wrong rotation in bases

tornac1234 force-pushed the movements-overhaul branch from 43d370b to b6b86ca Compare November 11, 2024 23:52

Fix a remove while enumerating in dictionary

7d32fe7

dartasen approved these changes Nov 12, 2024

View reviewed changes

dartasen requested review from Jannify and Measurity November 12, 2024 20:24

Jannify approved these changes Nov 12, 2024

View reviewed changes

dartasen merged commit c0f346a into SubnauticaNitrox:master Nov 12, 2024

Coding-Hen approved these changes Nov 12, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Movements overhaul #2189

Movements overhaul #2189

tornac1234 commented Oct 30, 2024 •

edited

Loading

tornac1234 commented Nov 3, 2024 •

edited

Loading

dartasen commented Nov 10, 2024 •

edited

Loading

Coding-Hen left a comment •

edited by dartasen

Loading

Coding-Hen Nov 10, 2024

Coding-Hen Nov 12, 2024

Coding-Hen Nov 12, 2024

Coding-Hen Nov 12, 2024

Coding-Hen Nov 12, 2024

	// We don't want to have a big DeltaTime when processing a time skip so we calculate it beforehands
	// We don't want to have a big DeltaTime when processing a time skip so we calculate it beforehand

Movements overhaul #2189

Movements overhaul #2189

Conversation

tornac1234 commented Oct 30, 2024 • edited Loading

Reason for PR 🤔:

Benefits of the PR 🤩:

Tasks for myself 🍙🍜🍣 (I kept the best ones 😋):

Tasks assigned to @Jannify 🍕🍔🍟 (thanks for proposing your help 😀):

Translations to be added to Weblate 📜🌐:

tornac1234 commented Nov 3, 2024 • edited Loading

dartasen commented Nov 10, 2024 • edited Loading

Coding-Hen left a comment • edited by dartasen Loading

Choose a reason for hiding this comment

Coding-Hen Nov 10, 2024

Choose a reason for hiding this comment

Coding-Hen Nov 12, 2024

Choose a reason for hiding this comment

Coding-Hen Nov 12, 2024

Choose a reason for hiding this comment

Coding-Hen Nov 12, 2024

Choose a reason for hiding this comment

Coding-Hen Nov 12, 2024

Choose a reason for hiding this comment

tornac1234 commented Oct 30, 2024 •

edited

Loading

tornac1234 commented Nov 3, 2024 •

edited

Loading

dartasen commented Nov 10, 2024 •

edited

Loading

Coding-Hen left a comment •

edited by dartasen

Loading