1. Epic GamesDeveloper
  3. UGameMapsSettings

UGameMapsSettings

API > API/Runtime > API/Runtime/EngineSettings

   
Name UGameMapsSettings
Type class
Header File /Engine/Source/Runtime/EngineSettings/Classes/GameMapsSettings.h
Include Path #include "GameMapsSettings.h"

Syntax

UCLASS (Config=Engine, defaultconfig, MinimalAPI)  
class UGameMapsSettings : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UGameMapsSettings ( const FObjectInitializer& ObjectInitializer
)

   GameMapsSettings.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bOffsetPlayerGamepadIds bool If enabled, this will make so that gamepads start being assigned to the second controller ID in local multiplayer games. GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=LocalMultiplayer
  • Meta=(DisplayName="Skip Assigning Gamepad to Player 1")
bShowAllPlayerWidgetsWhenSplitscreenDisabled bool Determines whether all player widget layers should be displayed in the main viewport when splitscreen is disabled. GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=LocalMultiplayer
bUseSplitscreen bool Whether the screen should be split or not when multiple local players are present GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=LocalMultiplayer
EditorStartupMap FSoftObjectPath If set, this map will be loaded when the Editor starts up. GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultMaps
  • Meta=(AllowedClasses="/Script/Engine.World")
EditorTemplateMapOverrides TArray< FTemplateMapInfoOverride > Map templates that should show up in the new level dialog. GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultMaps
  • Meta=(ConfigRestartRequired=true)
FourPlayerSplitscreenLayout EFourPlayerSplitScreenType The viewport layout to use if the screen should be split and there are three local players GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=LocalMultiplayer
  • Meta=(editcondition="bUseSplitScreen")
GameInstanceClass FSoftClassPath The class to use when instantiating the transient GameInstance class GameMapsSettings.h
  • Config
  • NoClear
  • EditAnywhere
  • Category=GameInstance
  • Meta=(MetaClass="/Script/Engine.GameInstance")
LocalMapOptions FString The default options that will be appended to a map being loaded. GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultMaps
  • AdvancedDisplay
ThreePlayerSplitscreenLayout TEnumAsByte< EThreePlayerSplitScreenType::Type > The viewport layout to use if the screen should be split and there are three local players GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=LocalMultiplayer
  • Meta=(editcondition="bUseSplitScreen")
TransitionMap FSoftObjectPath The map loaded when transition from one map to another. GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultMaps
  • AdvancedDisplay
  • Meta=(AllowedClasses="/Script/Engine.World")
TwoPlayerSplitscreenLayout TEnumAsByte< ETwoPlayerSplitScreenType::Type > The viewport layout to use if the screen should be split and there are two local players GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=LocalMultiplayer
  • Meta=(editcondition="bUseSplitScreen")

Protected

Name Type Remarks Include Path Unreal Specifiers
GameDefaultMap FSoftObjectPath The map that will be loaded by default when no other map is loaded. GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultMaps
  • Meta=(AllowedClasses="/Script/Engine.World")
GameModeClassAliases TArray< FGameModeName > List of GameModes to load when game= is specified in the URL (e.g. "DM" could be an alias for "MyProject.MyGameModeMP_DM") GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultModes
  • AdvancedDisplay
GameModeMapPrefixes TArray< FGameModeName > Overrides the GameMode to use when loading a map that starts with a specific prefix GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultModes
  • AdvancedDisplay
GlobalDefaultGameMode FSoftClassPath GameMode to use if not specified in any other way. (e.g. per-map DefaultGameMode or on the URL). GameMapsSettings.h
  • Config
  • NoClear
  • EditAnywhere
  • Category=DefaultModes
  • Meta=(MetaClass="/Script/Engine.GameModeBase", DisplayName="Default GameMode")
GlobalDefaultServerGameMode FSoftClassPath GameMode to use if not specified in any other way. GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultModes
  • Meta=(MetaClass="/Script/Engine.GameModeBase")
  • AdvancedDisplay
ServerDefaultMap FSoftObjectPath The map that will be loaded by default when no other map is loaded (DEDICATED SERVER). GameMapsSettings.h
  • Config
  • EditAnywhere
  • Category=DefaultMaps
  • AdvancedDisplay
  • Meta=(AllowedClasses="/Script/Engine.World")

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetSkipAssigningGamepadToPlayer1()

   GameMapsSettings.h
  • BlueprintPure
  • Category="Utilities"

void SetSkipAssigningGamepadToPlayer1 ( bool bSkipFirstPlayer
)

 Modify "Skip Assigning Gamepad to Player 1" GameMapsSettings option GameMapsSettings.h
  • BlueprintCallable
  • Category="Utilities"

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostInitProperties()

   GameMapsSettings.h  

virtual void PostReloadConfig ( FProperty* PropertyThatWasLoaded
)

   GameMapsSettings.h  

Static

Name Remarks Include Path Unreal Specifiers
Get the default map specified in the settings. GameMapsSettings.h  

static UGameMapsSettings * GetGameMapsSettings()

 Returns the game local maps settings GameMapsSettings.h
  • BlueprintPure
  • Category=Settings
  • Meta=(DisplayName="Get Game Maps and Modes Settings")

static FString GetGameModeForMapName ( const FString& MapName
)

 Searches the GameModeMapPrefixes list for a named game mode, if not found will return passed in string GameMapsSettings.h  

static FString GetGameModeForName ( const FString& GameModeName
)

 Searches the GameModeClassAliases list for a named game mode, if not found will return passed in string GameMapsSettings.h  

static FString GetGlobalDefaultGameMode()

 Get the global default game type specified in the configuration Makes a choice based on running as listen server/client vs dedicated server GameMapsSettings.h  

static void SetGameDefaultMap ( const FString& NewMap
)

 Set the default map to use (see GameDefaultMap below) GameMapsSettings.h  

static void SetGlobalDefaultGameMode ( const FString& NewGameMode
)

 Set the default game type (see GlobalDefaultGameMode below) GameMapsSettings.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page