UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
KismetStringLibrary.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "CoreMinimal.h"
6#include "UObject/ObjectMacros.h"
7#include "Kismet/BlueprintFunctionLibrary.h"
8#include "KismetStringLibrary.generated.h"
9
10UCLASS(meta=(BlueprintThreadSafe, ScriptName="StringLibrary"), MinimalAPI)
11class UKismetStringLibrary : public UBlueprintFunctionLibrary
12{
13 GENERATED_UCLASS_BODY()
14
15
16 UFUNCTION(BlueprintPure, meta = (DisplayName = "To String (Float)", CompactNodeTitle = "->", BlueprintAutocast), Category = "Utilities|String")
17 static ENGINE_API FString Conv_DoubleToString(double InDouble);
18
20 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Integer)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
21 static ENGINE_API FString Conv_IntToString(int32 InInt);
22
24 UFUNCTION(BlueprintPure, meta = (DisplayName = "To String (Integer64)", CompactNodeTitle = "->", BlueprintAutocast), Category = "Utilities|String")
25 static ENGINE_API FString Conv_Int64ToString(int64 InInt);
26
28 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Byte)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
29 static ENGINE_API FString Conv_ByteToString(uint8 InByte);
30
32 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Boolean)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
33 static ENGINE_API FString Conv_BoolToString(bool InBool);
34
36 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Vector)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
37 static ENGINE_API FString Conv_VectorToString(FVector InVec);
38
40 UFUNCTION(BlueprintPure, meta = (DisplayName = "To String (Float Vector)", CompactNodeTitle = "->", BlueprintAutocast), Category = "Utilities|String")
41 static ENGINE_API FString Conv_Vector3fToString(FVector3f InVec);
42
44 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (IntVector)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
45 static ENGINE_API FString Conv_IntVectorToString(FIntVector InIntVec);
46
48 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (IntVector2)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
49 static ENGINE_API FString Conv_IntVector2ToString(FIntVector2 InIntVec2);
50
52 UFUNCTION(BlueprintPure, meta = (DisplayName = "To String (IntPoint)", CompactNodeTitle = "->", BlueprintAutocast), Category = "Utilities|String")
53 static ENGINE_API FString Conv_IntPointToString(FIntPoint InIntPoint);
54
56 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Vector2d)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
57 static ENGINE_API FString Conv_Vector2dToString(FVector2D InVec);
58
60 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Rotator)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
61 static ENGINE_API FString Conv_RotatorToString(FRotator InRot);
62
64 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Transform)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
65 static ENGINE_API FString Conv_TransformToString(const FTransform& InTrans);
66
68 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Object)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
69 static ENGINE_API FString Conv_ObjectToString(class UObject* InObj);
70
72 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Box)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
73 static ENGINE_API FString Conv_BoxToString(const FBox& Box);
74
76 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String Center and Extents (Box)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
77 static ENGINE_API FString Conv_BoxCenterAndExtentsToString(const FBox& Box);
78
80 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (InputDeviceId)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
81 static ENGINE_API FString Conv_InputDeviceIdToString(FInputDeviceId InDeviceId);
82
84 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (PlatformUserId)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
85 static ENGINE_API FString Conv_PlatformUserIdToString(FPlatformUserId InPlatformUserId);
86
88 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (LinearColor)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
89 static ENGINE_API FString Conv_ColorToString(FLinearColor InColor);
90
92 UFUNCTION(BlueprintPure, meta=(DisplayName = "To String (Name)", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
93 static ENGINE_API FString Conv_NameToString(FName InName);
94
96 UFUNCTION(BlueprintPure, meta = (DisplayName = "To String (Matrix)", CompactNodeTitle = "->", BlueprintAutocast), Category = "Utilities|String")
97 static ENGINE_API FString Conv_MatrixToString(const FMatrix& InMatrix);
98
100 UFUNCTION(BlueprintPure, meta=(DisplayName = "String To Name", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
101 static ENGINE_API FName Conv_StringToName(const FString& InString);
102
104 UFUNCTION(BlueprintPure, meta=(DisplayName = "String To Integer", CompactNodeTitle = "->", BlueprintAutocast), Category="Utilities|String")
105 static ENGINE_API int32 Conv_StringToInt(const FString& InString);
106
108 UFUNCTION(BlueprintPure, meta = (DisplayName = "String To Integer64", CompactNodeTitle = "->", BlueprintAutocast), Category = "Utilities|String")
109 static ENGINE_API int64 Conv_StringToInt64(const FString& InString);
110
112 UFUNCTION(BlueprintPure, meta = (DisplayName = "String To Float", CompactNodeTitle = "->", BlueprintAutocast), Category = "Utilities|String")
113 static ENGINE_API double Conv_StringToDouble(const FString& InString);
114
116 UFUNCTION(BlueprintPure, meta=(DisplayName = "String To Vector", CompactNodeTitle = "->"), Category="Utilities|String")
117 static ENGINE_API void Conv_StringToVector(const FString& InString, FVector& OutConvertedVector, bool& OutIsValid);
118
120 UFUNCTION(BlueprintPure, meta = (DisplayName = "String To Float Vector", CompactNodeTitle = "->"), Category = "Utilities|String")
121 static ENGINE_API void Conv_StringToVector3f(const FString& InString, FVector3f& OutConvertedVector, bool& OutIsValid);
122
124 UFUNCTION(BlueprintPure, meta=(DisplayName = "String To Vector2D", CompactNodeTitle = "->"), Category="Utilities|String")
125 static ENGINE_API void Conv_StringToVector2D(const FString& InString, FVector2D& OutConvertedVector2D, bool& OutIsValid);
126
128 UFUNCTION(BlueprintPure, meta=(DisplayName = "String To Rotator", CompactNodeTitle = "->"), Category="Utilities|String")
129 static ENGINE_API void Conv_StringToRotator(const FString& InString, FRotator& OutConvertedRotator, bool& OutIsValid);
130
132 UFUNCTION(BlueprintPure, meta=(DisplayName = "String To Color", CompactNodeTitle = "->"), Category="Utilities|String")
133 static ENGINE_API void Conv_StringToColor(const FString& InString, FLinearColor& OutConvertedColor, bool& OutIsValid);
134
143 UFUNCTION(BlueprintPure, meta = (DisplayName = "Build String (Float)"), Category = "Utilities|String")
144 static ENGINE_API FString BuildString_Double(const FString& AppendTo, const FString& Prefix, double InDouble, const FString& Suffix);
145
154 UFUNCTION(BlueprintPure, meta=(DisplayName = "Build String (Integer)"), Category="Utilities|String")
155 static ENGINE_API FString BuildString_Int(const FString& AppendTo, const FString& Prefix, int32 InInt, const FString& Suffix);
156
165 UFUNCTION(BlueprintPure, meta=(DisplayName = "Build String (Boolean)"), Category="Utilities|String")
166 static ENGINE_API FString BuildString_Bool(const FString& AppendTo, const FString& Prefix, bool InBool, const FString& Suffix);
167
176 UFUNCTION(BlueprintPure, meta=(DisplayName = "Build String (Vector)"), Category="Utilities|String")
177 static ENGINE_API FString BuildString_Vector(const FString& AppendTo, const FString& Prefix, FVector InVector, const FString& Suffix);
178
187 UFUNCTION(BlueprintPure, meta = (DisplayName = "Build String (IntVector)"), Category = "Utilities|String")
188 static ENGINE_API FString BuildString_IntVector(const FString& AppendTo, const FString& Prefix, FIntVector InIntVector2, const FString& Suffix);
189
198 UFUNCTION(BlueprintPure, meta = (DisplayName = "Build String (IntVector2)"), Category = "Utilities|String")
199 static ENGINE_API FString BuildString_IntVector2(const FString& AppendTo, const FString& Prefix, FIntVector2 InIntVector, const FString& Suffix);
200
209 UFUNCTION(BlueprintPure, meta=(DisplayName = "Build String (Vector2D)"), Category="Utilities|String")
210 static ENGINE_API FString BuildString_Vector2d(const FString& AppendTo, const FString& Prefix, FVector2D InVector2d, const FString& Suffix);
211
220 UFUNCTION(BlueprintPure, meta=(DisplayName = "Build String (Rotator)"), Category="Utilities|String")
221 static ENGINE_API FString BuildString_Rotator(const FString& AppendTo, const FString& Prefix, FRotator InRot, const FString& Suffix);
222
231 UFUNCTION(BlueprintPure, meta=(DisplayName = "Build String (Object)"), Category="Utilities|String")
232 static ENGINE_API FString BuildString_Object(const FString& AppendTo, const FString& Prefix, class UObject* InObj, const FString& Suffix);
233
242 UFUNCTION(BlueprintPure, meta=(DisplayName = "Build String (LinearColor)"), Category="Utilities|String")
243 static ENGINE_API FString BuildString_Color(const FString& AppendTo, const FString& Prefix, FLinearColor InColor, const FString& Suffix);
244
253 UFUNCTION(BlueprintPure, meta=(DisplayName = "Build String (Name)"), Category="Utilities|String")
254 static ENGINE_API FString BuildString_Name(const FString& AppendTo, const FString& Prefix, FName InName, const FString& Suffix);
255
256
257 //
258 // String functions.
259 //
260
267 UFUNCTION(BlueprintPure, meta=(DisplayName = "Append", CommutativeAssociativeBinaryOperator = "true"), Category="Utilities|String")
268 static ENGINE_API FString Concat_StrStr(const FString& A, const FString& B);
269
276 UFUNCTION(BlueprintPure, meta=(DisplayName = "Equal Exactly (String)", CompactNodeTitle = "==="), Category="Utilities|String")
277 static ENGINE_API bool EqualEqual_StrStr(const FString& A, const FString& B);
278
285 UFUNCTION(BlueprintPure, meta=(DisplayName = "Equal, Case Insensitive (String)", CompactNodeTitle = "=="), Category="Utilities|String")
286 static ENGINE_API bool EqualEqual_StriStri(const FString& A, const FString& B);
287
294 UFUNCTION(BlueprintPure, meta=(DisplayName = "Not Equal Exactly (String)", CompactNodeTitle = "!=="), Category="Utilities|String")
295 static ENGINE_API bool NotEqual_StrStr(const FString& A, const FString& B);
296
302 UFUNCTION(BlueprintPure, meta=(DisplayName = "Not Equal, Case Insenstive (String)", CompactNodeTitle = "!="), Category="Utilities|String")
303 static ENGINE_API bool NotEqual_StriStri(const FString& A, const FString& B);
304
310 UFUNCTION(BlueprintPure, Category="Utilities|String", meta=(CompactNodeTitle = "LEN", Keywords = "length"))
311 static ENGINE_API int32 Len(const FString& S);
312
318 UFUNCTION(BlueprintPure, Category="Utilities|String", meta=(Keywords = "empty"))
319 static ENGINE_API bool IsEmpty(const FString& InString);
320
329 UFUNCTION(BlueprintPure, Category="Utilities|String")
330 static ENGINE_API FString GetSubstring(const FString& SourceString, int32 StartIndex = 0, int32 Length = 1);
331
341 UFUNCTION(BlueprintPure, Category = "Utilities|String")
342 static ENGINE_API int32 FindSubstring(const FString& SearchIn, const FString& Substring, bool bUseCase = false, bool bSearchFromEnd = false, int32 StartPosition = -1);
343
352 UFUNCTION(BlueprintPure, Category = "Utilities|String")
353 static ENGINE_API bool Contains(const FString& SearchIn, const FString& Substring, bool bUseCase = false, bool bSearchFromEnd = false);
354
361 UFUNCTION(BlueprintPure, Category="Utilities|String")
362 static ENGINE_API int32 GetCharacterAsNumber(const FString& SourceString, int32 Index = 0);
363
371 UFUNCTION(BlueprintPure, Category="Utilities|String")
372 static ENGINE_API TArray<FString> ParseIntoArray(const FString& SourceString, const FString& Delimiter = FString(TEXT(" ")), const bool CullEmptyStrings = true);
373
380 UFUNCTION(BlueprintPure, Category="Utilities|String")
381 static ENGINE_API FString JoinStringArray(const TArray<FString>& SourceArray, const FString& Separator = FString(TEXT(" ")));
382
388 UFUNCTION(BlueprintPure, Category = "Utilities|String")
389 static ENGINE_API TArray<FString> GetCharacterArrayFromString(const FString& SourceString);
390
396 UFUNCTION(BlueprintPure, Category="Utilities|String")
397 static ENGINE_API FString ToUpper(const FString& SourceString);
398
404 UFUNCTION(BlueprintPure, Category = "Utilities|String")
405 static ENGINE_API FString ToLower(const FString& SourceString);
406
407 /*
408 * Pad the left of this string for a specified number of characters
409 * @param SourceString The string to pad
410 * @param ChCount Amount of padding required
411 * @return The padded string
412 */
413 UFUNCTION(BlueprintPure, Category = "Utilities|String")
414 static ENGINE_API FString LeftPad(const FString& SourceString, int32 ChCount);
415
416 /*
417 * Pad the right of this string for a specified number of characters
418 * @param SourceString The string to pad
419 * @param ChCount Amount of padding required
420 * @return The padded string
421 */
422 UFUNCTION(BlueprintPure, Category = "Utilities|String")
423 static ENGINE_API FString RightPad(const FString& SourceString, int32 ChCount);
424
425 /*
426 * Checks if a string contains only numeric characters
427 * @param SourceString The string to check
428 * @return true if the string only contains numeric characters
429 */
430 UFUNCTION(BlueprintPure, Category = "Utilities|String")
431 static ENGINE_API bool IsNumeric(const FString& SourceString);
432
439 UFUNCTION(BlueprintPure, Category = "Utilities|String")
440 static ENGINE_API bool StartsWith(const FString& SourceString, const FString& InPrefix, ESearchCase::Type SearchCase = ESearchCase::IgnoreCase);
441
448 UFUNCTION(BlueprintPure, Category = "Utilities|String")
449 static ENGINE_API bool EndsWith(const FString& SourceString, const FString& InSuffix, ESearchCase::Type SearchCase = ESearchCase::IgnoreCase);
450
459 UFUNCTION(BlueprintPure, Category = "Utilities|String")
460 static ENGINE_API bool MatchesWildcard(const FString& SourceString, const FString& Wildcard, ESearchCase::Type SearchCase = ESearchCase::IgnoreCase);
461
465 UFUNCTION(BlueprintPure, Category = "Utilities|String")
466 static ENGINE_API FString Trim(const FString& SourceString);
467
471 UFUNCTION(BlueprintPure, Category = "Utilities|String")
472 static ENGINE_API FString TrimTrailing(const FString& SourceString);
473
481 UFUNCTION(BlueprintPure, Category = "Utilities|String")
482 static ENGINE_API int32 CullArray(const FString& SourceString, TArray<FString>& InArray);
483
487 UFUNCTION(BlueprintPure, Category = "Utilities|String")
488 static ENGINE_API FString Reverse(const FString& SourceString);
489
498 UFUNCTION(BlueprintPure, Category = "Utilities|String")
499 static ENGINE_API FString Replace(const FString& SourceString, const FString& From, const FString& To, ESearchCase::Type SearchCase = ESearchCase::IgnoreCase);
500
510 UFUNCTION(BlueprintCallable, Category = "Utilities|String")
511 static ENGINE_API int32 ReplaceInline(UPARAM(ref) FString& SourceString, const FString& SearchText, const FString& ReplacementText, ESearchCase::Type SearchCase = ESearchCase::IgnoreCase);
512
523 UFUNCTION(BlueprintPure, Category = "Utilities|String")
524 static ENGINE_API bool Split(const FString& SourceString, const FString& InStr, FString& LeftS, FString& RightS, ESearchCase::Type SearchCase = ESearchCase::IgnoreCase, ESearchDir::Type SearchDir = ESearchDir::FromStart);
525
527 UFUNCTION(BlueprintPure, Category = "Utilities|String")
528 static ENGINE_API FString Left(const FString& SourceString, int32 Count);
529
531 UFUNCTION(BlueprintPure, Category = "Utilities|String")
532 static ENGINE_API FString LeftChop(const FString& SourceString, int32 Count);
533
535 UFUNCTION(BlueprintPure, Category = "Utilities|String")
536 static ENGINE_API FString Right(const FString& SourceString, int32 Count);
537
539 UFUNCTION(BlueprintPure, Category = "Utilities|String")
540 static ENGINE_API FString RightChop(const FString& SourceString, int32 Count);
541
543 UFUNCTION(BlueprintPure, Category = "Utilities|String")
544 static ENGINE_API FString Mid(const FString& SourceString, int32 Start, int32 Count);
545
546#if WITH_EDITOR
567 UFUNCTION(BlueprintCallable, Category = "Utilities|String")
568 static ENGINE_API FString DiffString(const FString& First, const FString& Second);
569#endif // WITH_EDITOR
570
576 UFUNCTION(BlueprintPure, Category = "Utilities|String")
577 static ENGINE_API FString TimeSecondsToString(float InSeconds);
578};
TEXT
#define TEXT(x)
Definition Platform.h:1272
int64
FPlatformTypes::int64 int64
A 64-bit signed integer.
Definition Platform.h:1127
int32
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
UPARAM
#define UPARAM(...)
Definition ObjectMacros.h:748
UFUNCTION
#define UFUNCTION(...)
Definition ObjectMacros.h:745
GENERATED_UCLASS_BODY
#define GENERATED_UCLASS_BODY(...)
Definition ObjectMacros.h:768
UCLASS
#define UCLASS(...)
Definition ObjectMacros.h:776
Split
#define Split(a, ahi, alo)
Definition Predicates.inl:204
uint8
uint8_t uint8
Definition binka_ue_file_header.h:8
FName
Definition NameTypes.h:617
TArray
Definition Array.h:670
UBlueprintFunctionLibrary
Definition BlueprintFunctionLibrary.h:16
UKismetStringLibrary
Definition KismetStringLibrary.h:12
UObject
Definition Object.h:95
ESearchCase::Type
Type
Definition CString.h:21
ESearchCase::IgnoreCase
@ IgnoreCase
Definition CString.h:26
ESearchDir::Type
Type
Definition CString.h:34
ESearchDir::FromStart
@ FromStart
Definition CString.h:36
Index
U16 Index
Definition radfft.cpp:71
FInputDeviceId
Definition CoreMiscDefines.h:524
FLinearColor
Definition Color.h:48
FPlatformUserId
Definition CoreMiscDefines.h:470
UE::Math::TIntPoint
Definition IntPoint.h:25