UnrealEngineUWP/Engine/Documentation/Extras/API/API.ini

[Index]
; Sorting order for categories
+CategoryOrder=Runtime
+CategoryOrder=Editor
+CategoryOrder=Developer
+CategoryOrder=Other

; Sorting order for modules
+ModuleOrder=Launch
+ModuleOrder=Core
+ModuleOrder=CoreUObject
+ModuleOrder=Engine
+ModuleOrder=UnrealEd

; Define the list of modules which should appear with descriptions on the index page
+MajorModules=Launch
+MajorModules=Core
+MajorModules=CoreUObject
+MajorModules=Engine
+MajorModules=UnrealEd

[HierarchyPages]
+Classes=UObject
+Classes=AActor
+Classes=UActorComponent

[Output]
+IncludedSourceFiles=Actor.cpp
+IncludedSourceFiles=ActorEditor.cpp
+IncludedSourceFiles=ActorConstruction.cpp
+IncludedSourceFiles=ActorReplication.cpp
+IncludedSourceFiles=Pawn.cpp
+IncludedSourceFiles=Character.cpp
+IncludedSourceFiles=Controller.cpp
+IncludedSourceFiles=PlayerController.cpp
+IncludedSourceFiles=CharacterMovementComponent.cpp
+IncludedSourceFiles=ProjectileMovementComponent.cpp
+IncludedSourceFiles=GameMode.cpp
+IncludedSourceFiles=GameState.cpp
+IncludedSourceFiles=PlayerState.cpp
+IncludedSourceFiles=WorldSettings.cpp
+IncludedSourceFiles=MovementComponent.cpp
+IncludedSourceFiles=NavMovementComponent.cpp
+IncludedSourceFiles=PawnMovementComponent.cpp
+IncludedSourceFiles=AIController.cpp
+IncludedSourceFiles=PlayerCamera.cpp
+IncludedSourceFiles=DefaultPawn.cpp
+IncludedSourceFiles=DefaultPawnMovement.cpp
+IncludedSourceFiles=SpectatorPawn.cpp
+IncludedSourceFiles=SpectatorPawnMovement.cpp

[Module.Core.Filter]
TArray=Containers
TBaseArray=Containers
TDefaultMapKeyFuncs=Containers
TMap=Containers
TMultiMap=Containers
TTransArray=Containers

; ######################################################################################################

[Module.Advertising]
Description=Support for mobile advertising providers.

[Module.AIModule]
Description=Controller for AI pawns and functionality to support behavior trees.

[Module.Analytics]
Description=Event-driven analytics reporting. Reports events over networked providers.

[Module.AnalyticsET]
Description=ET analytics provider

[Module.AssetRegistry]
Description=Maintains a database of engine assets.

[Module.AutomationMessages]
Description=Declares message types for the Automation system.

[Module.AutomationWorker]
Description=Declares message types for automation workers.

[Module.Core]
Description=Core engine programming environment. Includes math library, standard container classes and support functionality.

[Module.CoreUObject]
Description=Implements UObject and C++ reflection system.

[Module.Engine]
Description=Defines actors and components, and implements the game framework.

[Module.EngineMessages]
Description=Declares message types for the engine framework.

[Module.EngineSettings]
Description=Encapsulation of engine setting objects.

[Module.GameLiveStreaming]
Description=Interface for live-streaming gameplay to the internet.

[Module.GameplayAbilities]
Description=Framework for asynchronous tasks which run over time while a player uses in-game abilities/powers.

[Module.GameplayTags]
Description=Management of hierarchical tables of text-based tags. Allows management of bulk gameplay data.

[Module.HeadMountedDisplay]
Description=Interface for HMD devices.

[Module.HTTP]
Description=HTTP request/response parsing interface.

[Module.InputCore]
Description=Key definitions and related code

[Module.InputDevice]
Description=Interface for external controller implementations.

[Module.JsonUtilities]
Description=JSON conversion routines for UObject types.

[Module.Launch]
Description=Entry point for the engine

[Module.LauncherAutomatedService]
Description=Service for launching programs in automated tests.

[Module.Messaging]
Description=Generalized messaging system. Allows passing strongly typed messages between endpoints using arbitrary transport protocols.

[Module.MoviePlayer]
Description=Platform and format-agnostic movie player

[Module.MovieSceneCore]
Description=Movie scene for Sequencer. Work in progress.

[Module.MovieSceneCoreTypes]
Description=Base types for movie scenes. Work in progress.

[Module.NetworkFile]
Description=Cook-on-the-fly network filesystem.

[Module.NetworkFileSystem]
Description=Cook-on-the-fly network filesystem.

[Module.Navmesh]
Description=Functionality to support the navigation mesh.

[Module.Networking]
Description=Platform networking support.

[Module.NullDrv]
Description=Placeholder RHI implementation for systems that do not need to render.

[Module.OnlineSubsystem]
Description=Interfaces for all online subsystems

[Module.OnlineSubsystemAmazon]
Description=Amazon account support

[Module.OnlineSubsystemFacebook]
Description=Facebook integration layer

[Module.OnlineSubsystemNull]
Description=Placeholder OnlineSubsystem implementation when no other implementation is available.

[Module.OnlineSubsystemSteam]
Description=Online support for Steam

[Module.OnlineSubsystemUtils]
Description=Online utility functions and classes

[Module.OpenGLDrv]
Description=OpenGL RHI implementation.

[Module.PakFile]
Description=Reads from a monolithic PAK file in a packaged build.

[Module.Projects]
Description=Functionality for manipulating .uproject and .uplugin files

[Module.RenderCore]
Description=Core data structures and utilities shared by modules that perform rendering.

[Module.Renderer]
Description=Manages and renders scenes, the renderable information associated with each world. Includes the definition of all drawing policies and shaders.

[Module.RHI]
Description=Interface for rendering APIs.

[Module.SandboxFile]
Description=Redirects reads and writes through a user-specified sandbox directory.

[Module.ShaderCore]
Description=Data structures and utilities for managing collections of shaders and their associated parameter bindings.

[Module.Slate]
Description=Unreal's declarative UI framework. Used to build the Unreal Editor, and for in-game UI.

[Module.SlateCore]
Description=Core declarations and types for Slate

[Module.SlateRHIRenderer]
Description=Default Slate rendering implementation which uses the default RHI API.

[Module.Sockets]
Description=Platform-abstracted socket implementation.

[Module.StreamingFile]
Description=Cook-on-the-fly network filesystem.

[Module.StreamingPauseRendering]
Description=Module for handling rendering during blocking loads.

[Module.VectorVM]
Description=Vector virtual machine. Experimental, intended for use in future features.

[Module.Voice]
Description=Voice capture interface
 
[Module.UMG]
Description=Unreal Motion Graphics. Unreal's data-driven UI framework built on top of Slate. Work in progress.

; ######################################################################################################

[Module.ActorPickerMode]
Description=Actor picker for setting up attachments.

[Module.AnimGraph]
Description=Editor for animation graphs.

[Module.BehaviorTreeEditor]
Description=Editor for behavior trees.

[Module.BlueprintGraph]
Description=Extends graph editor functionality for Blueprints.

[Module.Blutility]
Description=Experimental. Editor for Blueprint Utilities.

[Module.BspMode]
Description=Geometry placement tools.

[Module.Cascade]
Description=Editor for particle systems.

[Module.ClassViewer]
Description=Browser and picker functionality for C++ and Blueprint classes.

[Module.ContentBrowser]
Description=Browser and picker functionality for assets.

[Module.ComponentVisualizers]
Description=Editor specific code for drawing Actor components.

[Module.CurveAssetEditor]
Description=Editor for standalone curve assets.

[Module.CurveTableEditor]
Description=Editor for curve table assets.

[Module.DataTableEditor]
Description=Editor for tables of generic text data.

[Module.DestructibleMeshEditor]
Description=Editor for APEX destructible meshes.

[Module.DetailCustomizations]
Description=Built-in customizations for the display of object properties.

[Module.DeviceProfileEditor]
Description=Editor for target device profiles.

[Module.DeviceProfileServices]
Description=Device profile manager.

[Module.DistCurveEditor]
Description=Editor for distribution curves.

[Module.Documentation]
Description=Support for displaying UDN documentation in the Editor.

[Module.EditorLiveStreaming]
Description=Support for live video streaming from the Editor.

[Module.EditorSettingsViewer]
Description=Editor for UObject-based settings.

[Module.EditorStyle]
Description=Slate style for the Editor.

[Module.EditorWidgets]
Description=Slate widgets used in various places in the Editor.

[Module.EnvironmentQueryEditor]
Description=Editor for AI-navigation environment query templates. Allows the design of queries for such things as cover and spawn points.

[Module.FontEditor]
Description=Editor for font assets.

[Module.GameplayAbilitiesEditor]
Description=Editor for gameplay abilities.

[Module.GameplayTagsEditor]
Description=Editor for gameplay tag tables.

[Module.GraphEditor]
Description=Base editor functionality for node-based graphs, used in Blueprints, Materials etc.

[Module.InputBindingEditor]
Description=Editor for input bindings.

[Module.IntroTutorials]
Description=Implements editor tutorials.

[Module.LevelEditor]
Description=Level editing and viewing tools. Container for many Editor functions.

[Module.FoliageEdit]
Description=Foliage editing and support classes.

[Module.GameProjectGeneration]
Description=Functionality for generating new game projects and associated data.

[Module.GeometryMode]
Description=Geometry editing tools.

[Module.Kismet]
Description=Blueprint editor.

[Module.KismetCompiler]
Description=Compiler for Blueprints.

[Module.KismetWidgets]
Description=Widgets used in the Blueprint editor.

[Module.LandscapeEditor]
Description=Landscape editing and support classes.

[Module.Layers]
Description=Editor for creating & managing groups of actors by layer.

[Module.Levels]
Description=Editor for configuring streaming levels.

[Module.MainFrame]
Description=Root window for the Editor.

[Module.MaterialEditor]
Description=Editor for materials, material functions & material instances.

[Module.Matinee]
Description=In-engine cutscene editing and support classes.

[Module.MeshPaint]
Description=Vertex and texture painting tools.

[Module.NewLevelDialog]
Description=Dialog allowing creation of a new level.

[Module.NewsFeed]
Description=Newsfeed widget.

[Module.NiagaraEditor]
Description=Experimental. Editor for particles using the VectorVM.

[Module.OnlineBlueprintSupport]
Description=Blueprint online functionality. Latent functions, leaderboards etc.

[Module.PackagesDialog]
Description=Dialog used to display package status & operations (saving, checking out etc.).

[Module.Persona]
Description=Editor for Skeletal meshes, skeletons and animation-related systems.

[Module.PhysicsAssetEditor]
Description=Physical asset editor, allowing setup of physics for skeletal meshes.

[Module.PlacementMode]
Description=Drag-and-drop object placement tools.

[Module.PListEditor]
Description=Editor for Mac/iOS plist XML files.

[Module.ProjectSettingsViewer]
Description=Viewer for project settings.

[Module.ProjectTargetPlatformEditor]
Description=Allows editing which platforms your project will support.

[Module.PropertyEditor]
Description=Functionality for editing UProperties in the details panel & property grid.

[Module.ReferenceViewer]
Description=Displays asset's object references in a navigable graph.

[Module.SceneOutliner]
Description=Browsing and picking functionality for Actors.

[Module.Sequencer]
Description=Tool for animating and coordinating object animations on timelines. Work in progress.

[Module.SequencerWidgets]
Description=Slate widget definitions for Sequencer.

[Module.SourceControlWindows]
Description=Windows used for various source control operations.

[Module.SoundClassEditor]
Description=Editor for sound classes.

[Module.SoundCueEditor]
Description=Editor for sound cues.

[Module.StaticMeshEditor]
Description=Editor for static meshes.

[Module.StatsViewer]
Description=Auditing tools for various statistics.

[Module.SwarmInterface]
Description=Interface for the swarm distributed lighting build system.

[Module.TaskBrowser]
Description=TestTrack Editor integration.

[Module.TextureAlignMode]
Description=Interactive UV editing tools for geometry.

[Module.TextureEditor]
Description=Editor for textures.

[Module.TranslationEditor]
Description=Editor for translating localized text.

[Module.UMGEditor]
Description=Editor for UMG assets.

[Module.UndoHistory]
Description=Inspector for the the undo/redo history.

[Module.UnrealEd]
Description=Core editor functionality.

[Module.UnrealEdMessages]
Description=Automation messages for the Editor.

[Module.UserFeedback]
Description=Editor for user feedback messages.

[Module.ViewportSnapping]
Description=Experimental. In-viewport actor snapping functionality.

[Module.WorkspaceMenuStructure]
Description=Base functionality for shared menu structure used in asset editors.

[Module.WorldBrowser]
Description=Editor for configuring streaming levels.

; ######################################################################################################

[Module.AssetTools]
Description=Tools, widgets and helper functions for dealing with assets.

[Module.AudioFormatADPCM]
Description=Support for ADPCM decoding

[Module.AudioFormatOgg]
Description=Support for OGG Vorbis decoding

[Module.AudioFormatOpus]
Description=Support for Opus decoding

[Module.AutomationController]
Description=Entry point for the automation system.

[Module.AutomationWindow]
Description=Widgets & windows used to interact with the automation system.

[Module.BlankModule]
Description=Example skeleton module.

[Module.CollectionManager]
Description=System for managing collections of assets.

[Module.CollisionAnalyzer]
Description=Tool used to check collisions.

[Module.CrashTracker]
Description=Records crash report videos.

[Module.DerivedDataCache]
Description=Manages the cache of engine-optimized data derived from source assets.

[Module.DesktopPlatform]
Description=Generaized abstraction of a desktop platform's services.

[Module.DeviceManager]
Description=User interface for interacting with connected devices.

[Module.DirectoryWatcher]
Description=Platform-agnostic tracking of filesystem changes.

[Module.ExternalImagePicker]
Description=Widgets used to pick images on disk that are not used as textures.

[Module.FunctionalTesting]
Description=Tests engine functionality.

[Module.GammaUI]
Description=User interface for controlling engine gamma correction.

[Module.GameplayDebugger]
Description=Gameplay debugging utilities.

[Module.ImageCore]
Description=Storage and format conversion routines for image data.
  
[Module.ImageWrapper]
Description=Wrappers around various image file formats.

[Module.InternationalizationSettings]
Description=Settings for Editor region & language.

[Module.LauncherServices]
Description=Provides functionality to cook, package, deploy & launch games.

[Module.LogVisualizer]
Description=UI for analyzing log output.

[Module.Merge]
Description=Widgets used to merge conflicting revisions of UAssets. Currently only provides experimental support for merging blueprints.

[Module.MessageLog]
Description=Rich localized text logging functionality.

[Module.MeshBoneReduction]
Description=Utility to remove bones from skeletons based on skeletal mesh LODs.

[Module.MeshSimplifier]
Description=Mesh simplifcation routines.
  
[Module.MeshUtilities]
Description=Mesh processing utilities including triangle stripping and LOD generation.

[Module.ModuleUI]
Description=User interface for interacting with engine modules.

[Module.MovieSceneTools]
Description=Tools for working with Sequencer movie scenes. Work in progress.

[Module.OutputLog]
Description=Basic text logging functionality.

[Module.PackageDependencyInfo]
Description=Handles package depedendency queries.

[Module.PhysXFormats]
Description=Wrapper around PhysX and APEX API.

[Module.Profiler]
Description=Core functionality & user interface for the Profiler.
  
[Module.ProfilerClient]
Description=Interface for talking to client sessions that can be profiled.
  
[Module.ProfilerMessages]
Description=Messages that are used by the profiler.
  
[Module.ProfilerService]
Description=Captures and dispatches profiling data.
  
[Module.RawMesh]
Description=Raw mesh data used to construct optimized runtime rendering streams.

[Module.RealtimeProfiler]
Description=Displays real-time profiler stats in the profiler window.

[Module.ScreenShotComparison]
Description=User interface for comparing captured screenshots.
  
[Module.ScreenShotComparisonTools]
Description=Support functionality for screenshot comparisons.

[Module.SessionFrontend]
Description=User interface for interacting with running sessions of the engine.
  
[Module.SessionLauncher]
Description=User interface for launching various types of engine session.
  
[Module.SessionMessages]
Description=Message objects used to communicate with running engine sessions.
  
[Module.SessionServices]
Description=Service interfaces used by the session management modules.

[Module.Settings]
Description=Base functionality for dealing with UObject-based settings.

[Module.SettingsEditor]
Description=Editing functionality for UObject-based settings.

[Module.ShaderCompilerCommon]
Description=Common functionality for compiling shaders.

[Module.ShaderFormatOpenGL]
Description=Wrapper around OpenGL shader compiler.

[Module.ShaderPreprocessor]
Description=Preprocesses shader source.

[Module.SharedSettingsWidgets]
Description=Widgets used in various setting's detail customizations.

[Module.SimplygonMeshReduction]
Description=Wrapper around Simplygon middleware.

[Module.SourceCodeAccess]
Description=Interface to source code editor plugins.

[Module.SourceControl]
Description=Interface for communicating with source control providers.

[Module.SlateReflector]
Description=Implementation of the Slate widget reflector.

[Module.SuperSearch]
Description=Editor search bar that allows searching through all Unreal Engine documentation.

[Module.SynthBenchmark]
Description=Benchmarking routines used to assess system performance.

[Module.TargetDeviceServices]
Description=Exposes locally connected or remotely discovered network target devices.

[Module.TargetPlatform]
Description=Per-target platform functionality, including resources, devices & platform capabilities.

[Module.TaskGraph]
Description=Visualization widgets for the task graph system.

[Module.TextureCompressor]
Description=Texture processing routines. Wrapper around compression formats, mipmap generation etc.
  
[Module.TextureFormatAndroid]
Description=ATITC and ETC1/2 texture format handler.
  
[Module.TextureFormatDXT]
Description=DXT texture support.
  
[Module.TextureFormatPVR]
Description=PVRTC texture support.
  
[Module.TextureFormatUncompressed]
Description=Uncompressed texture format handler.

[Module.Toolbox]
Description=Debug tools for testing misc. funtionality in the Editor.

[Module.XmlParser]
Description=Simple XML parser.

; ######################################################################################################

[Module.BlankPlugin]
Description=Example of a minimal plugin. This can be used as a starting point when creating your own plugin.

[Module.BlueprintStats]
Description=Provides Blueprint statistics.

[Module.CableComponent]
Description=Component which simulates a cable between two points.

[Module.CodeView]
Description=Provides an in-editor code view of game classes and structures with direct IDE accessibility.

[Module.CustomMeshComponent]
Description=Component class that allows you to specify custom geometry via C++ or Blueprints.

[Module.EpicSurvey]
Description=Provides a survey to send feedback to Epic about Unreal.

[Module.ExampleDeviceProfileSelector]
Description=Example device profile sused show selection of device profiles on hardware

[Module.LiveEditor]
Description=Allows just about anything in the Unreal Editor/Engine to be adjusted in real-time with off the shelf MIDI/OCS hardware.

[Module.LiveEditorListenServer]
Description=Replicate tuning changes to different machines on the network.

[Module.MessagingDebugger]
Description=Provides a visual debugger for the messaging sub-system.

[Module.OculusRift]
Description=Support for the Oculus Rift HMD.

[Module.Paper2D]
Description=Runtime component for Paper 2D engine support, containing the asset and component classes, etc... 

[Module.Paper2DEditor]
Description=Contains the editor-specific classes and asset editors for working with Paper2D types (sprite editor, flipbook editor, etc...)

[Module.PaperJsonImporter]
Description=Importer for JSON sprite sheets exported by Adobe Flash CS6 or TexturePacker.

[Module.PaperTiledImporter]
Description=Importer for JSON tile maps and associated data, exported from Tiled 0.90 or later

[Module.PerforceSourceControl]
Description=Adds support for Perforce source control.

[Module.Phya]
Description=Phya physically based audio integration.

[Module.PluginsEditor]
Description=Allows enabling and disabling plugins from the editor.

[Module.ScriptEditorPlugin]
Description=An example of a script plugin for the editor. This can be used as a starting point when creating your own plugin.",

[Module.ScriptPlugin]
Description=An example of a script plugin. This can be used as a starting point when creating your own plugin.

[Module.SlateRemote]
Description=Implements the Slate remote server.

[Module.SmartSnapping]
Description=Support for snapping to arbitrary Z-planes. Work in progress.

[Module.SoundMod]
Description=Support for audio tracker modules using libxmp. 

[Module.SoundModImporter]
Description=Importer for SoundMod assets.

[Module.SoundVisualizations]
Description=Utility functions for visualizing sound waves.

[Module.SpeedTreeImporter]
Description=Importer for SpeedTree SRT files.

[Module.SubversionSourceControl]
Description=Adds support for Subversion source control.

[Module.TwitchLiveStreaming]
Description=Allows live streaming gameplay sessions to Twitch.tv.

[Module.UObjectPlugin]
Description=Example of a plugin which declares its own UObject type.

[Module.UdpMessaging]
Description=Adds a UDP based transport and tunneling layer to the messaging sub-system.

[Module.VisualStudioSourceCodeAccess]
Description=Bridge to allow the editor to interop with Visual Studio.

[Module.WindowsDeviceProfileSelector]
Description=Used to determine the device settings for Windows platforms.

[Module.WindowsMoviePlayer]
Description=Windows-specific movie player using Media Foundation.