Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Core > Internationalization > FFormatArgumentData

Light Theme

Dark Theme

FFormatArgumentData

Used to pass argument/value pairs into [FText::Format](API\Runtime\Core\Internationalization\FText\Format\1) via [UKismetTextLibrary::Format](API\Runtime\Engine\Kismet\UKismetTextLibrary\Format).

Windows

MacOS

Linux

References

Module	Core
Header	/Engine/Source/Runtime/Core/Public/Internationalization/Text.h
Include	#include "Internationalization/Text.h"

Syntax

struct FFormatArgumentData

Remarks

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

Variables

	Name	Description
FString	ArgumentName
FText	ArgumentValue
float	ArgumentValueFloat
ETextGender	ArgumentValueGender
int32	ArgumentValueInt
TEnumAsByte< EF...	ArgumentValueType	This is a non-unioned version of FFormatArgumentValue that only accepts the types needed by Blueprints It's used as a marshaller to create a real FFormatArgumentValue when performing a format

Constructors

	Name	Description
	FFormatArgumentData()

Functions

		Name	Description
	void	ResetValue()
	FFormatArgum...	ToArgumentValue()

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss