UKismetStringLibrary

class Engine Blueprint Since unknown

Inherits: UObjectBase › UObjectBaseUtility › UObject › UBlueprintFunctionLibrary › UKismetStringLibrary

#include "Kismet/KismetStringLibrary.h"

Description

Blueprint function library exposing FString construction, conversion, and manipulation utilities. Provides the 'To String' conversion nodes, 'Build String' concatenation helpers, and the general string search/manipulation nodes used throughout Blueprint graphs.

Caveats & Gotchas

• All functions are static and BlueprintPure (with BlueprintThreadSafe on the class), so calling them has no side effects and they can run off the game thread — none of them are suitable for operations that need to happen in a specific order relative to game state changes.
• The 'To String' (Conv_*) nodes use BlueprintAutocast, meaning Blueprint automatically inserts them when you plug an incompatible type into a string pin — you often never see them explicitly in the graph even though they're doing the conversion.

Functions (77)

String 77

String

77 ▼

Access	Type	Name	Description
public	function	UKismetStringLibrary::Concat_StrStr	Concatenates two strings together, returning a new string equal to A+B.
public	function	UKismetStringLibrary::Contains	Returns whether SearchIn contains Substring, optionally searching case-sensitively and/or from the end.
public	function	UKismetStringLibrary::Conv_BoolToString	Converts a boolean value to the string 'true' or 'false'.
public	function	UKismetStringLibrary::Conv_DoubleToString	Converts a double-precision float value to its string representation.
public	function	UKismetStringLibrary::Conv_IntToString	Converts a 32-bit integer value to its string representation.
public	function	UKismetStringLibrary::Conv_NameToString	Converts an FName to its readable FString form.
public	function	UKismetStringLibrary::Conv_StringToDouble	Parses a string and returns the floating-point value it represents.
public	function	UKismetStringLibrary::Conv_StringToInt	Parses a string and returns the integer value it represents.
public	function	UKismetStringLibrary::Conv_StringToName	Converts a string to an FName.
public	function	UKismetStringLibrary::EndsWith	Tests whether a string ends with the given suffix.
public	function	UKismetStringLibrary::EqualEqual_StriStri	Tests whether two strings are equal, ignoring case.
public	function	UKismetStringLibrary::EqualEqual_StrStr	Tests whether two strings are exactly equal, including case.
public	function	UKismetStringLibrary::IsEmpty	Returns true if the string is empty (zero length).
public	function	UKismetStringLibrary::IsNumeric	Checks whether a string contains only numeric characters.
public	function	UKismetStringLibrary::Left	Returns the leftmost given number of characters from a string.
public	function	UKismetStringLibrary::LeftChop	Returns the leftmost characters of a string after removing the given number of characters from the end.
public	function	UKismetStringLibrary::Len	Returns the number of characters in the string.
public	function	UKismetStringLibrary::Mid	Returns the substring of a fixed length starting at a given position.
public	function	UKismetStringLibrary::NotEqual_StriStri	Tests whether two strings are not equal, ignoring case differences.
public	function	UKismetStringLibrary::NotEqual_StrStr	Tests whether two strings are not exactly equal, including case.
public	function	UKismetStringLibrary::Replace	Returns a new copy of a string with all occurrences of one substring replaced by another.
public	function	UKismetStringLibrary::Right	Returns the string counting back Count characters from the end.
public	function	UKismetStringLibrary::RightChop	Returns the string remaining after removing the given number of characters from the start.
public	function	UKismetStringLibrary::Split	Splits a string into a left and right part around the first (or last) occurrence of a delimiter.
public	function	UKismetStringLibrary::StartsWith	Tests whether a string begins with the given prefix.
public	function	UKismetStringLibrary::ToLower	Returns a copy of SourceString converted to lower case.
public	function	UKismetStringLibrary::ToUpper	Returns a copy of SourceString converted to upper case.
public	function	UKismetStringLibrary::Trim	Removes whitespace characters from the front of a string.
public	function	UKismetStringLibrary::TrimTrailing	Removes whitespace characters from the end of a string, leaving the front untouched.
public	function	UKismetStringLibrary::BuildString_Bool	Builds a new string in the form AppendTo+Prefix+InBool+Suffix, rendering the boolean as the literal word 'true' or 'false' between the given prefix and suffix.
public	function	UKismetStringLibrary::BuildString_Color	Builds a new string in the form AppendTo+Prefix+InColor+Suffix, formatting the color between the given prefix and suffix.
public	function	UKismetStringLibrary::BuildString_Double	Builds a new string in the form AppendTo+Prefix+InDouble+Suffix by formatting a double value and concatenating it between the given prefix and suffix.
public	function	UKismetStringLibrary::BuildString_Int	Builds a new string in the form AppendTo+Prefix+InInt+Suffix, formatting an integer and concatenating it between the given prefix and suffix.
public	function	UKismetStringLibrary::BuildString_IntVector	Builds a new string in the form AppendTo+Prefix+InIntVector+Suffix, formatting an FIntVector with the standard ToString conversion between the given prefix and suffix.
public	function	UKismetStringLibrary::BuildString_Name	Builds a new string in the form AppendTo+Prefix+InName+Suffix, inserting the name's string representation between the prefix and suffix.
public	function	UKismetStringLibrary::BuildString_Object	Builds a new string in the form AppendTo+Prefix+object name+Suffix, inserting the object's name between the prefix and suffix.
public	function	UKismetStringLibrary::BuildString_Rotator	Builds a new string in the form AppendTo+Prefix+InRot+Suffix, formatting the rotator between the given prefix and suffix.
public	function	UKismetStringLibrary::BuildString_Vector	Builds a new string in the form AppendTo+Prefix+InVector+Suffix, formatting the vector with the standard FVector::ToString conversion between the given prefix and suffix.
public	function	UKismetStringLibrary::BuildString_Vector2d	Builds a new string in the form AppendTo+Prefix+InVector2d+Suffix, formatting an FVector2D with the standard ToString conversion between the given prefix and suffix.
public	function	UKismetStringLibrary::Conv_ByteToString	Converts a byte (uint8) value to its string representation.
public	function	UKismetStringLibrary::Conv_ColorToString	Converts a linear color to a string in the form '(R=,G=,B=,A=)'.
public	function	UKismetStringLibrary::Conv_Int64ToString	Converts a 64-bit integer value to its string representation.
public	function	UKismetStringLibrary::Conv_IntPointToString	Converts an FIntPoint to a string in the form 'X= Y='.
public	function	UKismetStringLibrary::Conv_IntVectorToString	Converts an FIntVector to a string in the form 'X= Y= Z='.
public	function	UKismetStringLibrary::Conv_ObjectToString	Converts a UObject reference to a string by calling the object's GetName() method.
public	function	UKismetStringLibrary::Conv_RotatorToString	Converts an FRotator to a string in the form 'P= Y= R='.
public	function	UKismetStringLibrary::Conv_StringToColor	Parses a string in the '(R=,G=,B=,A=)' format back into an FLinearColor, reporting whether parsing succeeded via OutIsValid.
public	function	UKismetStringLibrary::Conv_StringToInt64	Parses a string and returns the 64-bit integer value it represents.
public	function	UKismetStringLibrary::Conv_StringToRotator	Parses a string in the 'P= Y= R=' format produced by rotator-to-string conversion back into an FRotator, reporting whether parsing succeeded via OutIsValid.
public	function	UKismetStringLibrary::Conv_StringToVector	Parses a string in the 'X= Y= Z=' format produced by Conv_VectorToString back into an FVector, reporting whether parsing succeeded via OutIsValid.
public	function	UKismetStringLibrary::Conv_StringToVector2D	Parses a string in the 'X= Y=' format back into an FVector2D, reporting whether parsing succeeded via OutIsValid.
public	function	UKismetStringLibrary::Conv_TransformToString	Converts an FTransform to a string in the form 'Translation: X= Y= Z= Rotation: P= Y= R= Scale: X= Y= Z='.
public	function	UKismetStringLibrary::Conv_Vector2dToString	Converts an FVector2D to a string in the form 'X= Y='.
public	function	UKismetStringLibrary::Conv_VectorToString	Converts an FVector to a string in the form 'X= Y= Z='.
public	function	UKismetStringLibrary::CullArray	Removes zero-length entries from an array of strings in place and returns the resulting element count.
public	function	UKismetStringLibrary::FindSubstring	Finds the starting index of Substring within SearchIn, optionally searching case-sensitively and/or backward from the end.
public	function	UKismetStringLibrary::GetCharacterAsNumber	Gets a single character from SourceString at Index and returns its integer character-code value.
public	function	UKismetStringLibrary::GetSubstring	Returns a substring from SourceString starting at StartIndex and spanning Length characters.
public	function	UKismetStringLibrary::JoinStringArray	Concatenates all elements of SourceArray into a single string, inserting Separator between each element.
public	function	UKismetStringLibrary::LeftPad	Pads the left side of a string with spaces until it reaches the given total length.
public	function	UKismetStringLibrary::MatchesWildcard	Tests a string against a simple ?-style wildcard pattern, where matches any run of characters and ? matches a single character.
public	function	UKismetStringLibrary::ParseIntoArray	Splits SourceString into an array of substrings wherever Delimiter occurs, optionally culling empty entries produced by consecutive delimiters.
public	function	UKismetStringLibrary::ReplaceInline	Replaces all occurrences of SearchText with ReplacementText directly in SourceString and returns how many replacements were made.
public	function	UKismetStringLibrary::Reverse	Returns a copy of a string with its characters in reverse order.
public	function	UKismetStringLibrary::RightPad	Pads the right side of a string with spaces until it reaches the given total length.
public	function	UKismetStringLibrary::TimeSecondsToString	Converts a number of seconds into a minutes:seconds.
public	function	UKismetStringLibrary::BuildString_IntVector2	Builds a new string in the form AppendTo+Prefix+InIntVector+Suffix, formatting an FIntVector2 with the standard ToString conversion between the given prefix and suffix.
public	function	UKismetStringLibrary::Conv_BoxCenterAndExtentsToString	Converts an FBox to a string showing its computed Center and Extent values rather than raw Min/Max corners.
public	function	UKismetStringLibrary::Conv_BoxToString	Converts an FBox to a string using FBox's default ToString formatting, printing its Min and Max corner vectors.
public	function	UKismetStringLibrary::Conv_InputDeviceIdToString	Converts an FInputDeviceId (identifying a physical input device such as a gamepad) to its string representation.
public	function	UKismetStringLibrary::Conv_IntVector2ToString	Converts an FIntVector2 to a string in the form 'X= Y='.
public	function	UKismetStringLibrary::Conv_MatrixToString	Converts a 4x4 transformation matrix to a multi-line string dump of all sixteen components.
public	function	UKismetStringLibrary::Conv_PlatformUserIdToString	Converts a platform user ID to its string representation, showing the underlying integer handle.
public	function	UKismetStringLibrary::Conv_StringToVector3f	Parses a string in the 'X= Y= Z=' format back into a single-precision FVector3f, reporting whether parsing succeeded via OutIsValid.
public	function	UKismetStringLibrary::Conv_Vector3fToString	Converts an FVector3f (single-precision vector) to a string in the form 'X= Y= Z='.
public	function	UKismetStringLibrary::DiffString	Returns a human-readable description of the line-based LCS (longest common subsequence) difference between two strings, marking modifications, removals, and additions with ~, -, and + symbols.
public	function	UKismetStringLibrary::GetCharacterArrayFromString	Returns an array containing one single-character string entry for each character in SourceString.

Version History

Introduced in: unknown

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?