GameMapsSettings.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/SoftObjectPath.h"
#include "GameMapsSettings.generated.h"
 
UENUM()
namespace ETwoPlayerSplitScreenType
{
    enum Type : int
    {
        Horizontal,
        Vertical
    };
}
 
 
UENUM()
namespace EThreePlayerSplitScreenType
{
    enum Type : int
    {
        FavorTop,
        FavorBottom,
        Vertical,
        Horizontal
    };
}
 
UENUM()
enum class EFourPlayerSplitScreenType : uint8
{
    Grid,
    Vertical,
    Horizontal
};
 
USTRUCT()
struct FGameModeName
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, Category = DefaultModes, meta = (MetaClass = "/Script/Engine.GameModeBase"))
    FString Name;
 
    UPROPERTY(EditAnywhere, Category = DefaultModes, meta = (MetaClass = "/Script/Engine.GameModeBase"))
    FSoftClassPath GameMode;
};
 
UENUM()
enum class ESubLevelStripMode : uint8
{
    // The class of the sub level actor must be exactly this class
    ExactClass,
 
    // Any child class of this class will be stripped, this is more expensive than ExactClass
    IsChildOf
};
 
 
USTRUCT()
struct FTemplateMapInfoOverride
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(config, EditAnywhere, Category = DefaultMaps, meta = (AllowedClasses = "/Script/Engine.Texture2D"))
    FSoftObjectPath Thumbnail;
 
    UPROPERTY(config, EditAnywhere, Category = DefaultMaps, meta = (AllowedClasses = "/Script/Engine.World"))
    FSoftObjectPath Map;
 
    UPROPERTY(config, EditAnywhere, Category = DefaultMaps)
    FText DisplayName;
 
    FTemplateMapInfoOverride()
    {
    }
};
 
enum class EDefaultMapRequestType : uint8
{
    Default,
    Client,
    Server
};
 
UCLASS(config=Engine, defaultconfig, MinimalAPI)
class UGameMapsSettings
    : public UObject
{
    GENERATED_UCLASS_BODY()
 
    
    static ENGINESETTINGS_API FString GetGameDefaultMap(EDefaultMapRequestType RequestType = EDefaultMapRequestType::Default);
 
    static ENGINESETTINGS_API FString GetGlobalDefaultGameMode( );
 
    static ENGINESETTINGS_API FString GetGameModeForName( const FString& GameModeName );
 
    static ENGINESETTINGS_API FString GetGameModeForMapName( const FString& MapName );
 
    static ENGINESETTINGS_API void SetGameDefaultMap( const FString& NewMap );
 
    static ENGINESETTINGS_API void SetGlobalDefaultGameMode( const FString& NewGameMode );
 
    ENGINESETTINGS_API virtual void PostInitProperties() override;
    ENGINESETTINGS_API virtual void PostReloadConfig( class FProperty* PropertyThatWasLoaded ) override;
 
public:
 
#if WITH_EDITORONLY_DATA
    UPROPERTY(config, EditAnywhere, Category=DefaultMaps, meta=(AllowedClasses="/Script/Engine.World"))
    FSoftObjectPath EditorStartupMap;
 
    UPROPERTY(config, EditAnywhere, Category=DefaultMaps, meta=(ConfigRestartRequired=true))
    TArray<FTemplateMapInfoOverride> EditorTemplateMapOverrides;
#endif
 
    UPROPERTY(config, EditAnywhere, Category=DefaultMaps, AdvancedDisplay)
    FString LocalMapOptions;
 
    UPROPERTY(config, EditAnywhere, Category=DefaultMaps, AdvancedDisplay, meta=(AllowedClasses="/Script/Engine.World"))
    FSoftObjectPath TransitionMap;
 
    UPROPERTY(config, EditAnywhere, Category=LocalMultiplayer)
    bool bUseSplitscreen;
 
    UPROPERTY(config, EditAnywhere, Category=LocalMultiplayer, meta=(editcondition="bUseSplitScreen"))
    TEnumAsByte<ETwoPlayerSplitScreenType::Type> TwoPlayerSplitscreenLayout;
 
    UPROPERTY(config, EditAnywhere, Category=LocalMultiplayer, meta=(editcondition="bUseSplitScreen"))
    TEnumAsByte<EThreePlayerSplitScreenType::Type> ThreePlayerSplitscreenLayout;
 
    UPROPERTY(config, EditAnywhere, Category=LocalMultiplayer, meta=(editcondition="bUseSplitScreen"))
    EFourPlayerSplitScreenType FourPlayerSplitscreenLayout;
 
    UPROPERTY(config, EditAnywhere, Category=LocalMultiplayer)
    bool bShowAllPlayerWidgetsWhenSplitscreenDisabled;
 
    UPROPERTY(config, EditAnywhere, Category=LocalMultiplayer, meta=(DisplayName="Skip Assigning Gamepad to Player 1"))
    bool bOffsetPlayerGamepadIds;
 
    UPROPERTY(config, noclear, EditAnywhere, Category=GameInstance, meta=(MetaClass="/Script/Engine.GameInstance"))
    FSoftClassPath GameInstanceClass;
 
private:
 
    UPROPERTY(config, EditAnywhere, Category=DefaultMaps, meta=(AllowedClasses="/Script/Engine.World"))
    FSoftObjectPath GameDefaultMap;
 
    UPROPERTY(config, EditAnywhere, Category=DefaultMaps, AdvancedDisplay, meta=(AllowedClasses="/Script/Engine.World"))
    FSoftObjectPath ServerDefaultMap;
 
    UPROPERTY(config, noclear, EditAnywhere, Category=DefaultModes, meta=(MetaClass="/Script/Engine.GameModeBase", DisplayName="Default GameMode"))
    FSoftClassPath GlobalDefaultGameMode;
 
    UPROPERTY(config, EditAnywhere, Category=DefaultModes, meta=(MetaClass="/Script/Engine.GameModeBase"), AdvancedDisplay)
    FSoftClassPath GlobalDefaultServerGameMode;
 
    UPROPERTY(config, EditAnywhere, Category = DefaultModes, AdvancedDisplay)
    TArray<FGameModeName> GameModeMapPrefixes;
 
    UPROPERTY(config, EditAnywhere, Category = DefaultModes, AdvancedDisplay)
    TArray<FGameModeName> GameModeClassAliases;
 
public:
 
    UFUNCTION(BlueprintPure, Category = Settings, meta=(DisplayName="Get Game Maps and Modes Settings"))
    static ENGINESETTINGS_API UGameMapsSettings* GetGameMapsSettings();
 
    UFUNCTION(BlueprintCallable, Category = "Utilities")
    ENGINESETTINGS_API void SetSkipAssigningGamepadToPlayer1(bool bSkipFirstPlayer = true);
 
    UFUNCTION(BlueprintPure, Category = "Utilities")
    ENGINESETTINGS_API bool GetSkipAssigningGamepadToPlayer1() const;
 
};