Unreal Engine API Reference

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

Getting started · All constants · All functions · All enums · All classes · Class hierarchy

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
AppFramework
AssetRegistry	Maintains a database of engine assets.
AutomationMessages	Declares message types for the Automation system.
AutomationWorker	Declares message types for automation workers.
Core	Core engine programming environment. Includes math library, standard container classes and support functionality.
CoreUObject	Implements UObject and C++ reflection system.
DatabaseSupport
Engine	Defines actors and components, and implements the game framework.
EngineMessages	Declares message types for the engine framework.
EngineSettings	Encapsulation of engine setting objects.
Foliage
GameLiveStreaming	Interface for live-streaming gameplay to the internet.
GameplayAbilities	Framework for asynchronous tasks which run over time while a player uses in-game abilities/powers.
GameplayTags	Management of hierarchical tables of text-based tags. Allows management of bulk gameplay data.
HeadMountedDisplay	Interface for HMD devices.
HTTP	HTTP request/response parsing interface.
HttpNetworkReplayStreaming
InputCore	Key definitions and related code
InputDevice	Interface for external controller implementations.
Internationalization
Json
JsonUtilities	JSON conversion routines for UObject types.
Landscape
Launch	Entry point for the engine
LauncherAutomatedService	Service for launching programs in automated tests.
Media
MediaAssets
Messaging	Generalized messaging system. Allows passing strongly typed messages between endpoints using arbitrary transport protocols.
MoviePlayer	Platform and format-agnostic movie player
MovieSceneCore	Movie scene for Sequencer. Work in progress.
MovieSceneCoreTypes	Base types for movie scenes. Work in progress.
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
Niagara
NullDrv	Placeholder RHI implementation for systems that do not need to render.
NullNetworkReplayStreaming
OnlineSubsystem	Interfaces for all online subsystems
OnlineSubsystemAmazon	Amazon account support
OnlineSubsystemFacebook	Facebook integration layer
OnlineSubsystemNull	Placeholder OnlineSubsystem implementation when no other implementation is available.
OnlineSubsystemSteam	Online support for Steam
OnlineSubsystemUtils	Online utility functions and classes
OpenGLDrv	OpenGL RHI implementation.
PakFile	Reads from a monolithic PAK file in a packaged build.
PhysXFormats	Wrapper around PhysX and APEX API.
Projects	Functionality for manipulating .uproject and .uplugin files
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.
SandboxFile	Redirects reads and writes through a user-specified sandbox directory.
Serialization
ShaderCore	Data structures and utilities for managing collections of shaders and their associated parameter bindings.
Slate	Unreal's declarative UI framework. Used to build the Unreal Editor, and for in-game UI.
SlateCore	Core declarations and types for Slate
SlateRHIRenderer	Default Slate rendering implementation which uses the default RHI API.
Sockets	Platform-abstracted socket implementation.
StreamingFile	Cook-on-the-fly network filesystem.
StreamingPauseRendering	Module for handling rendering during blocking loads.
Toolbox	Debug tools for testing misc. funtionality in the Editor.
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
WebBrowser
XmlParser	Simple XML parser.

Editor

ActorPickerMode	Actor picker for setting up attachments.
AddContentDialog
AIGraph
AnimGraph	Editor for animation graphs.
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.
ComponentVisualizers	Editor specific code for drawing Actor components.
ConfigEditor
ContentBrowser	Browser and picker functionality for assets.
CurveAssetEditor	Editor for standalone curve assets.
CurveTableEditor	Editor for curve table assets.
DataTableEditor	Editor for tables of generic text data.
DestructibleMeshEditor	Editor for APEX destructible meshes.
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.
EditorLiveStreaming	Support for live video streaming from the Editor.
EditorSettingsViewer	Editor for UObject-based settings.
EditorStyle	Slate style for the Editor.
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.
GameplayAbilitiesEditor	Editor for gameplay abilities.
GameplayTagsEditor	Editor for gameplay tag tables.
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
InputBindingEditor	Editor for input bindings.
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.
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.
NewLevelDialog	Dialog allowing creation of a new level.
NewsFeed	Newsfeed widget.
NiagaraEditor	Experimental. Editor for particles using the VectorVM.
OnlineBlueprintSupport	Blueprint online functionality. Latent functions, leaderboards etc.
PackagesDialog	Dialog used to display package status & operations (saving, checking out etc.).
Persona	Editor for Skeletal meshes, skeletons and animation-related systems.
PhAT	Physical asset editor, allowing setup of physics for skeletal meshes.
PlacementMode	Drag-and-drop object placement tools.
PListEditor	Editor for Mac/iOS plist XML files.
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.
ReferenceViewer	Displays asset's object references in a navigable graph.
SceneOutliner	Browsing and picking functionality for Actors.
Sequencer	Tool for animating and coordinating object animations on timelines. Work in progress.
SequencerWidgets	Slate widget definitions for Sequencer.
SizeMap
SoundClassEditor	Editor for sound classes.
SoundCueEditor	Editor for sound cues.
SourceControlWindows	Windows used for various source control operations.
StaticMeshEditor	Editor for static meshes.
StatsViewer	Auditing tools for various statistics.
SwarmInterface	Interface for the swarm distributed lighting build system.
TextureAlignMode	Interactive UV editing tools for geometry.
TextureEditor	Editor for textures.
TranslationEditor	Editor for translating localized text.
UMGEditor	Editor for UMG assets.
UndoHistory	Inspector for the the undo/redo history.
UnrealEd	Core editor functionality.
UnrealEdMessages	Automation messages for the Editor.
UserFeedback	Editor for user feedback messages.
ViewportSnapping	Experimental. In-viewport actor snapping functionality.
WorkspaceMenuStructure	Base functionality for shared menu structure used in asset editors.
WorldBrowser	Editor for configuring streaming levels.

Developer

AITestSuite
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
AutomationController	Entry point for the automation system.
AutomationWindow	Widgets & windows used to interact with the automation system.
BlankModule	Example skeleton module.
BlueprintCompilerCppBackend
CollectionManager	System for managing collections of assets.
CollisionAnalyzer	Tool used to check collisions.
CrashTracker	Records crash report videos.
DerivedDataCache	Manages the cache of engine-optimized data derived from source assets.
DesktopPlatform	Generaized abstraction of a desktop platform's services.
DesktopTargetPlatform
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.
HotReload
ImageCore	Storage and format conversion routines for image data.
ImageWrapper	Wrappers around various image file formats.
InternationalizationSettings	Settings for Editor region & language.
LauncherServices	Provides functionality to cook, package, deploy & launch games.
LogVisualizer	UI for analyzing log output.
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.
MeshSimplifier	Mesh simplifcation routines.
MeshUtilities	Mesh processing utilities including triangle stripping and LOD generation.
MessageLog	Rich localized text logging functionality.
ModuleUI	User interface for interacting with engine modules.
MovieSceneTools	Tools for working with Sequencer movie scenes. Work in progress.
OutputLog	Basic text logging functionality.
PackageDependencyInfo	Handles package depedendency queries.
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
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.
SessionMessages	Message objects used to communicate with running engine sessions.
SessionServices	Service interfaces used by the session management modules.
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.
ShaderPreprocessor	Preprocesses shader source.
SharedSettingsWidgets	Widgets used in various setting's detail customizations.
SimplygonMeshReduction	Wrapper around Simplygon middleware.
SlateReflector	Implementation of the Slate widget reflector.
SourceCodeAccess	Interface to source code editor plugins.
SourceControl	Interface for communicating with source control providers.
SuperSearch	Editor search bar that allows searching through all Unreal Engine documentation.
SynthBenchmark	Benchmarking routines used to assess system performance.
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.
TextureFormatAndroid	ATITC and ETC1/2 texture format handler.
TextureFormatASTC
TextureFormatDXT	DXT texture support.
TextureFormatIntelISPCTexComp
TextureFormatPVR	PVRTC texture support.
TextureFormatUncompressed	Uncompressed texture format handler.
TreeMap
WidgetCarousel

Plugins

BlankPlugin	Example of a minimal plugin. This can be used as a starting point when creating your own plugin.
CableComponent	Component which simulates a cable between two points.
CharacterAI
CustomMeshComponent	Component class that allows you to specify custom geometry via C++ or Blueprints.
EpicSurvey	Provides a survey to send feedback to Epic about Unreal.
ExampleDeviceProfileSelector	Example device profile sused show selection of device profiles on hardware
GitSourceControl
LeapMotionController
MediaPlayerEditor
MessagingDebugger	Provides a visual debugger for the messaging sub-system.
OculusRift	Support for the Oculus Rift HMD.
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
PerforceSourceControl	Adds support for Perforce source control.
PluginBrowser
ProceduralMeshComponent
SlateRemote	Implements the Slate remote server.
SmartSnapping	Support for snapping to arbitrary Z-planes. Work in progress.
SpeedTreeImporter	Importer for SpeedTree SRT files.
SteamVR
SteamVRController
SubversionSourceControl	Adds support for Subversion source control.
UdpMessaging	Adds a UDP based transport and tunneling layer to the messaging sub-system.
UObjectPlugin	Example of a plugin which declares its own UObject type.
VisualStudioSourceCodeAccess	Bridge to allow the editor to interop with Visual Studio.
WindowsMoviePlayer	Windows-specific movie player using Media Foundation.
WmfMedia