Changed relevancy system to use PlayerId instead of UniqueNetId

- This has been made to make the culling and relevancy work in local splitscreen multiplayer game

Author: BenPyton

Source/ProceduralDungeon/Private/DungeonGeneratorBase.cpp

@@ -9,6 +9,9 @@
 #include "Engine/Engine.h" // GEngine
 #include "GameFramework/Pawn.h"
 #include "GameFramework/PlayerState.h"
+#include "GameFramework/PlayerController.h"
+#include "Engine/LocalPLayer.h"
+#include "Engine/GameInstance.h"
 #include "NavigationSystem.h"
 #include "RoomData.h"
 #include "Room.h"
@@ -442,8 +445,8 @@ void ADungeonGeneratorBase::UpdatePlayerRooms()
 continue;
 
 // Using their UniqueID to be reliable even when players join or leave
-const FUniqueNetIdRepl& UniqueID = Controller->PlayerState->GetUniqueId();
-if (!UniqueID.IsValid())
+int32 PlayerID = Controller->PlayerState->GetPlayerId();
+if (PlayerID <= 0)
 continue;
 
 APawn* Player = GetVisibilityPawn(Controller);
@@ -453,17 +456,17 @@ void ADungeonGeneratorBase::UpdatePlayerRooms()
 const FTransform& Transform = UseGeneratorTransform() ? GetTransform() : FTransform::Identity;
 FBox WorldPlayerBox = ActorUtils::GetActorBoundingBoxForRooms(Player, Transform);
 
-FPlayerRooms& PlayerRoom = PlayerRooms.FindOrAdd(UniqueID);
+FPlayerRooms& PlayerRoom = PlayerRooms.FindOrAdd(PlayerID);
 auto PreviousRoomList(PlayerRoom.CurrentRooms);
 PlayerRoom.Roll();
-FindElementsWithBoundsTest(*Octree, WorldPlayerBox, [this, &PlayerRoom, & UniqueID](const FDungeonOctreeElement& Element) {
+FindElementsWithBoundsTest(*Octree, WorldPlayerBox, [this, &PlayerRoom, &PlayerID](const FDungeonOctreeElement& Element) {
 PlayerRoom.AddCurrentRoom(Element.Room);
-Element.Room->SetPlayerInside(UniqueID, true);
+Element.Room->SetPlayerInside(PlayerID, true);
 });
 
 for (URoom* Room : PlayerRoom.OldRooms)
 {
-Room->SetPlayerInside(UniqueID, false);
+Room->SetPlayerInside(PlayerID, false);
 }
 
 // Both sets are equal if each set is included in the other
@@ -475,14 +478,6 @@ void ADungeonGeneratorBase::UpdatePlayerRooms()
 
 void ADungeonGeneratorBase::UpdateRoomVisibility()
 {
-// Get local player controller
-// @TODO: Extend to support splitscreen / multiple local players?
-FUniqueNetIdRepl UniqueID = ActorUtils::GetPlayerUniqueId(GetWorld(), 0);
-
-FPlayerRooms* PlayerRoom = PlayerRooms.Find(UniqueID);
-if (!PlayerRoom)
-return;
-
 const bool bIsOcclusionEnabled = Dungeon::OcclusionCulling();
 const uint32 OcclusionDistance = Dungeon::OcclusionDistance();
 bool bForceUpdate = false;
@@ -504,13 +499,37 @@ void ADungeonGeneratorBase::UpdateRoomVisibility()
 if (!bIsOcclusionEnabled)
 return;
 
+TSet<URoom*> OldRooms;
+TSet<URoom*> CurrentRooms;
+bool bHasChanged = false;
+
+UGameInstance* GameInstance = GetWorld()->GetGameInstance();
+for (const ULocalPlayer* LocalPlayer : GameInstance->GetLocalPlayers())
+{
+APlayerController* Controller = LocalPlayer->PlayerController;
+if (!IsValid(Controller))
+continue;
+
+APlayerState* State = Controller->PlayerState;
+if (!IsValid(State))
+continue;
+
+FPlayerRooms* PlayerRoom = PlayerRooms.Find(State->GetPlayerId());
+if (!PlayerRoom)
+continue;
+
+OldRooms.Append(PlayerRoom->OldRooms);
+CurrentRooms.Append(PlayerRoom->CurrentRooms);
+bHasChanged |= PlayerRoom->bHasChanged;
+}
+
 // Save performance by not updating room visibilities if the player rooms haven't changed.
-if (!(bForceUpdate || PlayerRoom->bHasChanged))
+if (!(bForceUpdate || bHasChanged))
 return;
 
 TSet<URoom*> VisibleRooms;
-UDungeonGraph::TraverseRooms(PlayerRoom->CurrentRooms, &VisibleRooms, OcclusionDistance, [](URoom* room, uint32 distance) { room->SetVisible(true); });
-UDungeonGraph::TraverseRooms(PlayerRoom->OldRooms, nullptr, OcclusionDistance, [&VisibleRooms](URoom* room, uint32 distance) { room->SetVisible(VisibleRooms.Contains(room)); });
+UDungeonGraph::TraverseRooms(CurrentRooms, &VisibleRooms, OcclusionDistance, [](URoom* room, uint32 distance) { room->SetVisible(true); });
+UDungeonGraph::TraverseRooms(OldRooms, nullptr, OcclusionDistance, [&VisibleRooms](URoom* room, uint32 distance) { room->SetVisible(VisibleRooms.Contains(room)); });
 }
 
 void ADungeonGeneratorBase::UpdateRoomRelevancy()

Source/ProceduralDungeon/Private/ProceduralDungeonUtils.cpp

@@ -270,36 +270,21 @@ FBox ActorUtils::GetActorBoundingBoxForRooms(AActor* Actor, const FTransform& Du
 return ActorBox;
 }
 
-FUniqueNetIdRepl ActorUtils::GetPlayerUniqueId(const UObject* WorldContextObject, int32 PlayerIndex)
+APlayerController* ActorUtils::GetPlayerControllerFromPlayerId(const UObject* WorldContextObject, int32 PlayerId)
 {
-APlayerController* Controller = UGameplayStatics::GetPlayerController(WorldContextObject, PlayerIndex);
-if (!IsValid(Controller) || !IsValid(Controller->PlayerState))
-return FUniqueNetIdRepl::Invalid();
-
-return Controller->PlayerState->GetUniqueId();
-}
-
-int32 ActorUtils::GetPlayerIndex(const UObject* WorldContextObject, const FUniqueNetIdRepl& PlayerUniqueId)
-{
-for (int32 Index = 0;; ++Index)
-{
-APlayerController* Controller = UGameplayStatics::GetPlayerController(WorldContextObject, Index);
-if (!IsValid(Controller))
-break;
+UWorld* World = WorldContextObject->GetWorld();
+if (!IsValid(World))
+return nullptr;
 
-if (!IsValid(Controller->PlayerState))
-continue;
+AGameStateBase* GameState = World->GetGameState();
+if (!IsValid(GameState))
+return nullptr;
 
-FUniqueNetIdRepl UniqueId = Controller->PlayerState->GetUniqueId();
-if (UniqueId == PlayerUniqueId)
-return Index;
-}
-return -1;
-}
+const auto* StatePtr = GameState->PlayerArray.FindByPredicate([PlayerId](const APlayerState* State) { return State->GetPlayerId() == PlayerId; });
+if (StatePtr == nullptr)
+return nullptr;
 
-APlayerController* ActorUtils::GetPlayerControllerFromUniqueId(const UObject* WorldContextObject, const FUniqueNetIdRepl& PlayerUniqueId)
-{
-APlayerState* State = UGameplayStatics::GetPlayerStateFromUniqueNetId(WorldContextObject, PlayerUniqueId);
+const APlayerState* State = *StatePtr;
 if (!IsValid(State))
 return nullptr;
 return State->GetPlayerController();

Source/ProceduralDungeon/Private/Room.cpp

@@ -236,7 +236,7 @@ int32 URoom::GetRelevancyLevel(APlayerController* PlayerController) const
 if (!IsValid(PlayerController->PlayerState))
 return -1;
 
-const int32* Level = RelevancyLevels.Find(PlayerController->PlayerState->GetUniqueId());
+const int32* Level = RelevancyLevels.Find(PlayerController->PlayerState->GetPlayerId());
 return (Level != nullptr) ? *Level : -1;
 }
 
@@ -267,7 +267,7 @@ void URoom::GetAllRelevancyLevels(TMap<APlayerController*, int32>& OutRelevancyL
 OutRelevancyLevels.Empty();
 for (const auto& Pair : RelevancyLevels)
 {
-APlayerController* Controller = ActorUtils::GetPlayerControllerFromUniqueId(this, Pair.Key);
+APlayerController* Controller = ActorUtils::GetPlayerControllerFromPlayerId(this, Pair.Key);
 if (IsValid(Controller))
 OutRelevancyLevels.Add(Controller, Pair.Value);
 }
@@ -559,7 +559,7 @@ void URoom::SetVisible(bool Visible, bool bForceUpdate)
 UpdateVisibility();
 }
 
-void URoom::SetRelevancyLevel(FUniqueNetIdRepl PlayerID, int32 Level)
+void URoom::SetRelevancyLevel(int32 PlayerID, int32 Level)
 {
 int32* FoundLevel = RelevancyLevels.Find(PlayerID);
 if (Level < 0)
@@ -574,12 +574,12 @@ void URoom::SetRelevancyLevel(FUniqueNetIdRepl PlayerID, int32 Level)
 return;
 RelevancyLevels.Add(PlayerID, Level);
 }
-APlayerController* Controller = ActorUtils::GetPlayerControllerFromUniqueId(GetWorld(), PlayerID);
-DungeonLog_Debug("Found player controller for id '%s': %s", *PlayerID.ToString(), *GetNameSafe(Controller));
+APlayerController* Controller = ActorUtils::GetPlayerControllerFromPlayerId(GetWorld(), PlayerID);
+DungeonLog_Debug("Found player controller for id %d: %s", PlayerID, *GetNameSafe(Controller));
 OnRelevancyChanged.Broadcast(this, Controller, Level);
 }
 
-void URoom::SetPlayerInside(const FUniqueNetIdRepl& PlayerID, bool PlayerInside)
+void URoom::SetPlayerInside(int32 PlayerID, bool PlayerInside)
 {
 if (PlayerIDInside.Contains(PlayerID) != PlayerInside)
 return;
@@ -590,9 +590,11 @@ void URoom::SetPlayerInside(const FUniqueNetIdRepl& PlayerID, bool PlayerInside)
 PlayerIDInside.Remove(PlayerID);
 }
 
-bool URoom::IsPlayerInside(int PlayerID) const
+bool URoom::IsPlayerInside(const APlayerController* PlayerController) const
 {
-FUniqueNetIdRepl UniqueID = ActorUtils::GetPlayerUniqueId(GetWorld(), PlayerID);
+if (!IsValid(PlayerController) || !IsValid(PlayerController->PlayerState))
+return !PlayerIDInside.IsEmpty();
+int32 UniqueID = PlayerController->PlayerState->GetPlayerId();
 return PlayerIDInside.Contains(UniqueID);
 }
 

Source/ProceduralDungeon/Private/RoomLevel.cpp

@@ -177,9 +177,9 @@ void ARoomLevel::Tick(float DeltaTime)
 #endif // ENABLE_DRAW_DEBUG
 }
 
-bool ARoomLevel::IsPlayerInside()
+bool ARoomLevel::IsPlayerInside(const APlayerController* PlayerController)
 {
-return IsValid(Room) ? Room->IsPlayerInside() : false;
+return IsValid(Room) ? Room->IsPlayerInside(PlayerController) : false;
 }
 
 bool ARoomLevel::IsVisible()

Source/ProceduralDungeon/Public/DungeonGeneratorBase.h

@@ -416,7 +416,7 @@ class PROCEDURALDUNGEON_API ADungeonGeneratorBase : public AActor
 
 // Occlusion culling system
 TUniquePtr<FDungeonOctree> Octree;
-TMap<FUniqueNetIdRepl, FPlayerRooms> PlayerRooms;
+TMap<int32, FPlayerRooms> PlayerRooms;
 
 // Transient. Only used to detect when occlusion setting is changed.
 bool bWasOcclusionEnabled {false};

Source/ProceduralDungeon/Public/ProceduralDungeonUtils.h

@@ -158,12 +158,6 @@ namespace ActorUtils
 // Returns the bounding box of an actor considering only components that would interact with rooms (based on collision settings).
 FBox PROCEDURALDUNGEON_API GetActorBoundingBoxForRooms(AActor* Actor, const FTransform& DungeonTransform = FTransform::Identity);
 
-// Returns the unique id associated with the player index.
-FUniqueNetIdRepl PROCEDURALDUNGEON_API GetPlayerUniqueId(const UObject* WorldContextObject, int32 PlayerIndex);
-
-// Returns the index of the player with unique Id.
-int32 PROCEDURALDUNGEON_API GetPlayerIndex(const UObject* WorldContextObject, const FUniqueNetIdRepl& PlayerUniqueId);
-
-// Returns the controller of the player with unique Id.
-class APlayerController* GetPlayerControllerFromUniqueId(const UObject* WorldContextObject, const FUniqueNetIdRepl& PlayerUniqueId);
+// Returns the player controller associated with the player state id.
+class APlayerController* GetPlayerControllerFromPlayerId(const UObject* WorldContextObject, int32 PlayerId);
 }

Source/ProceduralDungeon/Public/Room.h

@@ -78,16 +78,16 @@ class PROCEDURALDUNGEON_API URoom : public UReplicableObject, public IReadOnlyRo
 //~ End IDungeonSaveInterface Interface
 
 const ADungeonGeneratorBase* Generator() const { return GeneratorOwner.Get(); }
-void SetPlayerInside(const FUniqueNetIdRepl& PlayerID, bool PlayerInside);
+void SetPlayerInside(int32 PlayerID, bool PlayerInside);
 void SetVisible(bool Visible, bool bForceUpdate = false);
-void SetRelevancyLevel(FUniqueNetIdRepl PlayerID, int32 Level);
+void SetRelevancyLevel(int32 PlayerID, int32 Level);
 FORCEINLINE bool IsReady() const { return RoomData != nullptr; }
 
 // Is the player currently inside the room?
 // A player can be in multiple rooms at once, for example when he stands at the door frame,
 // the player's capsule is in both rooms.
 UFUNCTION(BlueprintPure, Category = "Room")
-FORCEINLINE bool IsPlayerInside(int PlayerID = 0) const;
+FORCEINLINE bool IsPlayerInside(const APlayerController* PlayerController = nullptr) const;
 
 // Is the room currently visible?
 UFUNCTION(BlueprintPure, Category = "Room", meta = (CompactNodeTitle = "Is Visible"))
@@ -217,10 +217,10 @@ class PROCEDURALDUNGEON_API URoom : public UReplicableObject, public IReadOnlyRo
 UPROPERTY(ReplicatedUsing = OnRep_Id, SaveGame)
 int64 Id {-1};
 
-TSet<FUniqueNetIdRepl> PlayerIDInside {};
+TSet<int32> PlayerIDInside {};
 bool bIsVisible {true};
 bool bForceVisible {false};
-TMap<FUniqueNetIdRepl, int32> RelevancyLevels {};
+TMap<int32, int32> RelevancyLevels {};
 
 UPROPERTY(ReplicatedUsing = OnRep_IsLocked, SaveGame)
 bool bIsLocked {false};

Source/ProceduralDungeon/Public/RoomLevel.h

@@ -56,7 +56,7 @@ class PROCEDURALDUNGEON_API ARoomLevel : public ALevelScriptActor
 FORCEINLINE bool IsInit() const { return bIsInit; }
 
 UFUNCTION(BlueprintPure, Category = "Procedural Dungeon", meta = (CompactNodeTitle = "Is Player Inside", DeprecatedFunction, DeprecationMessage = "Use GetRoom() instead to access directly the room functions."))
-bool IsPlayerInside();
+bool IsPlayerInside(const APlayerController* PlayerController = nullptr);
 
 UFUNCTION(BlueprintPure, Category = "Procedural Dungeon", meta = (CompactNodeTitle = "Is Visible", DeprecatedFunction, DeprecationMessage = "Use GetRoom() instead to access directly the room functions."))
 bool IsVisible();