Files
UnrealEngineUWP/Engine/Source/Editor/ProjectSettingsViewer/Private/ProjectSettingsViewerModule.cpp
Max Preussner ce01264d12 Settings: All projects settings are now saved in the Default.ini
Up until this change, project settings caused a lot of confusion amongst users, because they were changed to the user's local INI files. The local INI files, however, would be ignored when packaging a project, which means that local setting changes would not be applied to a packaged project and cause unexpected behavior. With this change the project settings will always save to the default INI file and will therefore be included in packaged projects. We will see how this works out for everyone, and we may change this behavior to something else if we can come up with a better, more intuitive workflow for project settings.

Upgrade Notes:
- If you have changes for Project Settings in your local INI files, you may want to 'Set as Default' in the Editor and then delete the local INI
- The default INI files (i.e. DefaultEngine.ini) of your project need to be writable. If you use source control, make sure you check out the corresponding files before changing project settings

[CL 2066019 by Max Preussner in Main branch]
2014-05-07 16:21:14 -04:00

278 lines
9.0 KiB
C++

// Copyright 1998-2014 Epic Games, Inc. All Rights Reserved.
/*=============================================================================
ProjectSettingsViewerModule.cpp: Implements the FProjectSettingsViewerModule class.
=============================================================================*/
#include "ProjectSettingsViewerPrivatePCH.h"
#define LOCTEXT_NAMESPACE "FProjectSettingsViewerModule"
static const FName ProjectSettingsTabName("ProjectSettings");
/**
* Implements the ProjectSettingsViewer module.
*/
class FProjectSettingsViewerModule
: public IModuleInterface
, public ISettingsViewer
{
public:
// Begin ISettingsViewer interface
virtual void ShowSettings( const FName& CategoryName, const FName& SectionName ) OVERRIDE
{
FGlobalTabmanager::Get()->InvokeTab(ProjectSettingsTabName);
ISettingsEditorModelPtr SettingsEditorModel = SettingsEditorModelPtr.Pin();
if (SettingsEditorModel.IsValid())
{
ISettingsCategoryPtr Category = SettingsEditorModel->GetSettingsContainer()->GetCategory(CategoryName);
if (Category.IsValid())
{
SettingsEditorModel->SelectSection(Category->GetSection(SectionName));
}
}
}
// End ISettingsViewer interface
public:
// Begin IModuleInterface interface
virtual void StartupModule( ) OVERRIDE
{
ISettingsModule* SettingsModule = ISettingsModule::Get();
if (SettingsModule != nullptr)
{
RegisterEngineSettings(*SettingsModule);
RegisterGameSettings(*SettingsModule);
SettingsModule->RegisterViewer("Project", *this);
}
FGlobalTabmanager::Get()->RegisterNomadTabSpawner(ProjectSettingsTabName, FOnSpawnTab::CreateRaw(this, &FProjectSettingsViewerModule::HandleSpawnSettingsTab))
.SetDisplayName(LOCTEXT("ProjectSettingsTabTitle", "Project Settings"))
.SetMenuType(ETabSpawnerMenuType::Hide);
}
virtual void ShutdownModule( ) OVERRIDE
{
FGlobalTabmanager::Get()->UnregisterNomadTabSpawner(ProjectSettingsTabName);
UnregisterSettings();
}
virtual bool SupportsDynamicReloading( ) OVERRIDE
{
return true;
}
// End IModuleInterface interface
protected:
/**
* Registers Engine settings.
*/
void RegisterEngineSettings( ISettingsModule& SettingsModule )
{
// startup settings
SettingsModule.RegisterSettings("Project", "Engine", "General",
LOCTEXT("GeneralEngineSettingsName", "General Settings"),
LOCTEXT("ProjectGeneralSettingsDescription", "General options and defaults for the game engine."),
GetMutableDefault<UEngine>()
);
// Audio settings
SettingsModule.RegisterSettings("Project", "Engine", "Audio",
LOCTEXT("EngineAudioSettingsName", "Audio"),
LOCTEXT("ProjectAudioSettingsDescription", "Audio settings."),
GetMutableDefault<UAudioSettings>()
);
// packaging settings
SettingsModule.RegisterSettings("Project", "Engine", "Collision",
LOCTEXT("ProjectCollisionSettingsName", "Collision"),
LOCTEXT("ProjectCollisionSettingsDescription", "Set up and modify collision settings."),
GetMutableDefault<UCollisionProfile>()
);
// game console settings
SettingsModule.RegisterSettings("Project", "Engine", "Console",
LOCTEXT("ProjectConsoleSettingsName", "Console"),
LOCTEXT("ProjectConsoleSettingsDescription", "Configure the in-game input console."),
GetMutableDefault<UConsole>()
);
// Input settings
SettingsModule.RegisterSettings("Project", "Engine", "Input",
LOCTEXT("EngineInputSettingsName", "Input"),
LOCTEXT("ProjectInputSettingsDescription", "Input settings, including default input action and axis bindings."),
GetMutableDefault<UInputSettings>()
);
// navigation system
SettingsModule.RegisterSettings("Project", "Engine", "NavigationSystem",
LOCTEXT("NavigationSystemSettingsName", "Navigation System"),
LOCTEXT("NavigationSystemSettingsDescription", "Settings for the navigation system."),
GetMutableDefault<UNavigationSystem>()
);
// navigation mesh
SettingsModule.RegisterSettings("Project", "Engine", "NavigationMesh",
LOCTEXT("NavigationMeshSettingsName", "Navigation Mesh"),
LOCTEXT("NavigationMeshSettingsDescription", "Settings for the navigation mesh."),
GetMutableDefault<ARecastNavMesh>()
);
/*
// network settings
SettingsModule.RegisterSettings("Project", "Engine", "NetworkManager",
LOCTEXT("GameNetworkManagerSettingsName", "Network Manager"),
LOCTEXT("GameNetworkManagerSettingsDescription", "Game Network Manager settings."),
GetMutableDefault<UGameNetworkManagerSettings>()
);*/
// Physics settings
SettingsModule.RegisterSettings("Project", "Engine", "Physics",
LOCTEXT("EnginePhysicsSettingsName", "Physics"),
LOCTEXT("ProjectPhysicsSettingsDescription", "Default physics settings."),
GetMutableDefault<UPhysicsSettings>()
);
// Rendering settings
SettingsModule.RegisterSettings("Project", "Engine", "Rendering",
LOCTEXT("EngineRenderingSettingsName", "Rendering"),
LOCTEXT("ProjectRenderingSettingsDescription", "Rendering settings."),
GetMutableDefault<URendererSettings>()
);
}
/**
* Registers Game settings.
*/
void RegisterGameSettings( ISettingsModule& SettingsModule )
{
// general project settings
SettingsModule.RegisterSettings("Project", "Game", "General",
LOCTEXT("GeneralGameSettingsName", "Description"),
LOCTEXT("GeneralGameSettingsDescription", "Descriptions and other information about your game."),
GetMutableDefault<UGeneralProjectSettings>()
);
// map related settings
SettingsModule.RegisterSettings("Project", "Game", "Maps",
LOCTEXT("GameMapsSettingsName", "Maps & Modes"),
LOCTEXT("GameMapsSettingsDescription", "Default maps, game modes and other map related settings."),
GetMutableDefault<UGameMapsSettings>()
);
// packaging settings
SettingsModule.RegisterSettings("Project", "Game", "Packaging",
LOCTEXT("ProjectPackagingSettingsName", "Packaging"),
LOCTEXT("ProjectPackagingSettingsDescription", "Fine tune how your project is packaged for release."),
GetMutableDefault<UProjectPackagingSettings>()
);
// movie settings
SettingsModule.RegisterSettings("Project", "Game", "Movies",
LOCTEXT("MovieSettingsName", "Movies"),
LOCTEXT("MovieSettingsDescription", "Movie player settings"),
GetMutableDefault<UMoviePlayerSettings>()
);
// update the visible packaging enum values
UProjectPackagingSettings::UpdateBuildConfigurationVisibility();
/*
// game session
SettingsModule.RegisterSettings("Project", "Game", "GameSession",
LOCTEXT("GameSessionettingsName", "Game Session"),
LOCTEXT("GameSessionSettingsDescription", "Game Session settings."),
GetMutableDefault<UGameSessionSettings>()
);
// head-up display
SettingsModule.RegisterSettings("Project", "Game", "HUD",
LOCTEXT("HudSettingsName", "HUD"),
LOCTEXT("HudSettingsDescription", "Head-up display (HUD) settings."),
GetMutableDefault<UHudSettings>()
);*/
}
/**
* Unregisters all settings.
*/
void UnregisterSettings( )
{
ISettingsModule* SettingsModule = ISettingsModule::Get();
if (SettingsModule != nullptr)
{
SettingsModule->UnregisterViewer("Project");
// engine settings
SettingsModule->UnregisterSettings("Project", "Engine", "General");
SettingsModule->UnregisterSettings("Project", "Engine", "NavigationSystem");
SettingsModule->UnregisterSettings("Project", "Engine", "NavigationMesh");
SettingsModule->UnregisterSettings("Project", "Engine", "Input");
SettingsModule->UnregisterSettings("Project", "Game", "Collision");
SettingsModule->UnregisterSettings("Project", "Engine", "Physics");
SettingsModule->UnregisterSettings("Project", "Engine", "Rendering");
// SettingsModule->UnregisterSettings("Project", "Engine", "NetworkManager");
// game settings
SettingsModule->UnregisterSettings("Project", "Game", "General");
SettingsModule->UnregisterSettings("Project", "Game", "Maps");
SettingsModule->UnregisterSettings("Project", "Game", "Packaging");
SettingsModule->UnregisterSettings("Project", "Game", "Movies");
// SettingsModule->UnregisterSettings("Project", "Game", "GameSession");
// SettingsModule->UnregisterSettings("Project", "Game", "HUD");
}
}
private:
// Handles creating the project settings tab.
TSharedRef<SDockTab> HandleSpawnSettingsTab( const FSpawnTabArgs& SpawnTabArgs )
{
ISettingsModule* SettingsModule = ISettingsModule::Get();
TSharedRef<SWidget> SettingsEditor = SNullWidget::NullWidget;
if (SettingsModule != nullptr)
{
ISettingsContainerPtr SettingsContainer = SettingsModule->GetContainer("Project");
if (SettingsContainer.IsValid())
{
ISettingsEditorModule& SettingsEditorModule = ISettingsEditorModule::GetRef();
ISettingsEditorModelRef SettingsEditorModel = SettingsEditorModule.CreateModel(SettingsContainer.ToSharedRef());
SettingsEditor = SettingsEditorModule.CreateEditor(SettingsEditorModel);
SettingsEditorModelPtr = SettingsEditorModel;
}
}
return SNew(SDockTab)
.TabRole(ETabRole::NomadTab)
[
SettingsEditor
];
}
private:
// Holds a pointer to the settings editor's view model.
TWeakPtr<ISettingsEditorModel> SettingsEditorModelPtr;
};
IMPLEMENT_MODULE(FProjectSettingsViewerModule, ProjectSettingsViewer);
#undef LOCTEXT_NAMESPACE