Core

2 views

178 entries in this module.

class Classes (2)

FString Unreal Engine's general-purpose heap-allocated string class. TArray BP The primary dynamic array container in Unreal Engine, equivalent to `std::vector`.

struct Structs (10)

FMath The primary math utility struct in Unreal Engine, providing static functions for arithmetic, interpolation, trigonometry, random number generation, and geometric operations. FName An immutable, case-insensitive string stored in a global name table and identified by an integer index. FText A localizable string that carries culture-aware display data. FVector BP A 3D vector with double-precision (UE 5. TMap An associative container that maps unique keys to values. TOptional A value container that may or may not hold a value of type T, analogous to std::optional. TSet An unordered container of unique elements backed by a hash set. TSharedPtr A non-intrusive reference-counted smart pointer for non-UObject types. TSharedRef A non-nullable, non-intrusive reference-counted smart pointer for non-UObject types. TWeakPtr A non-intrusive weak reference to an object managed by TSharedPtr/TSharedRef.

function Global Functions (150)

FMath: MIX_FLOATS_2_ARGS Preprocessor macro that injects a two-argument template overload for mixing float/double/integral argument types, promoting all arguments to the highest-precision floating-point type. FMath: MIX_FLOATS_3_ARGS Preprocessor macro that injects a template overload for a three-argument function, allowing mixed float/double/integral argument lists by promoting all arguments to the highest-precision floating-point type among them. FMath: RESOLVE_FLOAT_AMBIGUITY_3_ARGS Preprocessor macro that currently expands to MIX_FLOATS_3_ARGS, injecting mixed float/double overloads for a three-argument function to eliminate compiler ambiguity errors when argument types differ. FMath: UE_REQUIRES Preprocessor macro that wraps a C++20 requires-clause (or a SFINAE equivalent on older standards) to constrain template overloads inside FMath and other UE template-heavy code. FMath::Abs Returns the absolute (non-negative) value of A. FMath::ApplyScaleToFloat Applies a 3D scale delta to a single float in-place, intended for editor gizmo interactions where dragging a uniform scale handle should affect scalar properties. FMath::Atan2 Returns the angle in radians between the positive X axis and the point (X, Y), in the range [-π, π]. FMath::CartesianToPolar Converts a 2D Cartesian coordinate pair to polar form (radius and angle). FMath::Clamp Clamps a value between a minimum and maximum, inclusive on both ends. FMath::Cos Returns the cosine of an angle given in radians. FMath::CriticallyDampedSmoothing Smooths a value using a critically-damped spring, tracking both position and velocity. FMath::DegreesToRadians Converts an angle from degrees to radians by multiplying by π/180. FMath::Eval Evaluates a mathematical expression from a string at runtime. FMath::ExponentialSmoothingApprox Smooths a value towards a target using an exponential decay approximation. FMath::FInterpTo Smoothly moves a float toward a target value at a given speed, independent of frame rate. FMath::GetDotDistance Computes the dot-distance of a direction vector relative to a coordinate system, returning the cosine of azimuth and sine of elevation. FMath::GetMappedRangeValueClamped Maps a value from one range to another, clamping the input to the source range first. FMath::IsNearlyEqual Returns true if two floating-point numbers are within a given absolute tolerance of each other. FMath::IsNearlyZero Returns true if a floating-point value is within ErrorTolerance of zero. FMath::Lerp Linearly interpolates between two values. FMath::LineExtentBoxIntersection Performs a swept-box versus axis-aligned box intersection test and returns the hit location, normal, and parametric hit time. FMath::PointDistToLine Returns the perpendicular distance from a point to an infinite line defined by an origin and a direction. FMath::PolarToCartesian Converts polar coordinates (radius and angle in radians) to a 2D Cartesian coordinate pair. FMath::RadiansToDegrees Converts an angle from radians to degrees by multiplying by 180/π. FMath::RandRange Returns a random integer in the inclusive range [Min, Max]. FMath::SegmentDistToSegment Finds the closest pair of points between two 3D line segments. FMath::SegmentDistToSegmentSafe Safe variant of SegmentDistToSegment that handles degenerate zero-length segments without undefined behaviour. FMath::SegmentIntersection2D Tests whether two 3D segments intersect when projected onto the XY plane and returns the intersection point. FMath::SegmentPlaneIntersection Tests whether a line segment intersects a plane and returns the intersection point. FMath::SegmentTriangleIntersection Tests whether a line segment intersects a triangle and returns both the intersection point and the triangle's face normal. FMath::SetBoolInBitField Sets or clears a single bit by index within a packed bitfield represented as a uint8 array. FMath::Sin Returns the sine of an angle given in radians. FMath::SinCos Computes both sine and cosine of an angle simultaneously. FMath::SphereDistToLine Finds the closest point on a sphere's surface to an infinite line. FMath::SpringDamper Full spring-damper simulation supporting under-, over-, and critically-damped motion. FMath::SpringDamperSmoothing Convenience wrapper around SpringDamper that accepts a SmoothingTime instead of a frequency, matching the CriticallyDampedSmoothing API but adding a tunable damping ratio. FMath::Sqrt Returns the square root of Value. FMath::Square Returns A * A. FMath::VInterpTo Smoothly moves an FVector toward a target vector at a given speed, independently on each axis, frame-rate-independently. FMath::WindRelativeAnglesDegrees Adjusts InOutAngle1 so that the difference between it and InAngle0 is at most 180 degrees, preventing large jumps when interpolating rotation components converted from quaternions. FName::AppendString Appends the full name string (including numeric suffix) to an existing FString or string builder without creating an intermediate FString allocation. FName::DisplayHash Dumps name-table hash bucket statistics to an output device. FName::FindNumberedName Looks up an already-registered numbered FName without creating a new entry. FName::GetPlainANSIString Copies the name string without its numeric suffix into a fixed-size ANSI character buffer. FName::GetPlainNameString Returns the name string without its numeric suffix as a dynamically allocated FString. FName::GetPlainWIDEString Copies the name string without its numeric suffix into a fixed-size wide character buffer. FName::IsValidGroupName Validates that this FName is legal for use as a package or group name. FName::IsValidObjectName Checks that this FName is a legal UObject name: non-empty, free of invalid characters, and within the maximum name length. FName::IsValidXName Validates that a name does not contain any of the specified forbidden characters. FName::Reserve Pre-allocates memory in the global FName table to reduce reallocations during bulk name registration. FName::SetNumber Changes the numeric suffix of an FName without altering its string part. FName::ToString Converts the FName to a human-readable FString including the numeric suffix if present. FName::ToStringTruncate Converts the FName to a TCHAR buffer without heap allocation, truncating the result if the buffer is too small. FName::TraceNamesOnConnection Emits all currently registered FNames to the Unreal Insights trace channel when a new profiler connection is established. FName::TryAppendAnsiString Converts this FName to its string representation and appends it to an ANSI string builder. FString::Contains Returns true if this string contains the specified substring. FString::EndsWith Returns true if this string ends with the specified suffix. FString::Format Builds a string by substituting {Name} or {0}/{1}/. FString::Printf Constructs a new FString using printf-style format specifiers. FString::StartsWith Returns true if this string begins with the specified prefix. FString::ToLower Returns a new FString with all characters converted to lowercase. FString::ToUpper Returns a new FString with all characters converted to uppercase. FText::AutoRTFMAssignFromOpenToClosed AutoRTFM helper that assigns an FText created outside a transaction (open) into a variable that lives inside a transaction (closed), ensuring the shared ref-counted data is handled safely under AutoRTFM. FText::FindTextInLiveTable_Advanced Looks up a localized FText entry directly from the live (runtime) localization table by namespace and key, bypassing the normal LOCTEXT macro caching. FText::GetEmpty Returns a reference to the statically-allocated empty FText singleton, avoiding heap allocation for the common case of an empty text value. FText::GetFormatPatternParameters Extracts the list of named argument placeholders (e. FText::PreloadStringTable Requests that the given string table entry be loaded into memory before it is needed, avoiding a hitch when the text is first displayed. FText::RegisterTextGenerator Registers a custom ITextGenerator factory so that FText instances backed by that generator type can be deserialized correctly. FText::UnregisterTextGenerator Removes a previously registered ITextGenerator factory, preventing new instances of that type from being created during deserialization. FVector::CrossProduct BP Returns the cross product of two vectors. FVector::Distance BP Returns the Euclidean distance between two vectors. FVector::DotProduct BP Computes the dot product of two vectors: `A. FVector::GetSafeNormal Returns a normalised copy of the vector, or ResultIfZero if the vector is too short to safely normalise. FVector::IsNearlyZero Returns true if all three components are within Tolerance of zero. FVector::IsZero Returns true if all three components are exactly zero. FVector::RotateAngleAxis Returns this vector rotated around the given axis by AngleDeg degrees, using Rodrigues' rotation formula. TArray — deprecated bool shrinking overloads deprecated Documents the UE 5. TArray — UE_REQUIRES constraint Template constraint applied to TArray cross-type constructors and assignment operators. TArray::Add Appends an element to the end of the array and returns its index. TArray::AddDefaulted Appends Count new elements at the end of the array, each default-constructed via DefaultConstructItems. TArray::AddUninitialized Grows the array by Count elements without constructing them, returning the index of the first new slot. TArray::AddUnique Adds an element only if it is not already present in the array. TArray::AddZeroed Appends Count new elements at the end of the array, zero-initialising their memory via FMemory::Memzero. TArray::Append Appends all elements from Source to the end of this array in a single allocation. TArray::AppendHash A static method that feeds the element type's layout descriptor into a SHA1 hash. TArray::BulkSerialize Serializes the entire array as a raw memory blob during loading, bypassing per-element serialization for significant performance gains. TArray::CheckAddress Asserts that the given address does not point into the array's current backing buffer. TArray::CheckInvariants Asserts (in Debug/Development builds only) that ArrayNum >= 0 and ArrayMax >= ArrayNum. TArray::Contains Returns true if the array contains at least one element equal to Item. TArray::ContainsByPredicate Returns true if any element satisfies the predicate. TArray::CopyUnfrozen Reconstructs a live TArray from a frozen (WriteMemoryImage) binary representation by placement-constructing a new TArray at Dst and copying element data through the allocator's CopyUnfrozen path. TArray::CountBytes Reports the array's current and peak memory usage to an accounting archive by calling Ar. TArray::Emplace Constructs a new element in-place at the end of the array using the provided constructor arguments. TArray::EmplaceAt Constructs a new element in-place at the given index, shifting all subsequent elements right by one. TArray::Empty Destructs all elements and sets Num to 0. TArray::Find Searches for Item using operator== and returns true if found, setting Index to its position. TArray::FindByPredicate Returns a pointer to the first element for which Pred returns true, or nullptr if none match. TArray::FindItemByClass Searches a TArray of UObject pointers for the first element whose runtime class matches (via IsA) the template parameter SearchType. TArray::FindLast Searches the array from the end toward the front and returns the index of the last element equal to Item, or INDEX_NONE if not found. TArray::Heapify Rearranges the array in-place into a valid max-heap ordered by operator< (min value at the root). TArray::HeapPop Removes and returns the top element (the maximum under the current predicate) from the heap, then re-heapifies the remaining elements. TArray::HeapPopDiscard Removes the top element from the heap without returning it, then re-heapifies. TArray::HeapPush Inserts an element into the array while maintaining max-heap order, sifting the new element up to its correct position. TArray::HeapRemoveAt Removes an arbitrary element at the given index from the heap, then restores heap order by sifting the replacement element both up and down as needed. TArray::HeapSort Sorts the array in ascending order using heap sort. TArray::Init Resets the array to Number elements, every one a copy of Element. TArray::Insert Inserts a single element at the specified index, shifting all subsequent elements right by one. TArray::InsertDefaulted Inserts Count default-constructed elements at Index, shifting existing elements right. TArray::InsertDefaulted_GetRef Inserts a single default-constructed element at Index and returns a reference to it. TArray::InsertUninitialized Opens a gap of Count uninitialized element slots at Index, shifting later elements right. TArray::InsertZeroed Inserts Count zero-initialized elements at Index by shifting existing elements right and then zeroing the new slots with FMemory::Memzero. TArray::InsertZeroed_GetRef Inserts a single zero-initialized element at Index and returns a reference to it, allowing immediate field-by-field initialization without a second array lookup. TArray::IsEmpty Returns true if the array contains no elements. TArray::Num Returns the number of elements currently in the array. TArray::Pop Removes and returns the last element of the array using move semantics. TArray::Push Appends an element to the end of the array, identical in behaviour to Add(). TArray::RangeCheck Validates that an index is within the array bounds, triggering a checkf assertion on failure. TArray::Remove Removes all elements equal to Item and returns the number of elements removed. TArray::RemoveAll Removes all elements for which the predicate returns true, preserving order of remaining elements. TArray::RemoveAllSwap Removes all elements satisfying Predicate using RemoveAtSwap internally, which replaces each removed element with the last element rather than shifting. TArray::RemoveAt Removes the element at Index, destructs it, and shifts all subsequent elements left to close the gap. TArray::RemoveAtSwap Removes the element at Index by filling its slot with element(s) from the end of the array. TArray::RemoveSingle Removes the first occurrence of Item from the array while preserving element order. TArray::RemoveSingleSwap Removes the first occurrence of Item using RemoveAtSwap — the removed slot is filled by the last element, making the actual removal O(1) after the O(N) linear search. TArray::RemoveSwap Removes all occurrences of Item using RemoveAtSwap, which fills each removed slot with the last element. TArray::Reserve Pre-allocates memory for at least Number elements without changing the logical size. TArray::Reset Removes all elements (calls destructors) but retains allocated memory for reuse. TArray::SetNum Resizes the array to exactly NewNum elements, default-constructing any new elements if growing, and destructing trailing elements if shrinking. TArray::SetNumUninitialized Resizes the array to exactly NewNum elements without initialising any newly added memory. TArray::SetNumUnsafeInternal Directly sets the internal element count without touching memory, running destructors, or reallocating. TArray::SetNumZeroed Resizes the array to exactly NewNum elements. TArray::Shrink Reallocates the backing buffer so it exactly fits the current number of elements, releasing any excess capacity (slack). TArray::Sort Sorts the array in-place using an introspective sort (introsort). TArray::StableSort Sorts the array in-place and guarantees that equal elements retain their original relative order. TArray::Swap Swaps two elements at the given indices after verifying both indices are in bounds. TArray::SwapMemory Swaps two elements by directly exchanging their raw memory bytes via the global Swap template. TArray::ToString Converts the frozen memory image representation of this TArray to a human-readable string by delegating to the allocator's ToString. TArray::VerifyHeap Asserts (via check()) that the array satisfies the heap property under the given predicate. TArray::WriteMemoryImage Serialises this TArray into a frozen memory image via FMemoryImageWriter. TOptional::Emplace Constructs the optional's value in-place from the given arguments, destroying any previously held value first. TOptional::Reset Clears the optional back to an unset state, destroying the held value if one is present. TSharedPtr::Reset Releases this shared pointer's reference to the managed object. TSharedPtr::UE_REQUIRES Template constraint applied to TSharedPtr's converting constructors and assignment operators. TSharedPtr::UEOpEquals Internal equality helper used by the UE operator== rewrite infrastructure. TSharedRef::UE_REQUIRES Template constraint on TSharedRef's converting constructors that ensures only type-compatible (upcast-safe) pointer types can implicitly construct a TSharedRef<ObjectType>. TSharedRef::UEOpEquals Internal equality helper used by UE's operator== rewrite infrastructure. TWeakPtr::GetWeakPtrTypeHash Returns a hash of the weak pointer based on the raw object address, suitable for use in TSet and TMap containers. TWeakPtr::Reset Removes this weak pointer's reference to the object by default-constructing a new empty TWeakPtr over itself. TWeakPtr::UE_REQUIRES (constrained conversion constructor) Constrained conversion constructor that copies a TWeakPtr<OtherType> into a TWeakPtr<ObjectType> only when OtherType* is convertible to ObjectType*. TWeakPtr::UEOpEquals Equality comparison for TWeakPtr that pins both sides to shared pointers and compares the resulting raw pointers.

property Properties (16)

FName::ComparisonIndex Index into the global name table pointing to the case-folded version of the string, used for fast case-insensitive equality comparisons. FName::DisplayIndex Index into the global name table pointing to the case-preserved version of the string, used when converting the name back to its original mixed-case form. FName::Number The numeric suffix component of an FName stored internally as (public_number + 1) so that zero-initialised memory represents NAME_NO_NUMBER_INTERNAL. FText::Flags A bitmask of ETextFlag values that record properties of this FText instance, such as whether it is culture-invariant, transient, or initializing. FText::TextData The ref-counted internal data payload of an FText, holding the localized string, format history, and generator state. TArray::AllocatorInstance The allocator object responsible for managing the raw memory backing the array. TArray::ArrayMax Stores the number of elements the array can hold before a reallocation is needed. TArray::ArrayNum Stores the number of elements currently held in the array. TOptional::Super Private type alias for the base class TOptionalBase<OptionalType>, present only on compilers that do not support constrained destructors. TOptional::TypedValue The raw in-place storage for the optional's value, declared inside an anonymous union so that construction and destruction are fully manual. TSharedPtr::Object The raw pointer to the managed object. TSharedPtr::SharedReferenceCount The reference-counter handle for the managed object. TSharedRef::Object The raw pointer to the managed object. TSharedRef::SharedReferenceCount The reference-counter handle shared with all TSharedPtr and TSharedRef instances that co-own the same object. TWeakPtr::Object Raw pointer to the referenced object. TWeakPtr::WeakReferenceCount The weak reference controller shared among all TSharedPtr and TWeakPtr instances pointing to the same object.