UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FUnitSettings Class Reference

#include <UnitConversion.h>

Public Member Functions

CORE_API FUnitSettings ()
 
CORE_API bool ShouldDisplayUnits () const
 
CORE_API void SetShouldDisplayUnits (bool bInGlobalUnitDisplay)
 
CORE_API const TArray< EUnit > & GetDisplayUnits (EUnitType InType) const
 
CORE_API void SetDisplayUnits (EUnitType InType, const TArray< EUnit > &Units)
 
CORE_API void SetDisplayUnits (EUnitType InType, EUnit Units)
 
 DECLARE_EVENT (FUnitSettings, FDisplaySettingChanged)
 
FDisplaySettingChangedOnDisplaySettingsChanged ()
 

Detailed Description

Unit settings accessed globally through FUnitConversion::Settings()

Constructor & Destructor Documentation

◆ FUnitSettings()

FUnitSettings::FUnitSettings ( )

Member Function Documentation

◆ DECLARE_EVENT()

FUnitSettings::DECLARE_EVENT ( FUnitSettings  ,
FDisplaySettingChanged   
)

Returns an event delegate that is executed when a display setting has changed. (GlobalUnitDisplay or DefaultInputUnits)

◆ GetDisplayUnits()

const TArray< EUnit > & FUnitSettings::GetDisplayUnits ( EUnitType  InType) const

Get/Set the specific valid units to display the specified type of unit in

◆ OnDisplaySettingsChanged()

FDisplaySettingChanged & FUnitSettings::OnDisplaySettingsChanged ( )
inline

◆ SetDisplayUnits() [1/2]

void FUnitSettings::SetDisplayUnits ( EUnitType  InType,
const TArray< EUnit > &  Units 
)

◆ SetDisplayUnits() [2/2]

void FUnitSettings::SetDisplayUnits ( EUnitType  InType,
EUnit  Units 
)

◆ SetShouldDisplayUnits()

void FUnitSettings::SetShouldDisplayUnits ( bool  bInGlobalUnitDisplay)

◆ ShouldDisplayUnits()

bool FUnitSettings::ShouldDisplayUnits ( ) const

Check whether unit display is globally enabled or disabled


The documentation for this class was generated from the following files: