1. Epic GamesDeveloper
  3. Components

Components

Unreal Engine C++ API Reference > Runtime > Engine

Classes

  Type Name Description
Public class AHeterogeneousVolume A placeable actor that represents a heterogeneous volume.  
Public class ASkyAtmosphere A placeable actor that represents a planet atmosphere material and simulates sky and light scattering within it.  
Public class AVolumetricCloud A placeable actor that represents a participating media material around a planet, e.g. clouds.  
Public struct FActorComponentActivatedSignature    
Public struct FActorComponentDeactivateSignature    
Public struct FActorParentComponentSetter    
Public struct FAnimationEvaluationContext    
Public struct FBatchedLine    
Public struct FBatchedMesh    
Public struct FBatchedPoint    
Public struct FCachedKeyToActionInfo Struct that exists to store runtime cache to make key to action lookups faster.  
Public struct FChildActorAttachedActorInfo    
Public struct FChildActorComponentInstanceData    
Public struct FClosestPointOnPhysicsAsset    
Public struct FClusterNode    
Public struct FClusterNode_DEPRECATED Due to BulkSerialize we can't edit the struct, so we must deprecated this one and create a new one.  
Public struct FComponentBeginCursorOverSignature    
Public struct FComponentBeginOverlapSignature    
Public struct FComponentBeginTouchOverSignature    
Public struct FComponentCollisionSettingsChangedSignature    
Public struct FComponentEndCursorOverSignature    
Public struct FComponentEndOverlapSignature    
Public struct FComponentEndTouchOverSignature    
Public struct FComponentHitSignature    
Public struct FComponentOnClickedSignature    
Public struct FComponentOnInputTouchBeginSignature    
Public struct FComponentOnInputTouchEndSignature    
Public struct FComponentOnReleasedSignature    
Public struct FComponentPhysicsStateChanged    
Public struct FComponentSleepSignature    
Public struct FComponentSync    
Public struct FComponentWakeSignature    
Public struct FDirectAttachChildrenAccessor Struct to allow direct access to the AttachChildren array for a handful of cases that will require more work than can be done immediately to fix up in light of the privatization steps  
Public struct FEngineShowFlagsSetting    
Public struct FEquirectProps Properties for equirect layers  
Public struct FExponentialHeightFogData Data for an individual fog line integral.  
Public struct FExternalMorphSet An external morph target set.  
Public struct FExternalMorphSetWeights The weight data for a specific external morph set.  
Public struct FExternalMorphWeightData The morph target weight data for all external morph target sets.  
Public class FForceFeedbackManager    
Public struct FGetActionsBoundToKey    
Public struct FInputActionBinding Binds a delegate to an action.  
Public class FInputActionHandlerDynamicSignature    
Public struct FInputActionUnifiedDelegate    
Public struct FInputAxisBinding Binds a delegate to an axis mapping.  
Public class FInputAxisHandlerDynamicSignature    
Public struct FInputAxisKeyBinding Binds a delegate to a raw float axis mapping.  
Public struct FInputAxisUnifiedDelegate Unified delegate specialization for float axis events.  
Public struct FInputBinding Base class for the different binding types.  
Public struct FInputGestureBinding Binds a gesture to a function.  
Public class FInputGestureHandlerDynamicSignature    
Public struct FInputGestureUnifiedDelegate Unified delegate specialization for gestureevents.  
Public struct FInputKeyBinding Binds a delegate to a key chord.  
Public struct FInputTouchBinding Binds a delegate to touch input.  
Public class FInputTouchHandlerDynamicSignature    
Public struct FInputTouchUnifiedDelegate Unified delegate specialization for Touch events.  
Public struct FInputVectorAxisBinding Binds a delegate to a raw vector axis mapping.  
Public class FInputVectorAxisHandlerDynamicSignature    
Public struct FInputVectorAxisUnifiedDelegate Unified delegate specialization for vector axis events.  
Public struct FInstancedStaticMeshComponentInstanceData Helper class used to preserve lighting/selection state across blueprint reinstancing  
Public struct FInstancedStaticMeshInstanceData    
Public struct FInstancedStaticMeshLightMapInstanceData Used to store lightmap data during RerunConstructionScripts  
Public struct FInstancedStaticMeshMappingInfo    
Public struct FInstancedStaticMeshRandomSeed    
Public struct FInterpControlPoint    
Public struct FIsRootComponentChanged    
Public struct FLinkedInstancesAdapter    
Public struct FLODMappingData    
Public struct FMaterialSpriteElement    
Public class FOnAnimInitialized    
Public class FOnAudioFinished Called when we finish playing audio, either because it played to completion or because a Stop() call turned it off early  
Public class FOnAudioMultiEnvelopeValue Called while a sound plays and returns the sound's average and max envelope value (using an envelope follower in the audio renderer per wave instance).  
Public class FOnAudioPlaybackPercent Called as a sound plays on the audio component to allow BP to perform actions based on playback percentage.  
Public class FOnAudioPlayStateChanged Called when sound's PlayState changes.  
Public class FOnAudioSingleEnvelopeValue Called while a sound plays and returns the sound's envelope value (using an envelope follower in the audio renderer).  
Public class FOnAudioVirtualizationChanged Called when sound becomes virtualized or realized (resumes playback from virtualization).  
Public class FOnBoneTransformsFinalized    
Public class FOnForceFeedbackFinished Called when we finish playing forcefeedback effect, either because it played to completion or because a Stop() call turned it off early  
Public class FOnQueueSubtitles Called when subtitles are sent to the SubtitleManager.  
Public class FOnTimelineEvent Signature of function to handle a timeline 'event'  
Public class FOnTimelineFloat Signature of function to handle timeline float track  
Public class FOnTimelineLinearColor Signature of function to handle linear color track  
Public class FOnTimelineVector Signature of function to handle timeline vector track  
Public struct FPaintedVertex Cached vertex information at the time the mesh was painted.  
Public struct FPhysicsVolumeChanged    
Public struct FPoseWatchDynamicData    
Public struct FPrecomputedLightInstanceData Used to store lightmap data during RerunConstructionScripts  
Public struct FPrecomputedSkyLightInstanceData Used to store lightmap data during RerunConstructionScripts  
Public struct FPredicateOverlapHasDifferentActor Predicate to determine if an overlap is NOT with a certain AActor.  
Public struct FPredicateOverlapHasSameActor Predicate to determine if an overlap is with a certain AActor.  
Public struct FPrimitiveComponentInstanceData Component instance cached data base class for primitive components.  
Public class FRegisterComponentContext    
Public struct FRendererStencilMaskEvaluation Converts a stencil mask from the editor's USTRUCT version to the version the renderer uses.  
Public class FRenderStateRecreator    
Public struct FSceneCaptureMemorySize Editor only structure for gathering memory size  
Public struct FSceneCaptureViewInfo View state needed to create a scene capture renderer  
Public struct FSceneComponentInstanceData Component instance cached data base class for scene components.  
Public class FScopedPreventAttachedComponentMove Utility for temporarily changing the behavior of a SceneComponent to use absolute transforms, and then restore it to the behavior at the start of the scope.  
Public struct FSkeletalMeshComponentClothTickFunction Tick function that prepares and simulates cloth  
Public struct FSkeletalMeshComponentEndPhysicsTickFunction Tick function that does post physics work on skeletal mesh component.  
Public struct FSkelMeshComponentLODInfo LOD specific setup for the skeletal mesh component.  
Public struct FSkelMeshSkinWeightInfo Vertex skin weight info supplied for a component override.  
Public class FSkyTextureCubeResource A cubemap texture resource that knows how to upload the capture data from a sky capture.  
Public struct FSplineCurves    
Public struct FSplineInstanceData Used to store spline data during RerunConstructionScripts  
Public struct FSplineMeshInstanceData Used to store spline mesh data during RerunConstructionScripts  
Public struct FSplineMeshParams Structure that holds info about spline, passed to renderer to deform UStaticMesh.  
Public struct FSplinePoint    
Public struct FSplinePositionLinearApproximation A single point in linear approximation of a spline  
Public struct FSpriteCategoryInfo Information about the sprite category, used for visualization in the editor  
Public struct FStaticMeshComponentInstanceData    
Public struct FStaticMeshVertexColorLODData Vertex data stored per-LOD  
Public class FStaticShadowDepthMap A texture containing depth values of static objects that was computed during the lighting build.  
Public struct FTentDistribution    
Public struct FTimeline    
Public struct FTimelineEventEntry Struct that contains one entry for an 'event' during the timeline  
Public struct FTimelineFloatTrack Struct that contains one entry for each vector interpolation performed by the timeline  
Public struct FTimelineLinearColorTrack Struct that contains one entry for each linear color interpolation performed by the timeline  
Public struct FTimelineVectorTrack Struct that contains one entry for each vector interpolation performed by the timeline  
Public class FTransformUpdated    
Public struct FVertexOffsetUsage    
Public struct HInstancedStaticMeshInstance InstancedStaticMeshInstance hit proxy  
Public struct TInputUnifiedDelegate Utility delegate class to allow binding to either a C++ function or a blueprint script delegate  
Public class UActorComponent ActorComponent is the base class for components that define reusable behavior that can be added to different types of Actors.  
Public class UApplicationLifecycleComponent Component to handle receiving notifications from the OS about application state (activated, suspended, termination, etc).  
Public class UArrowComponent A simple arrow rendered using lines. Useful for indicating which way an object is facing.  
Public class UAudioComponent AudioComponent is used to play a Sound  
Public class UBillboardComponent A 2d texture that will be rendered always facing the camera.  
Public class UBoundsCopyComponent Component used to copy the bounds of another Actor.  
Public class UBoxComponent A box generally used for simple collision. Bounds are rendered as lines in the editor.  
Public class UBoxReflectionCaptureComponent -> will be exported to EngineDecalClasses.h  
Public class UBrushComponent A brush component defines a shape that can be modified within the editor.  
Public class UCapsuleComponent A capsule generally used for simple collision. Bounds are rendered as lines in the editor.  
Public class UChildActorComponent A component that spawns an Actor when registered, and destroys it when unregistered.  
Public class UDecalComponent A material that is rendered onto the surface of a mesh. A kind of 'bumper sticker' for a model.  
Public class UDirectionalLightComponent A light component that has parallel rays.  
Public class UDrawFrustumComponent Utility component for drawing a view frustum.  
Public class UDrawSphereComponent A sphere generally used for simple collision. Bounds are rendered as lines in the editor.  
Public class UExponentialHeightFogComponent Used to create fogging effects such as clouds but with a density that is related to the height of the fog.  
Public class UForceFeedbackComponent ForceFeedbackComponent allows placing a rumble effect in to the world and having it apply to player characters who come near it  
Public class UHeterogeneousVolumeComponent A component that represents a heterogeneous volume.  
Public class UHierarchicalInstancedStaticMeshComponent    
Public class UInitialActiveSoundParams Legacy struct used for storing named parameter for a given AudioComponent.Convenience class to get audio parameters set on an active sound's playback  
Public class UInputComponent Implement an Actor component for input bindings.  
Public class UInstancedStaticMeshComponent A component that efficiently renders multiple instances of the same StaticMesh.  
Public class UInterpToMovementComponent Move the root component between a series of points over a given time *  
Public class ULightComponent    
Public class ULightComponentBase    
Public class ULightmassPortalComponent    
Public class ULineBatchComponent The line batch component buffers and draws lines (and some other line-based shapes) in a scene.  
Public class ULocalHeightFogComponent    
Public class ULocalLightComponent A light component which emits light from a single point equally in all directions.  
Public class ULODSyncComponent Implement an Actor component for LOD Sync of different components  
Public class UMaterialBillboardComponent A 2d material that will be rendered always facing the camera.  
Public class UMeshComponent MeshComponent is an abstract base for any component that is an instance of a renderable collection of triangles.  
Public class UModelComponent ModelComponents are PrimitiveComponents that represent elements of BSP geometry in a ULevel object.  
Public class UPawnNoiseEmitterComponent PawnNoiseEmitterComponent tracks noise event data used by SensingComponents to hear a Pawn.  
Public class UPlanarReflectionComponent UPlanarReflectionComponent  
Public class UPlaneReflectionCaptureComponent -> will be exported to EngineDecalClasses.h  
Public class UPlatformEventsComponent Component to handle receiving notifications from the OS about platform events.  
Public class UPointLightComponent A light component which emits light from a single point equally in all directions.  
Public class UPoseableMeshComponent UPoseableMeshComponent that allows bone transforms to be driven by blueprint.  
Public class UPostProcessComponent PostProcessComponent.  
Public class UPrimitiveComponent PrimitiveComponents are SceneComponents that contain or generate some sort of geometry, generally to be rendered or used as collision data.  
Public class URectLightComponent A light component which emits light from a rectangle.  
Public class UReflectionCaptureComponent -> will be exported to EngineDecalClasses.h  
Public class URuntimeVirtualTextureComponent Component used to place a URuntimeVirtualTexture in the world.  
Public class USceneCaptureComponent -> will be exported to EngineDecalClasses.h  
Public class USceneCaptureComponent2D Used to capture a 'snapshot' of the scene from a single plane and feed it to a render target.  
Public class USceneCaptureComponentCube Used to capture a 'snapshot' of the scene from a 6 planes and feed it to a render target.  
Public class USceneComponent A SceneComponent has a transform and supports attachment, but has no rendering or collision capabilities.  
Public class UShapeComponent ShapeComponent is a PrimitiveComponent that is represented by a simple geometrical shape (sphere, capsule, box, etc).  
Public class USkeletalMeshComponent SkeletalMeshComponent is used to create an instance of an animated SkeletalMesh asset.  
Public class USkinnedMeshComponent Skinned mesh component that supports bone skinned mesh rendering.  
Public class USkyAtmosphereComponent A component that represents a planet atmosphere material and simulates sky and light scattering within it.  
Public class USkyLightComponent    
Public class USphereComponent A sphere generally used for simple collision. Bounds are rendered as lines in the editor.  
Public class USphereReflectionCaptureComponent -> will be exported to EngineDecalClasses.h  
Public class USplineComponent A spline component is a spline shape which can be used for other purposes (e.g. animating objects).  
Public class USplineMeshComponent A Spline Mesh Component is a derivation of a Static Mesh Component which can be deformed using a spline.  
Public class USplineMetadata    
Public class USpotLightComponent A spot light component emits a directional cone shaped light (Eg a Torch).  
Public class UStaticMeshComponent StaticMeshComponent is used to create an instance of a UStaticMesh.  
Public class UStereoLayerComponent A geometry layer within the stereo rendered viewport.  
Public class UStereoLayerShape    
Public class UStereoLayerShapeCubemap    
Public class UStereoLayerShapeCylinder    
Public class UStereoLayerShapeEquirect    
Public class UStereoLayerShapeQuad    
Public class UTextRenderComponent Renders text in the world with given font.  
Public class UTimelineComponent TimelineComponent holds a series of events, floats, vectors or colors with associated keyframes.  
Public class UVectorFieldComponent A Component referencing a vector field.  
Public class UVolumetricCloudComponent A component that represents a participating media material around a planet, e.g. clouds.  
Public class UWindDirectionalSourceComponent Component that provides a directional wind source. Only affects SpeedTree assets.  
Public class UWorldPartitionStreamingSourceComponent    

Constants

Name Description
EMeshComponentUpdateFlag::AlwaysTickPose  
EMeshComponentUpdateFlag::AlwaysTickPoseAndRefreshBones  
EMeshComponentUpdateFlag::OnlyTickMontagesWhenNotRendered  
EMeshComponentUpdateFlag::OnlyTickPoseWhenRendered  

Typedefs

Name Description
Type  

Enums

  Type Name Description
Public enum EAnimationMode::Type    
Public enum EBoneSpaces::Type Values for specifying bone space.  
Public enum EControllerAnalogStick::Type    
Public enum EHasCustomNavigableGeometry::Type Determines if a primitive component contains custom collision for navigation/AI  
Public enum EKinematicBonesUpdateToPhysics::Type This enum defines how you'd like to update bones to physics world.  
Public enum EPhysicsTransformUpdateMode::Type    
Public enum ESplineCoordinateSpace::Type Types of coordinate space accepted by the functions.  
Public enum ESplineMeshAxis::Type    
Public enum ESplinePointType::Type Permitted spline point types for SplineComponent.  
Public enum ETimelineDirection::Type Does timeline play or reverse ?  

Variables

  Type Name Description
Public variable int32 bAllowCachedOverlapsCVar  
Public variable int32 bEnableFastOverlapCheck  
Public variable float HitDistanceToleranceCVar  
Public variable float InitialOverlapToleranceCVar  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page