GameTargetsSettings

GameTargetsSettings

#Overview

name: GameTargetsSettings

The value of this variable can be defined or overridden in .ini config files. 4 .ini config files referencing this setting variable.

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of GameTargetsSettings is to manage localization target settings for game-specific content in Unreal Engine 5. This variable is part of the localization system, which is responsible for handling multiple language support in games developed with Unreal Engine.

GameTargetsSettings is primarily used in the Localization module of Unreal Engine. This can be seen from the file paths in the callsites, which are located in the “Developer/Localization” directory.

The value of this variable is set in two main ways:

  1. It is populated in the PostInitProperties function, where it creates ULocalizationTarget objects based on the settings stored in GameTargetsSettings.
  2. It is updated in the PostEditChangeProperty function, where changes made to the GameTargetSet are reflected back into GameTargetsSettings.

GameTargetsSettings interacts closely with the GameTargetSet variable, which is likely an instance of ULocalizationTargetSet. The relationship appears to be bidirectional, with data flowing between these two variables to keep them in sync.

Developers should be aware that:

  1. This variable is used to store configuration data (indicated by the UPROPERTY(config) decorator).
  2. Changes to GameTargetSet will be reflected in GameTargetsSettings and vice versa.
  3. The variable is used in editor-only code sections (wrapped in #if WITH_EDITOR), suggesting it’s primarily used for development and may not be available in shipped games.

Best practices when using this variable include:

  1. Ensure that any modifications to game localization targets are properly reflected in both GameTargetsSettings and GameTargetSet.
  2. Be cautious when directly modifying GameTargetsSettings, as it may impact the editor’s localization functionality.
  3. When adding new localization targets, make sure to update both the configuration data (GameTargetsSettings) and the runtime objects (GameTargetSet).
  4. Use the provided functions (PostInitProperties and PostEditChangeProperty) to manage changes to this variable, rather than modifying it directly, to ensure proper synchronization with other parts of the localization system.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditor.ini:520, section: [/Script/Localization.LocalizationSettings]

Location: <Workspace>/Projects/Lyra/Config/DefaultEditor.ini:66, section: [/Script/Localization.LocalizationSettings]

Location: <Workspace>/Projects/Lyra/Config/DefaultEditor.ini:67, section: [/Script/Localization.LocalizationSettings]

Location: <Workspace>/Projects/Lyra/Config/DefaultEditor.ini:68, section: [/Script/Localization.LocalizationSettings]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Source/Developer/Localization/Private/LocalizationSettings.cpp:37

Scope (from outer to inner):

file
function     void ULocalizationSettings::PostInitProperties

Source code excerpt:

	{
		GameTargetSet->TargetObjects.Empty(EngineTargetsSettings.Num());
		for (const auto& TargetSettings : GameTargetsSettings)
		{
			ULocalizationTarget* const TargetObject = NewObject<ULocalizationTarget>(GameTargetSet);
			TargetObject->Settings = TargetSettings;
			TargetObject->UpdateStatusFromConflictReport();
			TargetObject->UpdateWordCountsFromCSV();
			GameTargetSet->TargetObjects.Add(TargetObject);

#Loc: <Workspace>/Engine/Source/Developer/Localization/Private/LocalizationSettings.cpp:65

Scope (from outer to inner):

file
function     void ULocalizationSettings::PostEditChangeProperty

Source code excerpt:

	if (GameTargetSet)
	{
		GameTargetsSettings.Empty(GameTargetSet->TargetObjects.Num());
		for (const auto& TargetObject : GameTargetSet->TargetObjects)
		{
			GameTargetsSettings.Add(TargetObject ? TargetObject->Settings : FLocalizationTargetSettings());
		}
	}

	TryUpdateDefaultConfigFile();
}
#endif

#Loc: <Workspace>/Engine/Source/Developer/Localization/Public/LocalizationSettings.h:36

Scope (from outer to inner):

file
class        class ULocalizationSettings : public UObject

Source code excerpt:


	UPROPERTY(config)
	TArray<FLocalizationTargetSettings> GameTargetsSettings;

public:
#if WITH_EDITOR
	virtual void PostInitProperties() override;
	virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif