// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved. #include "GameplayDebuggerPrivate.h" #include "Misc/CoreMisc.h" #include "GameplayDebuggingComponent.h" #include "GameplayDebuggingHUDComponent.h" #include "GameplayDebuggingReplicator.h" #include "GameplayDebuggingControllerComponent.h" #include "AISystem.h" #include "GameplayDebuggerSettings.h" #if WITH_EDITOR #include "Editor/EditorEngine.h" #include "ISettingsModule.h" #include "LevelEditor.h" #endif // WITH_EDITOR #define LOCTEXT_NAMESPACE "FGameplayDebugger" FGameplayDebuggerSettings GameplayDebuggerSettings(class AGameplayDebuggingReplicator* Replicator) { uint32 Settings = UGameplayDebuggerSettings::StaticClass()->GetDefaultObject()->GetSettings(); return FGameplayDebuggerSettings(Replicator == NULL ? Settings : Replicator->DebuggerShowFlags); } class FGameplayDebugger : public FSelfRegisteringExec, public IGameplayDebugger { public: // Begin IModuleInterface virtual void StartupModule() override; virtual void ShutdownModule() override; // End IModuleInterface void WorldAdded(UWorld* InWorld); void WorldDestroyed(UWorld* InWorld); #if WITH_EDITOR void OnLevelActorAdded(AActor* InActor); void OnLevelActorDeleted(AActor* InActor); TSharedRef OnExtendLevelEditorViewMenu(const TSharedRef CommandList); void CreateSnappingOptionsMenu(FMenuBuilder& Builder); void CreateSettingSubMenu(FMenuBuilder& Builder); void HandleSettingChanged(FName PropertyName); #endif TArray >& GetAllReplicators(UWorld* InWorld); void AddReplicator(UWorld* InWorld, AGameplayDebuggingReplicator* InReplicator); void RemoveReplicator(UWorld* InWorld, AGameplayDebuggingReplicator* InReplicator); // Begin FExec Interface virtual bool Exec(UWorld* Inworld, const TCHAR* Cmd, FOutputDevice& Ar) override; // End FExec Interface private: virtual bool CreateGameplayDebuggerForPlayerController(APlayerController* PlayerController) override; bool DoesGameplayDebuggingReplicatorExistForPlayerController(APlayerController* PlayerController); TMap, TArray > > AllReplilcatorsPerWorlds; #if WITH_EDITOR FLevelEditorModule::FLevelEditorMenuExtender ViewMenuExtender; #endif }; IMPLEMENT_MODULE(FGameplayDebugger, GameplayDebugger) // This code will execute after your module is loaded into memory (but after global variables are initialized, of course.) void FGameplayDebugger::StartupModule() { #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) if (GEngine) { GEngine->OnWorldAdded().AddRaw(this, &FGameplayDebugger::WorldAdded); GEngine->OnWorldDestroyed().AddRaw(this, &FGameplayDebugger::WorldDestroyed); #if WITH_EDITOR GEngine->OnLevelActorAdded().AddRaw(this, &FGameplayDebugger::OnLevelActorAdded); GEngine->OnLevelActorDeleted().AddRaw(this, &FGameplayDebugger::OnLevelActorDeleted); ISettingsModule* SettingsModule = FModuleManager::GetModulePtr("Settings"); if (SettingsModule != nullptr) { SettingsModule->RegisterSettings("Editor", "General", "GameplayDebugger", LOCTEXT("AIToolsSettingsName", "Gameplay Debugger"), LOCTEXT("AIToolsSettingsDescription", "General settings for UE4 AI Tools."), UGameplayDebuggerSettings::StaticClass()->GetDefaultObject() ); } UGameplayDebuggerSettings::StaticClass()->GetDefaultObject()->OnSettingChanged().AddRaw(this, &FGameplayDebugger::HandleSettingChanged); # if ADD_LEVEL_EDITOR_EXTENSIONS const bool bExtendViewportMenu = UGameplayDebuggerSettings::StaticClass()->GetDefaultObject()->bExtendViewportMenu; if (!IsRunningCommandlet() && bExtendViewportMenu) { // Register the extension with the level editor { ViewMenuExtender = FLevelEditorModule::FLevelEditorMenuExtender::CreateRaw(this, &FGameplayDebugger::OnExtendLevelEditorViewMenu); FLevelEditorModule* LevelEditor = FModuleManager::LoadModulePtr(TEXT("LevelEditor")); if (LevelEditor) { LevelEditor->GetAllLevelViewportOptionsMenuExtenders().Add(ViewMenuExtender); } } } # endif //ADD_LEVEL_EDITOR_EXTENSIONS #endif } #endif } #if WITH_EDITOR void FGameplayDebugger::HandleSettingChanged(FName PropertyName) { #if ADD_LEVEL_EDITOR_EXTENSIONS const bool bExtendViewportMenu = UGameplayDebuggerSettings::StaticClass()->GetDefaultObject()->bExtendViewportMenu; if (PropertyName == TEXT("bExtendViewportMenu")) { if (bExtendViewportMenu) { // Register the extension with the level editor { ViewMenuExtender = FLevelEditorModule::FLevelEditorMenuExtender::CreateRaw(this, &FGameplayDebugger::OnExtendLevelEditorViewMenu); FLevelEditorModule* LevelEditor = FModuleManager::LoadModulePtr(TEXT("LevelEditor")); if (LevelEditor) { LevelEditor->GetAllLevelViewportOptionsMenuExtenders().Add(ViewMenuExtender); } } } else { // Unregister the level editor extensions { FLevelEditorModule* LevelEditor = FModuleManager::LoadModulePtr(TEXT("LevelEditor")); if (LevelEditor) { LevelEditor->GetAllLevelViewportOptionsMenuExtenders().Remove(ViewMenuExtender); } } } } #endif } #endif // This function may be called during shutdown to clean up your module. For modules that support dynamic reloading, // we call this function before unloading the module. void FGameplayDebugger::ShutdownModule() { #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) if (GEngine) { GEngine->OnWorldAdded().RemoveAll(this); GEngine->OnWorldDestroyed().RemoveAll(this); #if WITH_EDITOR GEngine->OnLevelActorAdded().RemoveAll(this); GEngine->OnLevelActorDeleted().RemoveAll(this); UGameplayDebuggerSettings::StaticClass()->GetDefaultObject()->OnSettingChanged().RemoveAll(this); ISettingsModule* SettingsModule = FModuleManager::GetModulePtr("Settings"); if (SettingsModule != nullptr) { SettingsModule->UnregisterSettings("Editor", "General", "GameplayDebugger"); } # if ADD_LEVEL_EDITOR_EXTENSIONS if (UObjectInitialized() && !IsRunningCommandlet()) { // Unregister the level editor extensions { FLevelEditorModule* LevelEditor = FModuleManager::LoadModulePtr(TEXT("LevelEditor")); if (LevelEditor) { LevelEditor->GetAllLevelViewportOptionsMenuExtenders().Remove(ViewMenuExtender); } } } # endif //ADD_LEVEL_EDITOR_EXTENSIONS #endif } #endif } #if WITH_EDITOR void FGameplayDebugger::CreateSettingSubMenu(FMenuBuilder& Builder) { #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) Builder.AddMenuEntry( LOCTEXT("Test_GameplayDebugger_Menu", "Test Gameplay Debugger Option"), LOCTEXT("Test_GameplayDebugger_Menu_Tooltip", "If Enabled, actors will snap to the nearest location on the constraint plane (NOTE: Only works correctly in perspective views right now!)"), FSlateIcon(), FUIAction( FExecuteAction()/*FExecuteAction::CreateRaw(PlanarPolicy.Get(), &FPlanarConstraintSnapPolicy::ToggleEnabled)*/, FCanExecuteAction(), FIsActionChecked()/*FIsActionChecked::CreateRaw(PlanarPolicy.Get(), &FPlanarConstraintSnapPolicy::IsEnabled)*/ ), NAME_None, EUserInterfaceActionType::Button, NAME_None); #endif } void FGameplayDebugger::CreateSnappingOptionsMenu(FMenuBuilder& Builder) { #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) if (GCurrentLevelEditingViewportClient && GCurrentLevelEditingViewportClient->EngineShowFlags.DebugAI && GCurrentLevelEditingViewportClient->IsSimulateInEditorViewport()) { Builder.AddMenuSeparator(); Builder.AddSubMenu( LOCTEXT("Test_GameplayDebugger_Menu", "Gameplay Debugger"), LOCTEXT("Test_GameplayDebugger_Menu_Tooltip", "Quick setting for Gameplay Debugger tool in selected view"), FNewMenuDelegate::CreateRaw(this, &FGameplayDebugger::CreateSettingSubMenu) ); } #endif } TSharedRef FGameplayDebugger::OnExtendLevelEditorViewMenu(const TSharedRef CommandList) { #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) && WITH_EDITOR TSharedRef Extender(new FExtender()); if (GEditor && GEditor->bIsSimulatingInEditor) { Extender->AddMenuExtension( "LevelViewportLayouts", EExtensionHook::After, NULL, FMenuExtensionDelegate::CreateRaw(this, &FGameplayDebugger::CreateSnappingOptionsMenu)); } #endif return Extender; } #endif bool FGameplayDebugger::DoesGameplayDebuggingReplicatorExistForPlayerController(APlayerController* PlayerController) { #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) if (PlayerController == NULL) { return false; } UWorld* World = PlayerController->GetWorld(); if (World == NULL) { return false; } for (auto It = GetAllReplicators(World).CreateConstIterator(); It; ++It) { TWeakObjectPtr Replicator = *It; if (Replicator.IsValid()) { if (Replicator->GetLocalPlayerOwner() == PlayerController) { return true; } } } #endif return false; } bool FGameplayDebugger::CreateGameplayDebuggerForPlayerController(APlayerController* PlayerController) { #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) if (PlayerController == NULL) { return false; } bool bIsServer = PlayerController->GetNetMode() < ENetMode::NM_Client; // (Only create on some sort of server) if (!bIsServer) { return false; } UWorld* World = PlayerController->GetWorld(); if (World == NULL) { return false; } if (DoesGameplayDebuggingReplicatorExistForPlayerController(PlayerController)) { // No need to create one if we already have one. return false; } FActorSpawnParameters SpawnInfo; SpawnInfo.bNoCollisionFail = true; SpawnInfo.Name = *FString::Printf(TEXT("GameplayDebuggingReplicator_%s"), *PlayerController->GetName()); AGameplayDebuggingReplicator* DestActor = World->SpawnActor(SpawnInfo); if (DestActor != NULL) { DestActor->SetLocalPlayerOwner(PlayerController); DestActor->SetReplicates(true); DestActor->SetAsGlobalInWorld(false); #if WITH_EDITOR UEditorEngine* EEngine = Cast(GEngine); if (EEngine && EEngine->bIsSimulatingInEditor) { DestActor->CreateTool(); DestActor->EnableTool(); } #endif AddReplicator(World, DestActor); return true; } #endif return false; } TArray >& FGameplayDebugger::GetAllReplicators(UWorld* InWorld) { return AllReplilcatorsPerWorlds.FindOrAdd(InWorld); } void FGameplayDebugger::AddReplicator(UWorld* InWorld, AGameplayDebuggingReplicator* InReplicator) { GetAllReplicators(InWorld).Add(InReplicator); } void FGameplayDebugger::RemoveReplicator(UWorld* InWorld, AGameplayDebuggingReplicator* InReplicator) { GetAllReplicators(InWorld).RemoveSwap(InReplicator); } void FGameplayDebugger::WorldAdded(UWorld* InWorld) { bool bIsServer = InWorld && InWorld->GetNetMode() < ENetMode::NM_Client; // (Only server code) if (!bIsServer) { return; } if (InWorld == NULL || InWorld->IsPendingKill() || InWorld->IsGameWorld() == false) { return; } for (auto It = GetAllReplicators(InWorld).CreateConstIterator(); It; ++It) { TWeakObjectPtr Replicator = *It; if (Replicator.IsValid() && Replicator->IsGlobalInWorld()) { // Ok, we have global replicator on level return; } } // create global replicator on level FActorSpawnParameters SpawnInfo; SpawnInfo.bNoCollisionFail = true; SpawnInfo.Name = *FString::Printf(TEXT("GameplayDebuggingReplicator_Global")); AGameplayDebuggingReplicator* DestActor = InWorld->SpawnActor(SpawnInfo); if (DestActor != NULL) { DestActor->SetLocalPlayerOwner(NULL); DestActor->SetReplicates(false); DestActor->SetActorTickEnabled(true); DestActor->SetAsGlobalInWorld(true); AddReplicator(InWorld, DestActor); } } void FGameplayDebugger::WorldDestroyed(UWorld* InWorld) { bool bIsServer = InWorld && InWorld->GetNetMode() < ENetMode::NM_Client; // (Only work on server) if (!bIsServer) { return; } // remove global replicator from level AllReplilcatorsPerWorlds.Remove(InWorld); } #if WITH_EDITOR void FGameplayDebugger::OnLevelActorAdded(AActor* InActor) { // This function doesn't help much, because it's only called in EDITOR! // We need a function that is called in the game! So instead of creating it automatically, I'm leaving it // to be created explicitly by any player controller that needs to create it. #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) APlayerController* PC = Cast(InActor); if (PC && PC->GetNetMode() < ENetMode::NM_Client) { CreateGameplayDebuggerForPlayerController(PC); } #endif } void FGameplayDebugger::OnLevelActorDeleted(AActor* InActor) { #if !(UE_BUILD_SHIPPING || UE_BUILD_TEST) APlayerController* PC = Cast(InActor); if (!PC) { return; } UWorld* World = PC->GetWorld(); if (!World) { return; } for (auto It = GetAllReplicators(World).CreateConstIterator(); It; ++It) { TWeakObjectPtr Replicator = *It; if (Replicator != NULL) { if (Replicator->GetLocalPlayerOwner() == PC) { RemoveReplicator(World, Replicator.Get()); World->DestroyActor(Replicator.Get()); } } } #endif } #endif //WITH_EDITOR bool FGameplayDebugger::Exec(UWorld* Inworld, const TCHAR* Cmd, FOutputDevice& Ar) { bool bHandled = false; APlayerController* PC = Inworld ? Inworld->GetFirstPlayerController() : NULL; if (!Inworld || !PC) { return bHandled; } if (FParse::Command(&Cmd, TEXT("EnableGDT"))) { AGameplayDebuggingReplicator* Replicator = NULL; for (TActorIterator It(Inworld); It; ++It) { Replicator = *It; if (Replicator && !Replicator->IsPendingKill()) { APlayerController* LocalPC = Replicator->GetLocalPlayerOwner(); if (LocalPC == PC) { break; } } Replicator = NULL; } if (Inworld->GetNetMode() == NM_Client) { if (!Replicator) { PC->ConsoleCommand("cheat EnableGDT"); bHandled = true; } else if (!Replicator->IsToolCreated()) { Replicator->CreateTool(); Replicator->EnableTool(); bHandled = true; } } else if (Inworld->GetNetMode() < NM_Client) { if (!Replicator) { CreateGameplayDebuggerForPlayerController(PC); for (TActorIterator It(Inworld); It; ++It) { Replicator = *It; if (Replicator && !Replicator->IsPendingKill()) { APlayerController* LocalPC = Replicator->GetLocalPlayerOwner(); if (LocalPC == PC) { break; } } Replicator = NULL; } } if (Inworld->GetNetMode() != NM_DedicatedServer) { if (Replicator && !Replicator->IsToolCreated()) { Replicator->CreateTool(); Replicator->EnableTool(); bHandled = true; } } else { if (Replicator) { Replicator->bAutoActivate = true;; bHandled = true; } } } } else if (FParse::Command(&Cmd, TEXT("RunEQS"))) { bHandled = true; APlayerController* MyPC = Inworld->GetFirstPlayerController(); UAISystem* AISys = UAISystem::GetCurrent(*Inworld); UEnvQueryManager* EQS = AISys ? AISys->GetEnvironmentQueryManager() : NULL; if (MyPC && EQS) { AGameplayDebuggingReplicator* DebuggingReplicator = NULL; for (TActorIterator It(Inworld); It; ++It) { AGameplayDebuggingReplicator* A = *It; if (!A->IsPendingKill()) { DebuggingReplicator = A; if (!DebuggingReplicator->IsGlobalInWorld() && DebuggingReplicator->GetLocalPlayerOwner() == MyPC) { break; } } } UObject* Target = DebuggingReplicator != NULL ? DebuggingReplicator->GetSelectedActorToDebug() : NULL; FString QueryName = FParse::Token(Cmd, 0); if (Target) { AISys->RunEQS(QueryName, Target); } else { MyPC->ClientMessage(TEXT("No debugging target to run EQS")); } } } return bHandled; } #undef LOCTEXT_NAMESPACE