Unreal Engine API Reference

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

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.

AudioMixer

AudioPlatformConfiguration

AugmentedReality

AutomationMessages

Declares message types for the Automation system.

AutomationWorker

Declares message types for automation workers.

AVIWriter

BlueprintRuntime

BuildPatchServices

BuildSettings

Cbor

CEF3Utils

Chaos

ChaosSolverEngine

ChaosSolvers

CinematicCamera

ClothingSystemRuntime

ClothingSystemRuntimeInterface

CookedIterativeFile

Core

Core engine programming environment. Includes math library, standard container classes and support functionality.

CoreUObject

Implements UObject and C++ reflection system.

D3D12RHI

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

FieldSystemCore

FieldSystemEngine

FieldSystemSimulationCore

Foliage

GameplayTags

Management of hierarchical tables of text-based tags. Allows management of bulk gameplay data.

GameplayTasks

GeometryCollectionCore

GeometryCollectionEngine

GeometryCollectionSimulationCore

HeadMountedDisplay

Interface for HMD devices.

HTTP

HTTP request/response parsing interface.

HttpNetworkReplayStreaming

Icmp

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.

Json

JsonUtilities

JSON conversion routines for UObject types.

Landscape

Launch

Entry point for the engine

LauncherPlatform

LevelSequence

LiveLinkInterface

LiveLinkMessageBusFramework

LuminRuntimeSettings

MaterialShaderQualitySettings

Media

MediaAssets

MediaUtils

MeshDescription

Messaging

Generalized messaging system. Allows passing strongly typed messages between endpoints using arbitrary transport protocols.

MessagingCommon

MessagingRpc

MoviePlayer

Platform and format-agnostic movie player

MovieScene

MovieSceneCapture

MovieSceneTracks

MRMesh

NavigationSystem

Navmesh

Functionality to support the navigation mesh.

NetworkFile

Cook-on-the-fly network filesystem.

NetworkFileSystem

Cook-on-the-fly network filesystem.

Networking

Platform networking support.

NetworkReplayStreaming

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

PhysXCooking

PortalMessages

PortalProxies

PortalRpc

PortalServices

PreLoadScreen

Projects

Functionality for manipulating .uproject and .uplugin files

PropertyPath

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.

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.

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.

SSL

Stomp

StreamingFile

Cook-on-the-fly network filesystem.

StreamingPauseRendering

Module for handling rendering during blocking loads.

SynthBenchmark

Benchmarking routines used to assess system performance.

TimeManagement

Toolbox

Debug tools for testing misc. funtionality in the Editor.

UE4Game

UMG

Unreal Motion Graphics. Unreal's data-driven UI framework built on top of Slate. Work in progress.

UnrealAudio

UtilityShaders

VectorVM

Vector virtual machine. Experimental, intended for use in future features.

Voice

Voice capture interface

VulkanRHI

WebBrowser

WebBrowserTexture

WebSockets

WidgetCarousel

XmlParser

Simple XML parser.

XMPP

Editor

ActorPickerMode

Actor picker for setting up attachments.

AddContentDialog

AdvancedPreviewScene

AIGraph

AnimationBlueprintEditor

AnimationEditor

AnimationModifiers

AnimGraph

Editor for animation graphs.

AudioEditor

BehaviorTreeEditor

Editor for behavior trees.

BlueprintGraph

Extends graph editor functionality for Blueprints.

Blutility

Experimental. Editor for Blueprint Utilities.

BspMode

Geometry placement tools.

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.

CurveAssetEditor

Editor for standalone curve assets.

CurveEditor

CurveTableEditor

Editor for curve table assets.

DataTableEditor

Editor for tables of generic text data.

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.

EditorSettingsViewer

Editor for UObject-based settings.

EditorStyle

Slate style for the Editor.

EditorSubsystem

EditorWidgets

Slate widgets used in various places in the Editor.

EnvironmentQueryEditor

Editor for AI-navigation environment query templates. Allows the design of queries for such things as cover and spawn points.

FoliageEdit

Foliage editing and support classes.

FontEditor

Editor for font assets.

GameplayTasksEditor

GameProjectGeneration

Functionality for generating new game projects and associated data.

GeometryMode

Geometry editing tools.

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.

Layers

Editor for creating & managing groups of actors by layer.

LevelEditor

Level editing and viewing tools. Container for many Editor functions.

LocalizationCommandletExecution

LocalizationDashboard

MainFrame

Root window for the Editor.

MaterialEditor

Editor for materials, material functions & material instances.

Matinee

In-engine cutscene editing and support classes.

MergeActors

MeshPaint

Vertex and texture painting tools.

MeshPaintMode

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.

SceneDepthPickerMode

SceneOutliner

Browsing and picking functionality for Actors.

Sequencer

Tool for animating and coordinating object animations on timelines. Work in progress.

SequenceRecorder

SequenceRecorderSections

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.

StringTableEditor

SwarmInterface

Interface for the swarm distributed lighting build system.

TextureAlignMode

Interactive UV editing tools for geometry.

TextureEditor

Editor for textures.

TimeManagementEditor

TranslationEditor

Editor for translating localized text.

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

Experimental. In-viewport actor snapping functionality.

VREditor

WorkspaceMenuStructure

Base functionality for shared menu structure used in asset editors.

WorldBrowser

Editor for configuring streaming levels.

Developer

AITestSuite

AllDesktopTargetPlatform

AssetTools

Tools, widgets and helper functions for dealing with assets.

AudioFormatADPCM

Support for ADPCM decoding

AudioFormatOgg

Support for OGG Vorbis decoding

AudioFormatOpus

Support for Opus decoding

AudioSettingsEditor

AutomationController

Entry point for the automation system.

AutomationWindow

Widgets & windows used to interact with the automation system.

BlankModule

Example skeleton module.

BlueprintCompilerCppBackend

BlueprintNativeCodeGen

CollectionManager

System for managing collections of assets.

CollisionAnalyzer

Tool used to check collisions.

DerivedDataCache

Manages the cache of engine-optimized data derived from source assets.

DesktopPlatform

Generaized abstraction of a desktop platform's services.

DesktopWidgets

DeviceManager

User interface for interacting with connected devices.

DirectoryWatcher

Platform-agnostic tracking of filesystem changes.

ExternalImagePicker

Widgets used to pick images on disk that are not used as textures.

FunctionalTesting

Tests engine functionality.

GameplayDebugger

Gameplay debugging utilities.

GammaUI

User interface for controlling engine gamma correction.

GraphColor

HierarchicalLODUtilities

HotReload

LauncherServices

Provides functionality to cook, package, deploy & launch games.

Localization

LocalizationService

LogVisualizer

UI for analyzing log output.

LuminPlatformEditor

LuminTargetPlatform

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

MeshDescriptionOperations

MeshMergeUtilities

MeshReductionInterface

MeshUtilities

Mesh processing utilities including triangle stripping and LOD generation.

MeshUtilitiesCommon

MessageLog

Rich localized text logging functionality.

ModuleUI

User interface for interacting with engine modules.

OutputLog

Basic text logging functionality.

PakFileUtilities

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

RawMesh

Raw mesh data used to construct optimized runtime rendering streams.

RealtimeProfiler

Displays real-time profiler stats in the profiler window.

ScreenShotComparison

User interface for comparing captured screenshots.

ScreenShotComparisonTools

Support functionality for screenshot comparisons.

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.

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.

TextureCompressor

Texture processing routines. Wrapper around compression formats, mipmap generation etc.

TextureFormatASTC

TextureFormatDXT

DXT texture support.

TextureFormatIntelISPCTexComp

TextureFormatPVR

PVRTC texture support.

TextureFormatUncompressed

Uncompressed texture format handler.

TreeMap

VulkanShaderFormat

XGEController

Plugins

ActorLayerUtilities

ActorLayerUtilitiesEditor

ActorSequence

ActorSequenceEditor

AdjustEditor

ADOSupport

AESHandlerComponent

AISupportModule

AlembicImporter

AlembicLibrary

AnalyticsBlueprintLibrary

AnalyticsMulticast

AnalyticsMulticastEditor

AndroidCameraEditor

AndroidCameraFactory

AndroidDeviceProfileSelector

AndroidMediaEditor

AndroidMediaFactory

AndroidPermission

AnimationBudgetAllocator

AnimationSharing

AnimationSharingEd

AnimDistanceMatching

Ansel

ApexDestruction

ApexDestructionEditor

AppleImageUtils

AppleImageUtilsBlueprintSupport

AppleVision

AppleVisionBlueprintSupport

ApsalarEditor

ArchVisCharacter

AssetManagerEditor

AudioCapture

AudioCaptureEditor

AudioCaptureTimecodeProvider

AvfMediaEditor

AvfMediaFactory

BackChannel

BlankPlugin

Example of a minimal plugin. This can be used as a starting point when creating your own plugin.

BlastAuthoring

BlueprintMaterialTextureNodes

BlueprintStats

Provides Blueprint statistics.

BodyState

CableComponent

Component which simulates a cable between two points.

ChaosCloth

ChaosNiagara

ChaosSolverEditor

CharacterAI

CLionSourceCodeAccess

CodeEditor

CodeView

Provides an in-editor code view of game classes and structures with direct IDE accessibility.

Composure

ComposureEditor

ComposureLayersEditor

Concert

ConcertFrontend

ConcertSyncClient

ConcertSyncClientLibrary

ConcertSyncCore

ConcertSyncServer

ConcertSyncTest

ConcertTransport

ConcertUICore

ControlRig

ControlRigDeveloper

ControlRigEditor

CryptoKeys

CryptoKeysOpenSSL

CustomMeshComponent

Component class that allows you to specify custom geometry via C++ or Blueprints.

DatabaseSupport

DatasmithContent

DatasmithContentEditor

DataValidation

DisplayCluster

DisplayClusterEditor

DisplayClusterInput

DummyMeshReconstructor

EditableMesh

EditorScriptingUtilities

EditorTests

ExampleDeviceProfileSelector

Example device profile sused show selection of device profiles on hardware

FacialAnimation

FacialAnimationEditor

FbxAutomationTestBuilder

FieldSystemEditor

FileLogging

FlurryEditor

FunctionalTestingEditor

GameplayAbilities

Framework for asynchronous tasks which run over time while a player uses in-game abilities/powers.

GameplayAbilitiesEditor

Editor for gameplay abilities.

GameplayTagsEditor

Editor for gameplay tag tables.

Gauntlet

GeometryCache

GeometryCacheEd

GeometryCacheSequencer

GeometryCacheTracks

GeometryCollectionEditor

GeometryCollectionExampleCore

GitSourceControl

GLTFImporter

GoogleARCoreBase

GoogleARCoreRendering

GoogleARCoreServices

GoogleVRController

GoogleVRHMD

GoogleVRTransition2D

Hotfix

HoudiniNiagara

HoudiniNiagaraEditor

HTML5Networking

HTNPlanner

HTNTestSuite

HTTPChunkInstaller

ImagePlate

ImagePlateEditor

ImgMedia

ImgMediaEditor

ImgMediaFactory

LauncherChunkInstaller

LeapMotion

LeapMotionEditor

LensDistortion

LevelSequenceEditor

LightPropagationVolumeEditor

LightPropagationVolumeRuntime

LinearTimecode

LiveLink

LiveLinkCurveDebugUI

LiveLinkEditor

Lobby

LocationServicesAndroidEditor

LocationServicesBPLibrary

LocationServicesIOSEditor

LoginFlow

MagicLeap

MagicLeapAR

MagicLeapAudio

MagicLeapCamera

MagicLeapCameraPreviewFactory

MagicLeapController

MagicLeapEyeTracker

MagicLeapHandTracking

MagicLeapHelperOpenGL

MagicLeapHelperVulkan

MagicLeapIdentity

MagicLeapMediaCodecFactory

MagicLeapMediaEditor

MagicLeapMediaFactory

MagicLeapScreens

MagicLeapSecureStorage

MaterialAnalyzer

MatineeToLevelSequence

MediaCompositing

MediaCompositingEditor

MediaFrameworkUtilities

MediaFrameworkUtilitiesEditor

MediaIOCore

MediaIOEditor

MediaPlayerEditor

MeshEditor

MessagingDebugger

Provides a visual debugger for the messaging sub-system.

MfMediaEditor

MfMediaFactory

MIDIDevice

MobileLauncherProfileWizard

MobilePatchingUtils

NetcodeUnitTest

Niagara

NiagaraCore

NiagaraEditor

Experimental. Editor for particles using the VectorVM.

NiagaraEditorWidgets

NiagaraShader

NiagaraVertexFactories

NUTUnrealEngine4

OculusAudio

OculusAudioEditor

OculusEditor

OculusHMD

OculusInput

OculusMR

OneSkyLocalizationService

OnlineBlueprintSupport

Blueprint online functionality. Latent functions, leaderboards etc.

OnlineSubsystem

Interfaces for all online subsystems

OnlineSubsystemAmazon

Amazon account support

OnlineSubsystemFacebook

Facebook integration layer

OnlineSubsystemGoogle

OnlineSubsystemNull

Placeholder OnlineSubsystem implementation when no other implementation is available.

OnlineSubsystemOculus

OnlineSubsystemSteam

Online support for Steam

OnlineSubsystemTwitch

OnlineSubsystemUtils

Online utility functions and classes

OpenColorIO

OpenColorIOEditor

OpenCVHelper

OpenCVLensCalibration

OpenCVLensDistortion

OpenExrWrapper

OptionalMobileFeaturesBPLibrary

Paper2D

Runtime component for Paper 2D engine support, containing the asset and component classes, etc...

Paper2DEditor

Contains the editor-specific classes and asset editors for working with Paper2D types (sprite editor, flipbook editor, etc...)

PaperSpriteSheetImporter

PaperTiledImporter

Importer for JSON tile maps and associated data, exported from Tiled 0.90 or later

Party

PerforceSourceControl

Adds support for Perforce source control.

PerformanceMonitor

PhysXVehicles

PhysXVehiclesEditor

PixelStreaming

PlatformCrypto

PlatformCryptoOpenSSL

PlayTimeLimit

PluginBrowser

PointCloud

PolygonModeling

PreLoadScreenMoviePlayer

ProceduralMeshComponent

ProceduralMeshComponentEditor

ProxyLODMeshReduction

PythonScriptPlugin

PythonScriptPluginPreload

Qos

RawInput

Rejoin

RemoteDatabaseSupport

RemoteSession

ReplicationGraph

ResonanceAudio

ResonanceAudioEditor

RuntimePhysXCooking

RuntimeTests

ScreenshotTools

SequencerScripting

SequencerScriptingEditor

Shotgun

SignificanceManager

SimpleHMD

SkeletalMeshReduction

SlateRemote

Implements the Slate remote server.

SmartSnapping

Support for snapping to arbitrary Z-planes. Work in progress.

SoundMod

Support for audio tracker modules using libxmp.

SoundModImporter

Importer for SoundMod assets.

SoundUtilities

SoundUtilitiesEditor

SoundVisualizations

Utility functions for visualizing sound waves.

Spatialization

SpatializationEditor

SpeedTreeImporter

Importer for SpeedTree SRT files.

SteamAudio

SteamAudioEditor

SteamController

SteamVR

SteamVRController

StereoPanorama

SubversionSourceControl

Adds support for Subversion source control.

SunPosition

Synthesis

SynthesisEditor

TakeRecorder

TakeRecorderSources

TakesCore

TakeTrackRecorders

TcpMessaging

TimecodeSynchronizer

TimecodeSynchronizerEditor

TimeSynth

TimeSynthEditor

UdpMessaging

Adds a UDP based transport and tunneling layer to the messaging sub-system.

UnrealUSDWrapper

UObjectPlugin

Example of a plugin which declares its own UObject type.

USDImporter

VariantManagerContent

VirtualCamera

VisualStudioCodeSourceCodeAccess

VisualStudioSourceCodeAccess

Bridge to allow the editor to interop with Visual Studio.

VivoxVoiceChat

VPBookmark

VPBookmarkEditor

VPUtilities

VPUtilitiesEditor

WebBrowserWidget

WebMMedia

WebMMediaEditor

WebMMediaFactory

WebMMoviePlayer

WindowsDeviceProfileSelector

Used to determine the device settings for Windows platforms.

WindowsMoviePlayer

Windows-specific movie player using Media Foundation.

WmfMedia

WmfMediaEditor

WmfMediaFactory