ILocalizationServiceProvider

Interface to talking with localization service providers.

Unreal Engine C++ API Reference > Developer > LocalizationService

Inheritance Hierarchy

References

   
Module LocalizationService
Header /Engine/Source/Developer/LocalizationService/Public/ILocalizationServiceProvider.h
Include #include "ILocalizationServiceProvider.h"

Syntax

class ILocalizationServiceProvider : public [IModularFeature](API\Runtime\Core\Features\IModularFeature)  

Remarks

Interface to talking with localization service providers.

Destructors

Type Name Description
  ~ILocalizationServiceProvider () Virtual destructor

Functions

Type Name Description
bool CanCancelOperation ( const TSharedRef< ILocalizationServ... ) Check to see if we can cancel an operation.
void CancelOperation ( const TSharedRef< ILocalizationServ... ) Attempt to cancel an operation in progress.
void Close () Shut down localization service provider.
void CustomizeSettingsDetails ( IDetailCategoryBuilder& DetailCate... ) Create a settings widget for display in the localization dashboard.
void CustomizeTargetDetails ( IDetailCategoryBuilder& DetailCate..., TWeakObjectPtr< ULocalizationTarget... ) Create a settings widget for display in the localization target editor.
void CustomizeTargetSetToolbar ( TSharedRef< FExtender >& MenuExten..., TWeakObjectPtr< ULocalizationTarget... ) Create a settings widget for display in the localization target set editor.
void CustomizeTargetToolbar ( TSharedRef< FExtender >& MenuExten..., TWeakObjectPtr< ULocalizationTarget... ) Create a settings widget for display in the localization target editor.
ELocalizatio... Execute ( const TSharedRef< ILocalizationServ..., const FLocalizationServiceTranslati..., const ELocalizationServiceOperation..., const FLocalizationServiceOperation... ) Helper overload for operation execution, see Execute().
ELocalizatio... Execute ( const TSharedRef< ILocalizationServ..., const TArray< FLocalizationServiceT..., ELocalizationServiceOperationConcur..., const FLocalizationServiceOperation... ) Attempt to execute an operation on the passed-in files (if any are required).
ELocalizatio... Execute ( const TSharedRef< ILocalizationServ..., const ELocalizationServiceOperation..., const FLocalizationServiceOperation... ) Helper overload for operation execution, see Execute().
const FText GetDisplayName () Get the localization service provider display name
const FName ... GetName () Get the localization service provider name
ELocalizatio... GetState ( const TArray< FLocalizationServiceT..., TArray< TSharedRef< ILocalizationSe..., ELocalizationServiceCacheUsage::Typ... ) Get the state of each of the passed-in files.
TSharedPtr< ... GetState ( const FLocalizationServiceTranslati..., ELocalizationServiceCacheUsage::Typ... ) Helper overload for state retrieval, see GetState().
FText GetStatusText () Get the localization service status as plain, human-readable text
void Init ( bool bForceConnection ) Initialize localization service provider.
bool IsAvailable () Quick check if localization service is available for use (server-based providers can use this to return whether the server is available or not)
bool IsEnabled () Quick check if localization service is enabled
ELocalizatio... Login ( const FString& InPassword, ELocalizationServiceOperationConcur..., const FLocalizationServiceOperation... ) Login to the localization service server (if any).
void Tick () Called every update.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library