Disclaimer
The API reference is an early work in progress, and some information may be missing or out of date. It serves mainly as a low level index of Engine classes and functions. For tutorials, walkthroughs and detailed guides to programming with Unreal, please see the Unreal Engine Programming home on the web.
To explore the API from some of the most frequently encountered Unreal concepts and types, see the API getting started page.
Contents
Runtime
|
AdvancedWidgets |
|
|
Advertising |
Support for mobile advertising providers. |
|
AIModule |
Controller for AI pawns and functionality to support behavior trees. |
|
Analytics |
Event-driven analytics reporting. Reports events over networked providers. |
|
AnalyticsET |
ET analytics provider |
|
AnalyticsVisualEditing |
|
|
AnimationCore |
|
|
AnimGraphRuntime |
|
|
AppFramework |
|
|
ApplicationCore |
|
|
AssetRegistry |
Maintains a database of engine assets. |
|
AudioAnalyzer |
|
|
AudioCaptureCore |
|
|
AudioCaptureRtAudio |
|
|
AudioCodecEngine |
|
|
AudioExtensions |
|
|
AudioLinkEngine |
|
|
AudioMixer |
|
|
AudioMixerCore |
|
|
AudioPlatformConfiguration |
|
|
AugmentedReality |
|
|
AutomationMessages |
Declares message types for the Automation system. |
|
AutomationTest |
|
|
AutomationWorker |
Declares message types for automation workers. |
|
AVEncoder |
|
|
AVIWriter |
|
|
BinkAudioDecoder |
|
|
BlueprintRuntime |
|
|
BuildPatchServices |
|
|
BuildSettings |
|
|
CADKernel |
|
|
Cbor |
|
|
CEF3Utils |
|
|
Chaos |
|
|
ChaosCore |
|
|
ChaosSolverEngine |
|
|
ChaosVehiclesCore |
|
|
ChaosVehiclesEngine |
|
|
CinematicCamera |
|
|
ClothingSystemRuntimeCommon |
|
|
ClothingSystemRuntimeInterface |
|
|
ClothingSystemRuntimeNv |
|
|
ColorManagement |
|
|
CookOnTheFly |
|
|
Core |
Core engine programming environment. Includes math library, standard container classes and support functionality. |
|
CoreOnline |
|
|
CoreUObject |
Implements UObject and C++ reflection system. |
|
CrunchCompression |
|
|
CUDA |
|
|
D3D12RHI |
|
|
DatasmithCore |
|
|
DeveloperSettings |
|
|
DirectLink |
|
|
DynamicPlayRate |
|
|
Engine |
Defines actors and components, and implements the game framework. |
|
EngineMessages |
Declares message types for the engine framework. |
|
EngineSettings |
Encapsulation of engine setting objects. |
|
EyeTracker |
|
|
FieldSystemEngine |
|
|
Foliage |
|
|
GameplayMediaEncoder |
|
|
GameplayTags |
Management of hierarchical tables of text-based tags. Allows management of bulk gameplay data. |
|
GameplayTasks |
|
|
GeForceNOWWrapper |
|
|
GeometryCollectionEngine |
|
|
GeometryCore |
|
|
GeometryFramework |
|
|
HeadMountedDisplay |
Interface for HMD devices. |
|
HTTP |
HTTP request/response parsing interface. |
|
HttpNetworkReplayStreaming |
|
|
HttpServer |
|
|
Icmp |
|
|
IESFile |
|
|
ImageCore |
Storage and format conversion routines for image data. |
|
ImageWrapper |
Wrappers around various image file formats. |
|
ImageWriteQueue |
|
|
InputCore |
Key definitions and related code |
|
InputDevice |
Interface for external controller implementations. |
|
InstallBundleManager |
|
|
InteractiveToolsFramework |
|
|
InterchangeCore |
|
|
InterchangeEngine |
|
|
Json |
|
|
JsonUtilities |
JSON conversion routines for UObject types. |
|
Landscape |
|
|
Launch |
Entry point for the engine |
|
LauncherPlatform |
|
|
LevelSequence |
|
|
LiveLinkAnimationCore |
|
|
LiveLinkInterface |
|
|
LiveLinkMessageBusFramework |
|
|
LocalFileNetworkReplayStreaming |
|
|
MaterialShaderQualitySettings |
|
|
Media |
|
|
MediaAssets |
|
|
MediaUtils |
|
|
MeshConversion |
|
|
MeshConversionEngineTypes |
|
|
MeshDescription |
|
|
MeshUtilitiesCommon |
|
|
Messaging |
Generalized messaging system. Allows passing strongly typed messages between endpoints using arbitrary transport protocols. |
|
MessagingCommon |
|
|
MessagingRpc |
|
|
MoviePlayer |
Platform and format-agnostic movie player |
|
MoviePlayerProxy |
|
|
MovieScene |
|
|
MovieSceneCapture |
|
|
MovieSceneTracks |
|
|
MRMesh |
|
|
NavigationSystem |
|
|
Navmesh |
Functionality to support the navigation mesh. |
|
NetCommon |
|
|
NetCore |
|
|
NetworkFile |
Cook-on-the-fly network filesystem. |
|
NetworkFileSystem |
Cook-on-the-fly network filesystem. |
|
Networking |
Platform networking support. |
|
NetworkReplayStreaming |
|
|
NonRealtimeAudioRenderer |
|
|
NullDrv |
Placeholder RHI implementation for systems that do not need to render. |
|
NullNetworkReplayStreaming |
|
|
OpenGLDrv |
OpenGL RHI implementation. |
|
Overlay |
|
|
PacketHandler |
|
|
PakFile |
Reads from a monolithic PAK file in a packaged build. |
|
PerfCounters |
|
|
PhysicsCore |
|
|
PhysXCooking |
|
|
PortalMessages |
|
|
PortalProxies |
|
|
PortalRpc |
|
|
PortalServices |
|
|
PreLoadScreen |
|
|
Projects |
Functionality for manipulating .uproject and .uplugin files |
|
PropertyPath |
|
|
RawMesh |
Raw mesh data used to construct optimized runtime rendering streams. |
|
ReliabilityHandlerComponent |
|
|
RenderCore |
Core data structures and utilities shared by modules that perform rendering. |
|
Renderer |
Manages and renders scenes, the renderable information associated with each world. Includes the definition of all drawing policies and shaders. |
|
RHI |
Interface for rendering APIs. |
|
RHICore |
|
|
RigVM |
|
|
RSA |
|
|
SandboxFile |
Redirects reads and writes through a user-specified sandbox directory. |
|
Serialization |
|
|
SessionMessages |
Message objects used to communicate with running engine sessions. |
|
SessionServices |
Service interfaces used by the session management modules. |
|
SignalProcessing |
|
|
SkeletalMeshDescription |
|
|
Slate |
Unreal's declarative UI framework. Used to build the Unreal Editor, and for in-game UI. |
|
SlateCore |
Core declarations and types for Slate |
|
SlateNullRenderer |
|
|
SlateRHIRenderer |
Default Slate rendering implementation which uses the default RHI API. |
|
Sockets |
Platform-abstracted socket implementation. |
|
SoundFieldRendering |
|
|
SSL |
|
|
StageDataCore |
|
|
StaticMeshDescription |
|
|
StorageServerClient |
|
|
StreamingFile |
Cook-on-the-fly network filesystem. |
|
StreamingPauseRendering |
Module for handling rendering during blocking loads. |
|
SynthBenchmark |
Benchmarking routines used to assess system performance. |
|
TextureUtilitiesCommon |
|
|
TimeManagement |
|
|
TraceLog |
|
|
TypedElementFramework |
|
|
TypedElementRuntime |
|
|
UMG |
Unreal Motion Graphics. Unreal's data-driven UI framework built on top of Slate. Work in progress. |
|
VectorVM |
Vector virtual machine. Experimental, intended for use in future features. |
|
Voice |
Voice capture interface |
|
Voronoi |
|
|
VulkanRHI |
|
|
WebBrowser |
|
|
WebSockets |
|
|
WidgetCarousel |
|
|
XmlParser |
Simple XML parser. |
Editor
|
ActorPickerMode |
Actor picker for setting up attachments. |
|
AddContentDialog |
|
|
AdvancedPreviewScene |
|
|
AIGraph |
|
|
AnimationBlueprintEditor |
|
|
AnimationBlueprintLibrary |
|
|
AnimationEditor |
|
|
AnimationModifiers |
|
|
AnimGraph |
Editor for animation graphs. |
|
AssetPlacementEdMode |
|
|
AssetTagsEditor |
|
|
AudioEditor |
|
|
BehaviorTreeEditor |
Editor for behavior trees. |
|
BlueprintEditorLibrary |
|
|
BlueprintGraph |
Extends graph editor functionality for Blueprints. |
|
Blutility |
|
|
Cascade |
Editor for particle systems. |
|
ClassViewer |
Browser and picker functionality for C++ and Blueprint classes. |
|
ClothingSystemEditor |
|
|
ClothingSystemEditorInterface |
|
|
ClothPainter |
|
|
CommonMenuExtensions |
|
|
ComponentVisualizers |
Editor specific code for drawing Actor components. |
|
ConfigEditor |
|
|
ContentBrowser |
Browser and picker functionality for assets. |
|
ContentBrowserData |
|
|
CSVtoSVG |
|
|
CurveAssetEditor |
Editor for standalone curve assets. |
|
CurveEditor |
|
|
CurveTableEditor |
Editor for curve table assets. |
|
DataLayerEditor |
|
|
DataTableEditor |
Editor for tables of generic text data. |
|
DerivedDataEditor |
|
|
DetailCustomizations |
Built-in customizations for the display of object properties. |
|
DeviceProfileEditor |
Editor for target device profiles. |
|
DeviceProfileServices |
Device profile manager. |
|
DistCurveEditor |
Editor for distribution curves. |
|
Documentation |
Support for displaying UDN documentation in the Editor. |
|
EditorConfig |
|
|
EditorFramework |
|
|
EditorInteractiveToolsFramework |
|
|
EditorSettingsViewer |
Editor for UObject-based settings. |
|
EditorStyle |
Slate style for the Editor. |
|
EditorSubsystem |
|
|
EditorWidgets |
Slate widgets used in various places in the Editor. |
|
EnvironmentLightingViewer |
|
|
FoliageEdit |
Foliage editing and support classes. |
|
FontEditor |
Editor for font assets. |
|
GameplayTasksEditor |
|
|
GameProjectGeneration |
Functionality for generating new game projects and associated data. |
|
GraphEditor |
Base editor functionality for node-based graphs, used in Blueprints, Materials etc. |
|
HardwareTargeting |
|
|
HierarchicalLODOutliner |
|
|
InputBindingEditor |
Editor for input bindings. |
|
InternationalizationSettings |
Settings for Editor region & language. |
|
IntroTutorials |
Implements editor tutorials. |
|
Kismet |
Blueprint editor. |
|
KismetCompiler |
Compiler for Blueprints. |
|
KismetWidgets |
Widgets used in the Blueprint editor. |
|
LandscapeEditor |
Landscape editing and support classes. |
|
LandscapeEditorUtilities |
|
|
Layers |
Editor for creating & managing groups of actors by layer. |
|
LevelAssetEditor |
|
|
LevelEditor |
Level editing and viewing tools. Container for many Editor functions. |
|
LevelInstanceEditor |
|
|
LocalizationCommandletExecution |
|
|
LocalizationDashboard |
|
|
MainFrame |
Root window for the Editor. |
|
MaterialEditor |
Editor for materials, material functions & material instances. |
|
MergeActors |
|
|
MeshPaint |
Vertex and texture painting tools. |
|
MovieSceneCaptureDialog |
|
|
MovieSceneTools |
Tools for working with Sequencer movie scenes. Work in progress. |
|
NewLevelDialog |
Dialog allowing creation of a new level. |
|
OverlayEditor |
|
|
PackagesDialog |
Dialog used to display package status & operations (saving, checking out etc.). |
|
Persona |
Editor for Skeletal meshes, skeletons and animation-related systems. |
|
PhysicsAssetEditor |
Physical asset editor, allowing setup of physics for skeletal meshes. |
|
PIEPreviewDeviceProfileSelector |
|
|
PIEPreviewDeviceSpecification |
|
|
PinnedCommandList |
|
|
PixelInspectorModule |
|
|
PlacementMode |
Drag-and-drop object placement tools. |
|
PListEditor |
Editor for Mac/iOS plist XML files. |
|
PluginWarden |
|
|
ProjectSettingsViewer |
Viewer for project settings. |
|
ProjectTargetPlatformEditor |
Allows editing which platforms your project will support. |
|
PropertyEditor |
Functionality for editing UProperties in the details panel & property grid. |
|
RewindDebuggerInterface |
|
|
SceneDepthPickerMode |
|
|
SceneOutliner |
Browsing and picking functionality for Actors. |
|
Sequencer |
Tool for animating and coordinating object animations on timelines. Work in progress. |
|
SequenceRecorder |
|
|
SequencerWidgets |
Slate widget definitions for Sequencer. |
|
SerializedRecorderInterface |
|
|
SkeletalMeshEditor |
|
|
SkeletonEditor |
|
|
SourceControlWindows |
Windows used for various source control operations. |
|
StaticMeshEditor |
Editor for static meshes. |
|
StatsViewer |
Auditing tools for various statistics. |
|
StatusBar |
|
|
StringTableEditor |
|
|
StructViewer |
|
|
SubobjectDataInterface |
|
|
SubobjectEditor |
|
|
SwarmInterface |
Interface for the swarm distributed lighting build system. |
|
TextureEditor |
Editor for textures. |
|
ToolMenusEditor |
|
|
TranslationEditor |
Editor for translating localized text. |
|
TurnkeySupport |
|
|
UATHelper |
|
|
UMGEditor |
Editor for UMG assets. |
|
UndoHistory |
Inspector for the the undo/redo history. |
|
UnrealEd |
Core editor functionality. |
|
UnrealEdMessages |
Automation messages for the Editor. |
|
ViewportInteraction |
|
|
ViewportSnapping |
|
|
VirtualTexturingEditor |
|
|
VREditor |
|
|
WorkspaceMenuStructure |
Base functionality for shared menu structure used in asset editors. |
|
WorldBrowser |
Editor for configuring streaming levels. |
|
WorldPartitionEditor |
Developer
|
AITestSuite |
|
|
AnimationDataController |
|
|
AnimationWidgets |
|
|
AssetTools |
Tools, widgets and helper functions for dealing with assets. |
|
AudioFormatADPCM |
Support for ADPCM decoding |
|
AudioFormatBink |
|
|
AudioFormatOgg |
Support for OGG Vorbis decoding |
|
AudioFormatOpus |
Support for Opus decoding |
|
AudioSettingsEditor |
|
|
AutomationController |
Entry point for the automation system. |
|
AutomationDriver |
|
|
AutomationWindow |
Widgets & windows used to interact with the automation system. |
|
BSPUtils |
|
|
CollectionManager |
System for managing collections of assets. |
|
CollisionAnalyzer |
Tool used to check collisions. |
|
CookedEditor |
|
|
DatasmithExporter |
|
|
DerivedDataCache |
Manages the cache of engine-optimized data derived from source assets. |
|
DesktopPlatform |
Generaized abstraction of a desktop platform's services. |
|
DesktopWidgets |
|
|
DeveloperToolSettings |
|
|
DeviceManager |
User interface for interacting with connected devices. |
|
DirectoryWatcher |
Platform-agnostic tracking of filesystem changes. |
|
EditorAnalyticsSession |
|
|
ExternalImagePicker |
Widgets used to pick images on disk that are not used as textures. |
|
FunctionalTesting |
Tests engine functionality. |
|
GameplayDebugger |
Gameplay debugging utilities. |
|
GeometryProcessingInterfaces |
|
|
GraphColor |
|
|
HierarchicalLODUtilities |
|
|
HotReload |
|
|
IoStoreUtilities |
|
|
LauncherServices |
Provides functionality to cook, package, deploy & launch games. |
|
Localization |
|
|
LocalizationService |
|
|
LogVisualizer |
UI for analyzing log output. |
|
MaterialBaking |
|
|
MaterialUtilities |
|
|
Merge |
Widgets used to merge conflicting revisions of UAssets. Currently only provides experimental support for merging blueprints. |
|
MeshBoneReduction |
Utility to remove bones from skeletons based on skeletal mesh LODs. |
|
MeshBuilder |
|
|
MeshBuilderCommon |
|
|
MeshDescriptionOperations |
|
|
MeshMergeUtilities |
|
|
MeshReductionInterface |
|
|
MeshUtilities |
Mesh processing utilities including triangle stripping and LOD generation. |
|
MeshUtilitiesEngine |
|
|
MessageLog |
Rich localized text logging functionality. |
|
NaniteBuilder |
|
|
OutputLog |
Basic text logging functionality. |
|
PakFileUtilities |
|
|
PhysicsUtilities |
|
|
Profiler |
Core functionality & user interface for the Profiler. |
|
ProfilerClient |
Interface for talking to client sessions that can be profiled. |
|
ProfilerMessages |
Messages that are used by the profiler. |
|
ProfilerService |
Captures and dispatches profiling data. |
|
ProjectLauncher |
|
|
QuadricMeshReduction |
|
|
RealtimeProfiler |
Displays real-time profiler stats in the profiler window. |
|
RigVMDeveloper |
|
|
ScreenShotComparison |
User interface for comparing captured screenshots. |
|
ScreenShotComparisonTools |
Support functionality for screenshot comparisons. |
|
ScriptDisassembler |
|
|
SessionFrontend |
User interface for interacting with running sessions of the engine. |
|
Settings |
Base functionality for dealing with UObject-based settings. |
|
SettingsEditor |
Editing functionality for UObject-based settings. |
|
ShaderCompilerCommon |
Common functionality for compiling shaders. |
|
ShaderFormatOpenGL |
Wrapper around OpenGL shader compiler. |
|
ShaderFormatVectorVM |
|
|
ShaderPreprocessor |
Preprocesses shader source. |
|
SharedSettingsWidgets |
Widgets used in various setting's detail customizations. |
|
SkeletalMeshUtilitiesCommon |
|
|
SlateReflector |
Implementation of the Slate widget reflector. |
|
SourceCodeAccess |
Interface to source code editor plugins. |
|
SourceControl |
Interface for communicating with source control providers. |
|
StandaloneRenderer |
|
|
TargetDeviceServices |
Exposes locally connected or remotely discovered network target devices. |
|
TargetPlatform |
Per-target platform functionality, including resources, devices & platform capabilities. |
|
TaskGraph |
Visualization widgets for the task graph system. |
|
TextureBuild |
|
|
TextureCompressor |
Texture processing routines. Wrapper around compression formats, mipmap generation etc. |
|
TextureFormat |
|
|
TextureFormatDXT |
DXT texture support. |
|
TextureFormatIntelISPCTexComp |
|
|
TextureFormatUncompressed |
Uncompressed texture format handler. |
|
ToolMenus |
|
|
ToolWidgets |
|
|
TraceAnalysis |
|
|
TraceInsights |
|
|
TraceServices |
|
|
TreeMap |
|
|
TurnkeyIO |
|
|
UncontrolledChangelists |
|
|
Virtualization |
|
|
VisualGraphUtils |
|
|
VulkanShaderFormat |
|
|
Zen |