className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
FPortableObjectEntry::AddReferences
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Helper function that adds to the reference comments.
Localization
void AddReferences ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InReferences )
[]
FPortableObjectEntry::AddTranslatorComment
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Helper function that adds to the translator comments.
Localization
void AddTranslatorComment ( const [FString](API\Runtime\Core\Containers\FString) & InComment )
[]
FPortableObjectEntry::AddTranslatorComments
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Helper function that adds to the translator comments.
Localization
void AddTranslatorComments ( const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & InComments )
[]
FPortableObjectEntry::ToString
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Function to convert the entry to a string. String representing the entry that can be written directly to the .po file.
Localization
[FString](API\Runtime\Core\Containers\FString) ToString() const
[]
FPortableObjectEntry::FPortableObjectEntry
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
FPortableObjectEntry()
[]
FPortableObjectEntry
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Class for representing entries in a Portable Object file(.po) or a Portable Object Template file(.pot).
Localization
class FPortableObjectEntry : public [FPortableObjectEntryKey](API\Developer\Localization\FPortableObjectEntryKey)
[ { "type": "TArray<FString...", "name": "ExtractedComments", "description": "" }, { "type": "TArray<FString...", "name": "Flags", "description": "" }, { "type": "TArray<FString...", "name": "MsgStr", "description": "Represents the translated text." }, { "type": "TArray<FString...", "name": "ReferenceComments", "description": "" }, { "type": "TArray<FString...", "name": "TranslatorComments", "description": "" }, { "type": "TArray<FString...", "name": "UnknownElements", "description": "Stores any unknown elements we may encounter when processing a Portable Object file." } ]
FPortableObjectEntryKey::operator==
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
bool operator== ( const [FPortableObjectEntryKey](API\Developer\Localization\FPortableObjectEntryKey) & Other ) const
[]
FPortableObjectEntryKey::FPortableObjectEntryKey
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
FPortableObjectEntryKey()
[]
FPortableObjectEntryKey::FPortableObjectEntryKey
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
FPortableObjectEntryKey ( const [FString](API\Runtime\Core\Containers\FString) & InMsgId, const [FString](API\Runtime\Core\Containers\FString) & InMsgIdPlural, const [FString](API\Runtime\Core\Containers\FString) & InMsgCtxt )
[]
FPortableObjectEntryKey
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Class for representing the key of an entry in a Portable Object file(.po) or a Portable Object Template file(.pot).
Localization
class FPortableObjectEntryKey
[ { "type": "FString", "name": "MsgCtxt", "description": "Represents the disambiguating context for the source text." }, { "type": "FString", "name": "MsgId", "description": "Represents the original source text(also called the id or context)." }, { "type": "FString", "name": "MsgIdPlural", "description": "Represents the plural form of the source text." } ]
FPortableObjectFormatDOM::AddEntry
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Adds a translation entry to the Portable Object. Returns true if successful, false otherwise.
Localization
bool AddEntry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > LocEntry )
[]
FPortableObjectFormatDOM::CreateNewHeader
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Creates a header entry based on the project and language info.
Localization
void CreateNewHeader ( const [FString](API\Runtime\Core\Containers\FString) & InCopyrightNotice )
[]
FPortableObjectFormatDOM::FindEntry
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Returns the Portable Object entry that matches the passed in entry or NULL if not found
Localization
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > FindEntry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > LocEntry ) const
[]
FPortableObjectFormatDOM::FindEntry
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Returns the Portable Object file entry that matches the passed in parameters or NULL if not found
Localization
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > FindEntry ( const [FString](API\Runtime\Core\Containers\FString) & MsgId, const [FString](API\Runtime\Core\Containers\FString) & MsgIdPlural, const [FString](API\Runtime\Core\Containers\FString) & MsgCtxt ) const
[]
FPortableObjectFormatDOM::FromString
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Parses Portable Object elements from a string. Returns true if successful, false otherwise.
Localization
bool FromString ( const [FString](API\Runtime\Core\Containers\FString) & InStr, [FText](API\Runtime\Core\Internationalization\FText) * OutErrorMsg )
[]
FPortableObjectFormatDOM::GetEntriesIterator
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
[FPortableObjectEntries::TConstIterator](API\Runtime\Core\Containers\TMapBase\TConstIterator) GetEntriesIterator() const
[]
FPortableObjectFormatDOM::GetProjectName
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Sets the project name from the Project-Id-Version header entry
Localization
[FString](API\Runtime\Core\Containers\FString) GetProjectName() const
[]
FPortableObjectFormatDOM::operator=
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
[FPortableObjectFormatDOM](API\Developer\Localization\FPortableObjectFormatDOM) & operator= ( const [FPortableObjectFormatDOM](API\Developer\Localization\FPortableObjectFormatDOM) & )
[]
FPortableObjectFormatDOM::SetHeaderValue
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Must be called after CreateNewHeader.
Localization
void SetHeaderValue ( const [FString](API\Runtime\Core\Containers\FString) & EntryKey, const [FString](API\Runtime\Core\Containers\FString) & EntryValue )
[]
FPortableObjectFormatDOM::SetLanguage
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Sets the language. Returns true if the function was able to successfully set the language code and pair it with a known culture, false otherwise.
Localization
bool SetLanguage ( const [FString](API\Runtime\Core\Containers\FString) & LanguageCode, const [FString](API\Runtime\Core\Containers\FString) & LangPluralForms )
[]
FPortableObjectFormatDOM::SetProjectName
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Sets the project name that will appear in the Project-Id-Version header entry
Localization
void SetProjectName ( const [FString](API\Runtime\Core\Containers\FString) & ProjName )
[]
FPortableObjectFormatDOM::SortEntries
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
void SortEntries()
[]
FPortableObjectFormatDOM::ToString
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Creates a string representation of the Portable Object. String representing the Portable Object that can be written directly to a file.
Localization
[FString](API\Runtime\Core\Containers\FString) ToString()
[]
FPortableObjectFormatDOM::FPortableObjectFormatDOM
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
FPortableObjectFormatDOM()
[]
FPortableObjectFormatDOM::FPortableObjectFormatDOM
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
FPortableObjectFormatDOM ( const [FString](API\Runtime\Core\Containers\FString) & LanguageCode )
[]
FPortableObjectFormatDOM::FPortableObjectFormatDOM
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Copying is not supported
Localization
FPortableObjectFormatDOM ( const [FPortableObjectFormatDOM](API\Developer\Localization\FPortableObjectFormatDOM) & )
[]
FPortableObjectFormatDOM
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Contains all the info we need to represent files in the Portable Object format.
Localization
class FPortableObjectFormatDOM
[]
FPortableObjectHeader::Clear
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Clears the header entries.
Localization
void Clear()
[]
FPOHeaderData
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
typedef [TArray](API\Runtime\Core\Containers\TArray)< [FPOHeaderEntry](API\Developer\Localization\FPortableObjectHeader\FPOHeaderEntry) > FPOHeaderData
[]
FPOHeaderEntry
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
typedef TPair< [FString](API\Runtime\Core\Containers\FString), [FString](API\Runtime\Core\Containers\FString) > FPOHeaderEntry
[]
FPortableObjectHeader::FromLocPOEntry
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Parses out header info from aFPortableObjectEntrywith an empty ID. Returns true if successful, false otherwise.
Localization
bool FromLocPOEntry ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) > LocEntry )
[]
FPortableObjectHeader::FromString
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Parses out header key/value pair entries. Returns true if successful, false otherwise.
Localization
bool FromString ( const [FString](API\Runtime\Core\Containers\FString) & InStr )
[]
FPortableObjectHeader::GetEntryValue
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Gets the header entry value for the given key or the empty string if the key does not exist
Localization
[FString](API\Runtime\Core\Containers\FString) GetEntryValue ( const [FString](API\Runtime\Core\Containers\FString) & EntryKey ) const
[]
FPortableObjectHeader::HasEntry
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Checks if a header entry exists with the given key
Localization
bool HasEntry ( const [FString](API\Runtime\Core\Containers\FString) & EntryKey ) const
[]
FPortableObjectHeader::SetEntryValue
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Sets a header entry value
Localization
void SetEntryValue ( const [FString](API\Runtime\Core\Containers\FString) & EntryKey, const [FString](API\Runtime\Core\Containers\FString) & EntryValue )
[]
FPortableObjectHeader::ToString
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Creates a string representation of the Portable Object header. String representing the header that can be written directly to the .po file.
Localization
[FString](API\Runtime\Core\Containers\FString) ToString() const
[]
FPortableObjectHeader::UpdateTimeStamp
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Puts the current time into POT-Creation-Date and PO-Revision-Date entries
Localization
void UpdateTimeStamp()
[]
FPortableObjectHeader
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Class that stores and manipulates PO and POT file header info.
Localization
class FPortableObjectHeader
[ { "type": "TArray<FString...", "name": "Comments", "description": "Stores the header comment block" }, { "type": "FPOHeaderData", "name": "HeaderEntries", "description": "Stores all the header key/value pairs" } ]
FPortableObjectHeader::FPortableObjectHeader
/Engine/Source/Developer/Localization/Public/PortableObjectFormatDOM.h
Localization
FPortableObjectHeader()
[]
FTextLocalizationResourceGenerator::GenerateLocMeta
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Given a loc text helper, generate a compiled LocMeta resource.
Localization
static bool GenerateLocMeta ( const [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InResourceName, [FTextLocalizationMetaDataResource](API\Runtime\Core\Internationalization\FTextLocalizationMetaDataResourc-) & OutLocMeta )
[]
FTextLocalizationResourceGenerator::GenerateLocRes
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Given a loc text helper, generate a compiled LocRes resource for the given culture.
Localization
static bool GenerateLocRes ( const [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InCultureToGenerate, const [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) InGenerateFlags, const [FTextKey](API\Runtime\Core\Internationalization\FTextKey) & InLocResID, [FTextLocalizationResource](API\Runtime\Core\Internationalization\FTextLocalizationResource) & OutPlatformAgnosticLocRes, [TMap](API\Runtime\Core\Containers\TMap)< [FName](API\Runtime\Core\UObject\FName), [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTextLocalizationResource](API\Runtime\Core\Internationalization\FTextLocalizationResource) >> & OutPerPlatformLocRes, const int32 InPriority )
[]
FTextLocalizationResourceGenerator::GenerateLocResAndUpdateLiveEntriesFromConfig
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Given a config file, generate a compiled LocRes resource for the active culture and use it to update the live-entries in the localization manager.
Localization
static bool GenerateLocResAndUpdateLiveEntriesFromConfig ( const [FString](API\Runtime\Core\Containers\FString) & InConfigFilePath, const [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) InGenerateFlags )
[]
FTextLocalizationResourceGenerator
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Utility functions for generating compiled LocMeta (Localization MetaData Resource) and LocRes (Localization Resource) files from source localization data
Localization
class FTextLocalizationResourceGenerator
[]
FUserGeneratedContentLocalizationDescriptor::FromJsonFile
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Localization
bool FromJsonFile ( const TCHAR * InFilename )
[]
FUserGeneratedContentLocalizationDescriptor::FromJsonObject
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Load the settings from a JSON object/file.
Localization
bool FromJsonObject ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObject )
[]
FUserGeneratedContentLocalizationDescriptor::FromJsonString
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Localization
bool FromJsonString ( const [FString](API\Runtime\Core\Containers\FString) & InJsonString )
[]
FUserGeneratedContentLocalizationDescriptor::InitializeFromProject
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Initialize the NativeCulture and CulturesToGenerate values based on the settings of the currently loaded Unreal project.
Localization
void InitializeFromProject ( const ELocalizedTextSourceCategory LocalizationCategory )
[]
FUserGeneratedContentLocalizationDescriptor::ToJsonFile
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Localization
bool ToJsonFile ( const TCHAR * InFilename ) const
[]
FUserGeneratedContentLocalizationDescriptor::ToJsonObject
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Save the settings to a JSON object/file.
Localization
bool ToJsonObject ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > & OutJsonObject ) const
[]
FUserGeneratedContentLocalizationDescriptor::ToJsonString
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Localization
bool ToJsonString ( [FString](API\Runtime\Core\Containers\FString) & OutJsonString ) const
[]
FUserGeneratedContentLocalizationDescriptor::Validate
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Validate that this descriptor isn't using cultures that aren't present in the CulturesToGenerate of the given default.
Localization
bool Validate ( const [FUserGeneratedContentLocalizationDescriptor](API\Developer\Localization\FUserGeneratedContentLocalizatio-) & DefaultDescriptor )
[]
FUserGeneratedContentLocalizationDescriptor
/Engine/Source/Developer/Localization/Public/UserGeneratedContentLocalization.h
Minimal descriptor needed to generate a localization target for UGC localization.
Localization
struct FUserGeneratedContentLocalizationDescriptor
[ { "type": "TArray<FString...", "name": "CulturesToGenerate", "description": "The cultures that we should generate localization data for." }, { "type": "FString", "name": "NativeCulture", "description": "The culture that the source text is authored in." }, { "type": "EPortableObject...", "name": "PoFormat", "description": "What format of PO file should we use?" } ]
ILocalizationModule::Get
/Engine/Source/Developer/Localization/Public/LocalizationModule.h
Localization
static [ILocalizationModule](API\Developer\Localization\ILocalizationModule) & Get()
[]
ILocalizationModule::GetLocalizationTargetByName
/Engine/Source/Developer/Localization/Public/LocalizationModule.h
Localization
[ULocalizationTarget](API\Developer\Localization\ULocalizationTarget) * GetLocalizationTargetByName ( [FString](API\Runtime\Core\Containers\FString) TargetName, bool bIsEngineTarget )
[]
ILocalizationModule::HandleRegenLocCommand
/Engine/Source/Developer/Localization/Public/LocalizationModule.h
Given a config file, generate a compiled LocRes file for the active culture and use it to update the live-entries in the localization manager.
Localization
bool HandleRegenLocCommand ( const [FString](API\Runtime\Core\Containers\FString) & InConfigFilePath )
[]
ILocalizationModule
/Engine/Source/Developer/Localization/Public/LocalizationModule.h
Localization
class ILocalizationModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)
[]
ILocFileNotifies::PostFileRead
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Called after reading the given file from disk
Localization
void PostFileRead ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )
[]
ILocFileNotifies::PostFileWrite
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Called after writing the given file to disk
Localization
void PostFileWrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )
[]
ILocFileNotifies::PreFileRead
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Called prior to reading the given file on disk
Localization
void PreFileRead ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )
[]
ILocFileNotifies::PreFileWrite
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Called prior to writing the given file to disk
Localization
void PreFileWrite ( const [FString](API\Runtime\Core\Containers\FString) & InFilename )
[]
ILocFileNotifies::~ILocFileNotifies
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Virtual destructor
Localization
virtual ~ILocFileNotifies()
[]
ILocFileNotifies
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Interface for the loc file notify API. This can be used to integrate with services like source control.
Localization
class ILocFileNotifies
[]
operator&
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
constexpr [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) operator& ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Lhs, [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Rhs )
[]
operator&
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Localization
constexpr [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) operator& ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Lhs, [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Rhs )
[]
operator&=
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
[ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) & operator&= ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) & Lhs, [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Rhs )
[]
operator&=
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Localization
[EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) & operator&= ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) & Lhs, [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Rhs )
[]
operator~
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Localization
constexpr [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) operator~ ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) E )
[]
operator~
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
constexpr [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) operator~ ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) E )
[]
operator^
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
constexpr [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) operator^ ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Lhs, [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Rhs )
[]
operator^
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Localization
constexpr [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) operator^ ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Lhs, [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Rhs )
[]
operator^=
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
[ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) & operator^= ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) & Lhs, [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) Rhs )
[]
operator^=
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Localization
[EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) & operator^= ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) & Lhs, [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) Rhs )
[]
operator!
/Engine/Source/Developer/Localization/Public/LocTextHelper.h
Localization
constexpr bool operator! ( [ELocTextHelperLoadFlags](API\Developer\Localization\ELocTextHelperLoadFlags) E )
[]
operator!
/Engine/Source/Developer/Localization/Public/TextLocalizationResourceGenerator.h
Localization
constexpr bool operator! ( [EGenerateLocResFlags](API\Developer\Localization\EGenerateLocResFlags) E )
[]
PortableObjectPipeline::GetConditionedKeyForExtractedComment
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Given a key string, condition it so it can be written as the extracted comment field of a PO file
Localization
namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::GetConditionedKeyForExtractedComment ( const [FString](API\Runtime\Core\Containers\FString) & Key ) }
[]
PortableObjectPipeline::GetConditionedReferenceForExtractedComment
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Given a source location string, condition it so it can be written as the extracted comment field of a PO file
Localization
namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::GetConditionedReferenceForExtractedComment ( const [FString](API\Runtime\Core\Containers\FString) & PORefString ) }
[]
PortableObjectPipeline::GetConditionedInfoMetaDataForExtractedComment
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Given a meta-data value string, condition it so it can be written as the extracted comment field of a PO file
Localization
namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::GetConditionedInfoMetaDataForExtractedComment ( const [FString](API\Runtime\Core\Containers\FString) & KeyName, const [FString](API\Runtime\Core\Containers\FString) & ValueString ) }
[]
PortableObjectPipeline::ConditionIdentityForPO
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Given a namespace and key, condition this information so it can be written to the "msgctxt" or "msgid" field of a PO file
Localization
namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::ConditionIdentityForPO ( const [FString](API\Runtime\Core\Containers\FString) & Namespace, const [FString](API\Runtime\Core\Containers\FString) & Key, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & KeyMetaData, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode ) }
[]
PortableObjectPipeline::ConditionPOStringForArchive
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Given the field of a PO file, condition it back to a clean string
Localization
namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::ConditionPOStringForArchive ( const [FString](API\Runtime\Core\Containers\FString) & InStr ) }
[]
PortableObjectPipeline::ConditionArchiveStrForPO
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Given a string, condition it so it can be written as a field of a PO file
Localization
namespace PortableObjectPipeline { [FString](API\Runtime\Core\Containers\FString) PortableObjectPipeline::ConditionArchiveStrForPO ( const [FString](API\Runtime\Core\Containers\FString) & InStr ) }
[]
PortableObjectPipeline::Export
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Use the given LocTextHelper to generate a new PO file using the translation data for the given culture
Localization
namespace PortableObjectPipeline { bool PortableObjectPipeline::Export ( [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FString](API\Runtime\Core\Containers\FString) & InPOFilePath, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat, const bool bShouldPersistComments ) }
[]
PortableObjectPipeline::ExportAll
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Use the given LocTextHelper to generate a new PO file using the translation data for all cultures
Localization
namespace PortableObjectPipeline { bool PortableObjectPipeline::ExportAll ( [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InPOCultureRootPath, const [FString](API\Runtime\Core\Containers\FString) & InPOFilename, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat, const bool bShouldPersistComments, const bool bUseCultureDirectory ) }
[]
PortableObjectPipeline::Import
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Update the given LocTextHelper with the translation data imported from the PO file for the given culture
Localization
namespace PortableObjectPipeline { bool PortableObjectPipeline::Import ( [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InCulture, const [FString](API\Runtime\Core\Containers\FString) & InPOFilePath, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat ) }
[]
PortableObjectPipeline::ImportAll
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Update the given LocTextHelper with the translation data imported from the PO file for all cultures
Localization
namespace PortableObjectPipeline { bool PortableObjectPipeline::ImportAll ( [FLocTextHelper](API\Developer\Localization\FLocTextHelper) & InLocTextHelper, const [FString](API\Runtime\Core\Containers\FString) & InPOCultureRootPath, const [FString](API\Runtime\Core\Containers\FString) & InPOFilename, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat, const bool bUseCultureDirectory ) }
[]
PortableObjectPipeline::ParseBasicPOFileEntry
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Parse the basic data (msgctxt, msgid, msgstr) from a PO entry
Localization
namespace PortableObjectPipeline { void PortableObjectPipeline::ParseBasicPOFileEntry ( const [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) & POEntry, [FString](API\Runtime\Core\Containers\FString) & OutNamespace, [FString](API\Runtime\Core\Containers\FString) & OutKey, [FString](API\Runtime\Core\Containers\FString) & OutSourceString, [FString](API\Runtime\Core\Containers\FString) & OutTranslation, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat ) }
[]
PortableObjectPipeline::ParseIdentityFromPO
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Given the "msgctxt" or "msgid" field of a PO file, split it into the namespace and key
Localization
namespace PortableObjectPipeline { void PortableObjectPipeline::ParseIdentityFromPO ( const [FString](API\Runtime\Core\Containers\FString) & InIdentity, [FString](API\Runtime\Core\Containers\FString) & OutNamespace, [FString](API\Runtime\Core\Containers\FString) & OutKey ) }
[]
PortableObjectPipeline::UpdatePOFileHeaderForSettings
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Given the collapse mode and PO format, append any extra required meta-data to the PO file header
Localization
namespace PortableObjectPipeline { void PortableObjectPipeline::UpdatePOFileHeaderForSettings ( [FPortableObjectFormatDOM](API\Developer\Localization\FPortableObjectFormatDOM) & PortableObject, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat ) }
[]
PortableObjectPipeline::PopulateBasicPOFileEntry
/Engine/Source/Developer/Localization/Public/PortableObjectPipeline.h
Populate the basic data (msgctxt, msgid, msgstr) within a PO entry
Localization
namespace PortableObjectPipeline { void PortableObjectPipeline::PopulateBasicPOFileEntry ( [FPortableObjectEntry](API\Developer\Localization\FPortableObjectEntry) & POEntry, const [FString](API\Runtime\Core\Containers\FString) & InNamespace, const [FString](API\Runtime\Core\Containers\FString) & InKey, const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FLocMetadataObject](API\Runtime\Core\Internationalization\FLocMetadataObject) > & InKeyMetaData, const [FString](API\Runtime\Core\Containers\FString) & InSourceString, const [FString](API\Runtime\Core\Containers\FString) & InTranslation, const [ELocalizedTextCollapseMode](API\Developer\Localization\ELocalizedTextCollapseMode) InTextCollapseMode, const [EPortableObjectFormat](API\Developer\Localization\EPortableObjectFormat) InPOFormat ) }
[]
FJsonInternationalizationArchiveSerializer::DeserializeArchiveFromFile
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Deserializes an archive from a JSON file. true if deserialization was successful, false otherwise.
Localization
static bool DeserializeArchiveFromFile ( const [FString](API\Runtime\Core\Containers\FString) & InJsonFile, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )
[]
FJsonInternationalizationArchiveSerializer::DeserializeArchive
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Deserializes an archive from a JSON string. true if deserialization was successful, false otherwise.
Localization
static bool DeserializeArchive ( const [FString](API\Runtime\Core\Containers\FString) & InStr, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )
[]
FJsonInternationalizationArchiveSerializer::DeserializeArchive
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Deserializes an archive from a JSON object. true if deserialization was successful, false otherwise.
Localization
static bool DeserializeArchive ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )
[]
FJsonInternationalizationArchiveSerializer::DeserializeInternal
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Deserializes an archive from a JSON object. true if deserialization was successful, false otherwise.
Localization
static bool DeserializeInternal ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )
[]
FJsonInternationalizationArchiveSerializer::GenerateStructuredData
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Takes a Internationalization archive and arranges the data into a hierarchy based on namespace.
Localization
static void GenerateStructuredData ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FStructuredArchiveEntry](API\Developer\Localization\Serialization\FStructuredArchiveEntry) > RootElement )
[]
FJsonInternationalizationArchiveSerializer::JsonObjToArchive
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Recursive function that will traverse the JSON object and populate an archive. true if successful, false otherwise.
Localization
static bool JsonObjToArchive ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj, const [FString](API\Runtime\Core\Containers\FString) & ParentNamespace, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationManifest](API\Runtime\Core\Internationalization\FInternationalizationManifest) > InManifest, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InNativeArchive )
[]
NAMESPACE_DELIMITER
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Localization
static const [FString](API\Runtime\Core\Containers\FString) NAMESPACE_DELIMITER = TEXT(".");
[]
FJsonInternationalizationArchiveSerializer::SerializeArchive
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Serializes an archive to a JSON object. true if serialization was successful, false otherwise.
Localization
static bool SerializeArchive ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > InJsonObj )
[]
FJsonInternationalizationArchiveSerializer::SerializeArchive
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Serializes an archive to a JSON string. true if serialization was successful, false otherwise.
Localization
static bool SerializeArchive ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [FString](API\Runtime\Core\Containers\FString) & Str )
[]
FJsonInternationalizationArchiveSerializer::SerializeArchiveToFile
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Serializes an archive to a JSON string. true if serialization was successful, false otherwise.
Localization
static bool SerializeArchiveToFile ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, const [FString](API\Runtime\Core\Containers\FString) & InJsonFile )
[]
FJsonInternationalizationArchiveSerializer::SerializeInternal
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Convert a Internationalization archive to a JSON object. true if serialization was successful, false otherwise.
Localization
static bool SerializeInternal ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [FInternationalizationArchive](API\Runtime\Core\Internationalization\FInternationalizationArchive) > InArchive, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FJsonObject](API\Runtime\Json\Dom\FJsonObject) > JsonObj )
[]
FJsonInternationalizationArchiveSerializer::SortStructuredData
/Engine/Source/Developer/Localization/Public/Serialization/JsonInternationalizationArchiveSerializer.h
Goes through the structured, hierarchy based, archive data and does a non-culture specific sort on namespaces and default text.
Localization
static void SortStructuredData ( [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FStructuredArchiveEntry](API\Developer\Localization\Serialization\FStructuredArchiveEntry) > InElement )
[]