Implement client bubble PVS. #983

Tyler-IN · 2020-02-16T01:44:48Z

You guys call it bubbling. PVS means Potentially Visible Set.

Robust.Shared/GameObjects/EntityManager.cs

Robust.Shared/Interfaces/GameObjects/IEntityManager.cs

Robust.Shared/Network/NetManager.cs

Clyybber

Awesome

Tyler-IN · 2020-02-19T22:59:35Z

FYI there are still some outstanding known errata w/ picking parents/children.

Needs more testing to narrow down when/where/how.

I will be making client changes to support position being NaN in state updates as "don't vanish until seen" mechanics so the client can't see things are being unseen.

Robust.Server/GameStates/ServerGameStateManager.cs

Robust.Client/GameObjects/ClientEntityManager.cs

Robust.Shared/GameObjects/EntityManager.cs

TYoung86 · 2020-02-22T21:31:03Z

from discord, a rough explanation;

so when a player joins, they get sent the entire world
the last seen dictionary stores anything that they've seen that has changed since that tick
as just a (uid,tick) pair
if they come across something that has a different change tick than they've last seen that's inside their bubble, they get the state
if it hasn't changed since they last saw it, no state is sent nor needs to be
if something changes outside their bubble that they have previously seen, the NaN covers that situation that would produce a ghost
the client can be updated (imo separate PR) to handle NaNs by hiding the object temporarily until the next position comes in, instead of updating the pos
or the process can be changed to just send some new "unsee this" message instead of position NaN
when they "unsee" something, it's removed from the last seen dictionary
so it doesn't blow up and replicate the world inside the dictionary
the lastSeen dictionary only gets queried or built based on their bubble
so it should virtually always be a subset of the world, worst case they've somehow seen everything and it's the full set of uids but just ticks
in a future PR I'd like to exclude sending container contents, and maybe re-work some of the handling so sending updates to parents can be more relaxed
right now immobile objects like snap grid objects outside the bubble get NaN'd prematurely when they're destroyed if they're in some common parent/child heirarchy

include contained entities fix line edit crash when clipboard contents are null somehow use CVar for update bubble range remove seenMovers that get NaN'd out of MaxUpdateRange - huge reduction in network traffic from bullets cut default of MaxUpdateRange down to 12.5 for now maybe handle teleported things handle removing player state on disconnect fixed positional audio errors make UpdateEntityTree also update player's last seen ents make net.maxupdaterange cvar tunable at runtime w/o impacting performance back to position nan as means to hide from client revert work pooling as the wrong player was getting the wrong game state ffs needed to think less about *if* something is *seen* and more about *when* it must be *unseen* clean up usings handle parenting and sequencing issues that arise on the client gather needed ents to update recursively applied suggestions from code review fix missing recursively contained ents make assumption that client last saw things on first tick instead of tick zero, as zero would be the "from tick" and first would be he "to tick" add First tick as constant to GameTick due to relevance above renamed includedEnts to checkedEnts to make usage more clear added comments inverted some conditions to flatten parts of the pvs logic fixed sending states when already seen (lastChange < lastSeen to lastChange <= lastSeen) fix sending states when no actual changes (other bugs?) local caching of currentTick, remove priorTick

…ating network state if AttachParent isn't invoked

PJB3005

Would it be possible to introduce an explicit off switch (that also would work if changed mid game?).

PJB3005 · 2020-02-22T20:42:20Z

Robust.Client/GameObjects/EntitySystems/AudioSystem.cs

+            if (!source.SetPosition(entity.Transform.WorldPosition))
+            {
+                Logger.Warning("Can't play positional audio, can't set position.");
+                return null;


Not sure it's a good idea for this to ever return null. Even in the worst scenario it might just be better to have this return a dummy value that's seen as stopped?

The only outer caller doesn't evaluate the result of Play.

How should it handle this case?

PJB3005 · 2020-02-22T20:42:38Z

Robust.Client/GameObjects/EntitySystems/AudioSystem.cs

+            if (!source.SetPosition(coordinates.ToMapPos(_mapManager)))
+            {
+                Logger.Warning("Can't play positional audio, can't set position.");
+                return null;


Ditto on returning null here.

PlayAudioPositionalHandler as the only outer caller doesn't check the return value.
Do you want it to verify if a sound played?

PJB3005 · 2020-02-22T20:44:23Z

Robust.Client/Graphics/Clyde/Audio/Clyde.Audio.cs

            {
                _checkDisposed();

+                var (x, y) = position;
+
+                if (!ValidatePosition(x, y))


This feels like really bad API design to me.

Maybe make this throw on NaN and have the uses explicitly check for it before calling?

Outside of the API it's used like this;

if (!renderer.Source.SetPosition(renderer.TrackingEntity.Transform.WorldPosition)) { Shared.Log.Logger.Warning("Interrupting positional audio, can't set position."); renderer.Source.StopPlaying(); }

Adding [MustUseReturnValue] makes the API require the bool to be checked or issue a warning on complying IDEs.
The caller should just stop playing the sound if the position is NaN, because that indicates it's an entity the client is unaware of the position. If this ever occurs, it's probably intentional.
I think Audio that's not relatively quiet or localized needs to be sent with a specifically with a position and not an entity. There should be no guarantee that a sound can play at any position.

Do you think it should be TrySetPosition instead?

PJB3005 · 2020-02-22T20:46:25Z

Robust.Server/GameObjects/ServerEntityManager.cs

 #pragma warning restore 649

-        private int _nextServerEntityUid = (int)EntityUid.FirstUid;
+        private float? _maxUpdateRangeCache;


This thing doesn't actually get assigned outside of that null down there.

That's correct... so the server can update _maxUpdateRangeCache related cvar once per frame.

Oh I read this wrong, I thought you meant it doesn't get assigned except for the null and where it gets assigned...

public float MaxUpdateRange => _maxUpdateRangeCache ??= _configurationManager.GetCVar<float>("net.maxupdaterange");

^ It gets assigned there. It's just 2 lines down.

Oh, my bad.

Robust.Server/GameObjects/ServerEntityManager.cs

PJB3005 · 2020-02-22T23:25:59Z

Robust.Server/GameObjects/ServerEntityManager.cs

+        public List<EntityState> UpdatePlayerSeenEntityStates(GameTick fromTick, IPlayerSession player, float range)
+        {
+            var playerEnt = player.AttachedEntity;
+            if (playerEnt == null)


Players in the lobby have no entity, so...

What does this mean?

…nt's Children collection and other stuff rotating parent entities now are visible with their orbiting children if one of their children moves into view

introduce net.pvs to configure enabling/disabling PVS

Tyler-IN · 2020-02-23T01:57:36Z

Would it be possible to introduce an explicit off switch (that also would work if changed mid game?).

Added.

Acruid

There are a few edge cases that need to be looked at, mainly around world parenting and shuttles. As far as I can tell these problems are because the TransformComponent is poorly implemented, and really needs some testing and API tweaks. The main features were successfully implemented and seem stable enough for the CM test at the end of the month, so I am approving this.

Tyler-IN requested review from Acruid, PJB3005 and ZoldorfTheWizard as code owners February 16, 2020 01:44

Tyler-IN changed the title ~~Implement client bubbling.~~ Implement client bubble PVS. Feb 18, 2020

Clyybber reviewed Feb 19, 2020

View reviewed changes

Robust.Shared/GameObjects/EntityManager.cs Show resolved Hide resolved

Clyybber reviewed Feb 19, 2020

View reviewed changes

Robust.Shared/Interfaces/GameObjects/IEntityManager.cs Show resolved Hide resolved

Clyybber reviewed Feb 19, 2020

View reviewed changes

Robust.Shared/Network/NetManager.cs Outdated Show resolved Hide resolved

Clyybber reviewed Feb 19, 2020

View reviewed changes

Tyler-IN commented Feb 20, 2020

View reviewed changes

Robust.Server/GameStates/ServerGameStateManager.cs Outdated Show resolved Hide resolved

Tyler-IN commented Feb 20, 2020

View reviewed changes

Robust.Client/GameObjects/ClientEntityManager.cs Outdated Show resolved Hide resolved

Tyler-IN commented Feb 20, 2020

View reviewed changes

Robust.Shared/GameObjects/EntityManager.cs Outdated Show resolved Hide resolved

Tyler-IN force-pushed the bubble branch 4 times, most recently from 58c4c65 to 9827f0a Compare February 22, 2020 19:54

Tyler-IN added 2 commits February 22, 2020 17:38

make TransformComponent's Parent setter call Dirty() to handle replic…

98dab7d

…ating network state if AttachParent isn't invoked

Tyler-IN force-pushed the bubble branch from 9827f0a to 98dab7d Compare February 22, 2020 22:57

PJB3005 reviewed Feb 22, 2020

View reviewed changes

Tyler-IN added 3 commits February 22, 2020 20:24

fixed parent changed by setting Parent on Transform not updating pare…

2bb77ea

…nt's Children collection and other stuff rotating parent entities now are visible with their orbiting children if one of their children moves into view

break out duplicated code as GetLastSeen

2fc041e

remove unused net.parallelstates

728c3e1

introduce net.pvs to configure enabling/disabling PVS

Acruid approved these changes Feb 23, 2020

View reviewed changes

PJB3005 approved these changes Feb 23, 2020

View reviewed changes

PJB3005 merged commit 214f9f0 into space-wizards:master Feb 23, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement client bubble PVS. #983

Implement client bubble PVS. #983

Tyler-IN commented Feb 16, 2020 •

edited

Clyybber left a comment

Tyler-IN commented Feb 19, 2020

TYoung86 commented Feb 22, 2020

PJB3005 left a comment

PJB3005 Feb 22, 2020

Tyler-IN Feb 23, 2020

PJB3005 Feb 22, 2020

Tyler-IN Feb 23, 2020

PJB3005 Feb 22, 2020

Tyler-IN Feb 23, 2020

Tyler-IN Feb 23, 2020

PJB3005 Feb 22, 2020

Tyler-IN Feb 23, 2020

Tyler-IN Feb 23, 2020 •

edited

PJB3005 Feb 23, 2020

PJB3005 Feb 22, 2020

Tyler-IN Feb 23, 2020

Tyler-IN commented Feb 23, 2020

Acruid left a comment

Implement client bubble PVS. #983

Implement client bubble PVS. #983

Conversation

Tyler-IN commented Feb 16, 2020 • edited

Clyybber left a comment

Choose a reason for hiding this comment

Tyler-IN commented Feb 19, 2020

TYoung86 commented Feb 22, 2020

PJB3005 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tyler-IN Feb 23, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tyler-IN commented Feb 23, 2020

Acruid left a comment

Choose a reason for hiding this comment

Tyler-IN commented Feb 16, 2020 •

edited

Tyler-IN Feb 23, 2020 •

edited