Misc

Windows
MacOS
Linux

Classes

Name

Description

Public class

DisplayClusterTypesConverter

Auxiliary class with different type conversion functions

Public class

FDisplayClusterActorRef

Public struct UStruct

FDisplayClusterComponentRef

Public class

FDisplayClusterSceneComponentRef

Constants

Functions

Name Description

Public function

constexpr si...

 

DisplayClusterHelpers::array::array_size

(
    const T
)

Helper for array size.

Public function

T

 

DisplayClusterHelpers::array::max

(
    const T* data,
    int size
)

Max element in array.

Public function

size_t

 

DisplayClusterHelpers::array::max_idx

(
    const T* data,
    int size
)

Max element's index in array.

Public function

T

 

DisplayClusterHelpers::array::min

(
    const T* data,
    int size
)

Min element in array.

Public function

size_t

 

DisplayClusterHelpers::array::min_idx

(
    const T* data,
    int size
)

Min element's index in array.

Public function Static

FString

 

DisplayClusterHelpers::filesystem::GetFullPathForConfig

(
    const FString& RelativeConfig
)

This helper function looks for a config file provided with relative path.

Public function Static

FString

 

DisplayClusterHelpers::filesystem::GetFullPathForConfigResource

(
    const FString& ResourcePath
)

Public function Static

void

 

DisplayClusterHelpers::game::FindAllActors

(
    UWorld* World,
    TArray< T* >& Out
)

Public function

bool

 

DisplayClusterHelpers::map::ExtractArrayFromString

(
    const TMap< FString, FString >& In...,
    const FString& InKey,
    TArray< TVal >& OutArray,
    const FString& InSeparator,
    bool bCullEmpty,
    ESearchCase::Type SearchCase
)

Extracts array from sting map value.

Public function

bool

 

DisplayClusterHelpers::map::ExtractMapFromString

(
    const TMap< FString, FString >& In...,
    const FString& InKey,
    TMap< TKey, TVal >& OutMap,
    const FString& InPairSeparator,
    const FString& InKeyValSeparator,
    ESearchCase::Type SearchCase
)

Extracts map from sting map value.

Public function

TVal

 

DisplayClusterHelpers::map::ExtractValue

(
    const TMap< FString, TVal >& InMap,
    const FString& InKey,
    const TVal& DefaultValue,
    ESearchCase::Type SearchCase
)

Extracts value from TMap, returns value if found, otherwise default value.

Public function

bool

 

DisplayClusterHelpers::map::ExtractValue

(
    const TMap< FString, TVal >& InMap,
    const FString& InKey,
    TVal& OutValue,
    ESearchCase::Type SearchCase
)

Extracts value from TMap, returns true if Ok.

Public function

TReturn

 

DisplayClusterHelpers::map::ExtractValueFromString

(
    const TMap< FString, FString >& In...,
    const FString& InKey,
    const TReturn& DefaultValue,
    ESearchCase::Type SearchCase
)

Extracts value from TMap and converts it to TReturn. If no value found, the default value is returned.

Public function

bool

 

DisplayClusterHelpers::map::ExtractValueFromString

(
    const TMap< FString, FString >& In...,
    const FString& InKey,
    TReturn& OutValue,
    ESearchCase::Type SearchCase
)

Extracts value from TMap, returns true and TReturn converted from string, otherwise false.

Public function Static

FString

 

DisplayClusterHelpers::str::ArrayToStr

(
    const TArray< T >& InData,
    const FString& InSeparator,
    bool bAddQuotes
)

Exports array data to a string Example: {item1, item2, item3, item4} => "item1,item2,item3,item4"

Public function Static

FString

 

DisplayClusterHelpers::str::BoolToStr

(
    bool bVal,
    bool bAsWord
)

Public function Static

bool

 

DisplayClusterHelpers::str::ExtractArray

(
    const FString& InLine,
    const FString& InParamName,
    const FString& InSeparator,
    TArray< TVal >& OutValue
)

Extracts array value either from a command line string or any other line that matches the same format Example: extracting array value of param2 "param1=value1 param2="a,b,c,d" param3=value3" => {a,b,c,d}

Public function Static

bool

 

DisplayClusterHelpers::str::ExtractMap

(
    const FString& InLine,
    const FString& InParamName,
    TMap< TKey, TVal >& OutData,
    const FString& InPairSeparator,
    const FString& InKeyValSeparator
)

Extracts map value either from a command line string or any other line that matches the same format Example: extracting map value of param2 "param1=value1 param2="a:1,b:7,c:22" param3=value3" => {{a,1},{b,7}{c,22}}

Public function Static

bool

 

DisplayClusterHelpers::str::ExtractValue

(
    const FString& InLine,
    const FString& InParamName,
    T& OutValue,
    bool bInTrimQuotes
)

Extracts value either from a command line string or any other line that matches the same format Example: extracting value of param2 "param1=value1 param2=value2 param3=value3" => value2

Public function

FString

 

DisplayClusterHelpers::str::MapToStr

(
    const TMap< TKey, TVal >& InData,
    const FString& InPairSeparator,
    const FString& InKeyValSeparator,
    bool bAddQuoutes
)

Exports map data to a string Example: {{key1,val1},{key2,val2},{key3,val3}} => "key1=val1 key2=val2 key3=var3"

Public function Static

void

 

DisplayClusterHelpers::str::StrToArray

(
    const FString& InData,
    const FString& InSeparator,
    TArray< TVal >& OutData,
    bool bCullEmpty
)

Parses string items separated by specified separator into array Example: item1, item2,item3 , item4 => {item1, item2, item3, item4}

Public function

void

 

DisplayClusterHelpers::str::StrToMap

(
    const FString& InData,
    TMap< TKey, TVal >& OutData,
    const FString& InPairSeparator,
    const FString& InKeyValSeparator
)

Parses string of key-value pairs separated by specified separator into map Example: "key1=val1 key2=val2 key3=val3" => {{key1, val2}, {key2, val2}, {key3, val3}}

Public function Static

void

 

DisplayClusterHelpers::str::TrimStringValue

(
    FString& InLine,
    bool bTrimQuotes
)

Public function Static

FString

 

DisplayClusterHelpers::str::TrimStringValue

(
    const FString& InLine,
    bool bTrimQuotes
)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss