charleslemaux/Mirror
1
0
Fork 0
mirror of https://github.com/MirrorNetworking/Mirror.git synced 2024-11-18 02:50:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Code cleanup

Browse Source
This commit is contained in:
Robin Rolf 2024-01-30 03:21:51 +01:00
parent ae9ecf3483
commit a14d094bc5
1 changed files with 36 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
Assets/Mirror/Components/InterestManagement/SpatialHashing/FastSpatialInterestManagement.cs
View File

@ -6,6 +6,10 @@
public class FastSpatialInterestManagement : InterestManagementBase public class FastSpatialInterestManagement : InterestManagementBase
{ {
Vector2Int InvalidPosition => new Vector2Int(int.MaxValue,
int.MaxValue);
[Tooltip("The maximum range that objects will be visible at.")] [Tooltip("The maximum range that objects will be visible at.")]
public int visRange = 30; public int visRange = 30;
@ -32,6 +36,7 @@ class Tracked
public NetworkIdentity Identity; public NetworkIdentity Identity;
public Visibility PreviousVisibility; public Visibility PreviousVisibility;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public Vector2Int GridPosition(int tileSize) public Vector2Int GridPosition(int tileSize)
{ {
Vector3 transformPos = Transform.position; Vector3 transformPos = Transform.position;
@ -60,7 +65,7 @@ internal void LateUpdate()
RebuildAll(); RebuildAll();
} }
// When a new entity is spawned // When a new identity is spawned
public override void OnSpawned(NetworkIdentity identity) public override void OnSpawned(NetworkIdentity identity)
{ {
// host visibility shim to make sure unseen entities are hidden, we initialize actual visibility later // host visibility shim to make sure unseen entities are hidden, we initialize actual visibility later
@ -92,10 +97,8 @@ public override void OnSpawned(NetworkIdentity identity)
); );
} }
Vector2Int InvalidPosition => new Vector2Int(int.MaxValue,
int.MaxValue);
// when an entity is despawned/destroyed // when an identity is despawned/destroyed
public override void OnDestroyed(NetworkIdentity identity) public override void OnDestroyed(NetworkIdentity identity)
{ {
// (limitation: we never expect identity.visibile to change) // (limitation: we never expect identity.visibile to change)
@ -116,39 +119,38 @@ private void RebuildAll()
// loop over all identities and check if their positions changed // loop over all identities and check if their positions changed
foreach (Tracked tracked in trackedIdentities.Values) foreach (Tracked tracked in trackedIdentities.Values)
{ {
// calculate the current grid position Vector2Int currentPosition = tracked.GridPosition(TileSize);
Vector3 transformPos = tracked.Transform.position;
Vector2Int currentPosition = Vector2Int.RoundToInt(new Vector2(transformPos.x, transformPos.z) / TileSize);
bool visibilityChanged = tracked.Identity.visibility != tracked.PreviousVisibility; bool visibilityChanged = tracked.Identity.visibility != tracked.PreviousVisibility;
// Visibility change to default is done before we run the normal grid update, since
// Visibility change *to* default needs to be handled before the normal grid update
// since observers are manipulated in RebuildAdd/RebuildRemove if visibility == Default
if (visibilityChanged && tracked.Identity.visibility == Visibility.Default) if (visibilityChanged && tracked.Identity.visibility == Visibility.Default)
{ {
if (tracked.PreviousVisibility == Visibility.ForceHidden) switch (tracked.PreviousVisibility)
{ {
case Visibility.ForceHidden:
// Hidden To Default // Hidden To Default
AddObserversHiddenToDefault(tracked.Identity, tracked.Position); AddObserversHiddenToDefault(tracked.Identity, tracked.Position);
} break;
else case Visibility.ForceShown:
{
// Shown To Default // Shown To Default
RemoveObserversShownToDefault(tracked.Identity, tracked.Position); RemoveObserversShownToDefault(tracked.Identity, tracked.Position);
break;
case Visibility.Default:
default:
throw new ArgumentOutOfRangeException();
} }
} }
// if the position changed, move entity about // if the position changed, move the identity in the grid and update observers accordingly
if (currentPosition != tracked.Position) if (currentPosition != tracked.Position)
{ {
Vector2Int oldPosition = tracked.Position; Vector2Int oldPosition = tracked.Position;
tracked.Position = currentPosition; tracked.Position = currentPosition;
// First: Remove from old grid position, but only if it was ever in the grid to begin with // First remove from old grid position
RebuildRemove(tracked.Identity, oldPosition, currentPosition); RebuildRemove(tracked.Identity, oldPosition, currentPosition);
// Then add to new grid position
// Then add to new grid tile RebuildAdd(tracked.Identity, oldPosition, currentPosition, false);
RebuildAdd(
tracked.Identity,
oldPosition,
currentPosition,
false
);
} }
// after updating the grid, if the visibility has changed // after updating the grid, if the visibility has changed
@ -156,15 +158,14 @@ private void RebuildAll()
{ {
switch (tracked.Identity.visibility) switch (tracked.Identity.visibility)
{ {
case Visibility.Default:
// handled above
break;
case Visibility.ForceHidden: case Visibility.ForceHidden:
ClearObservers(tracked.Identity); ClearObservers(tracked.Identity);
break; break;
case Visibility.ForceShown: case Visibility.ForceShown:
AddObserversAllReady(tracked.Identity); AddObserversAllReady(tracked.Identity);
break; break;
case Visibility.Default:
break;
default: default:
throw new ArgumentOutOfRangeException(); throw new ArgumentOutOfRangeException();
} }
@ -179,10 +180,10 @@ private void RebuildRemove(NetworkIdentity changedIdentity, Vector2Int oldPositi
// sanity check // sanity check
if (!grid[oldPosition].Remove(changedIdentity)) if (!grid[oldPosition].Remove(changedIdentity))
{ {
throw new InvalidOperationException("entity was not in the provided grid"); throw new InvalidOperationException("changedIdentity was not in the provided grid");
} }
// for all tiles the entity could see at the old position // for all tiles the changedIdentity could see at the old position
for (int x = -1; x <= 1; x++) for (int x = -1; x <= 1; x++)
{ {
for (int y = -1; y <= 1; y++) for (int y = -1; y <= 1; y++)
@ -200,7 +201,6 @@ private void RebuildRemove(NetworkIdentity changedIdentity, Vector2Int oldPositi
continue; continue;
} }
// update observers for all identites the entity could see and all players that could see it
foreach (NetworkIdentity gridIdentity in tile) foreach (NetworkIdentity gridIdentity in tile)
{ {
if (gridIdentity == changedIdentity) if (gridIdentity == changedIdentity)
@ -230,7 +230,7 @@ private void RebuildRemove(NetworkIdentity changedIdentity, Vector2Int oldPositi
private void RebuildAdd(NetworkIdentity changedIdentity, Vector2Int oldPosition, Vector2Int newPosition, private void RebuildAdd(NetworkIdentity changedIdentity, Vector2Int oldPosition, Vector2Int newPosition,
bool initialize) bool initialize)
{ {
// for all tiles the entity now sees at the new position // for all tiles the changedIdentity now sees at the new position
for (int x = -1; x <= 1; x++) for (int x = -1; x <= 1; x++)
{ {
for (int y = -1; y <= 1; y++) for (int y = -1; y <= 1; y++)
@ -282,14 +282,14 @@ private void RebuildAdd(NetworkIdentity changedIdentity, Vector2Int oldPosition,
if (!addTile.Add(changedIdentity)) if (!addTile.Add(changedIdentity))
{ {
throw new InvalidOperationException("entity was already in the grid"); throw new InvalidOperationException("identity was already in the grid");
} }
} }
/// Adds observers to the NI, but not the other way around. This is used when a NI changes from ForceHidden to Default /// Adds observers to the NI, but not the other way around. This is used when a NI changes from ForceHidden to Default
private void AddObserversHiddenToDefault(NetworkIdentity changed, Vector2Int gridPosition) private void AddObserversHiddenToDefault(NetworkIdentity changed, Vector2Int gridPosition)
{ {
// for all tiles the entity now sees at the new position // for all tiles around the changedIdentity
for (int x = -1; x <= 1; x++) for (int x = -1; x <= 1; x++)
{ {
for (int y = -1; y <= 1; y++) for (int y = -1; y <= 1; y++)
@ -331,8 +331,7 @@ private void RemoveObserversShownToDefault(NetworkIdentity changedIdentity, Vect
tempShownToDefaultSet.Add(observer); tempShownToDefaultSet.Add(observer);
} }
// for all tiles the entity now sees at the current position // for all tiles around the changedIdentity, remove any connections that can still see it
// remove any connections that can still see the changedIdentity
for (int x = -1; x <= 1; x++) for (int x = -1; x <= 1; x++)
{ {
for (int y = -1; y <= 1; y++) for (int y = -1; y <= 1; y++)