UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FFormatArgumentData Struct Reference

#include <Text.h>

Public Member Functions

 FFormatArgumentData ()
 
CORE_API void ResetValue ()
 
CORE_API FFormatArgumentValue ToArgumentValue () const
 

Public Attributes

FString ArgumentName
 
TEnumAsByte< EFormatArgumentType::TypeArgumentValueType
 
FText ArgumentValue
 
int64 ArgumentValueInt
 
float ArgumentValueFloat
 
double ArgumentValueDouble
 
ETextGender ArgumentValueGender
 

Friends

void operator<< (FStructuredArchive::FSlot Slot, FFormatArgumentData &Value)
 

Detailed Description

Used to pass argument/value pairs into FText::Format via UKismetTextLibrary::Format.

Note
The primary consumer of this type is Blueprints (via a UHT mirror node). It is not expected that this be used in general C++ as FFormatArgumentValue is a much better type. The UHT struct is located here: Engine\Source\Runtime\Engine\Classes\Kismet\KismetTextLibrary.h

Used to pass argument/value pairs into FText::Format. The full C++ struct is located here: Engine\Source\Runtime\Core\Public\Internationalization\Text.h

Constructor & Destructor Documentation

◆ FFormatArgumentData()

FFormatArgumentData::FFormatArgumentData ( )
inline

Member Function Documentation

◆ ResetValue()

void FFormatArgumentData::ResetValue ( )

◆ ToArgumentValue()

FFormatArgumentValue FFormatArgumentData::ToArgumentValue ( ) const

Friends And Related Symbol Documentation

◆ operator<<

void operator<< ( FStructuredArchive::FSlot  Slot,
FFormatArgumentData Value 
)
friend

Member Data Documentation

◆ ArgumentName

FString FFormatArgumentData::ArgumentName

◆ ArgumentValue

FText FFormatArgumentData::ArgumentValue

◆ ArgumentValueDouble

double FFormatArgumentData::ArgumentValueDouble

◆ ArgumentValueFloat

float FFormatArgumentData::ArgumentValueFloat

◆ ArgumentValueGender

ETextGender FFormatArgumentData::ArgumentValueGender

◆ ArgumentValueInt

int64 FFormatArgumentData::ArgumentValueInt

◆ ArgumentValueType

TEnumAsByte< EFormatArgumentType::Type > FFormatArgumentData::ArgumentValueType

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