1. Epic GamesDeveloper
  3. FComponentRegistry

FComponentRegistry

API > API/Runtime > API/Runtime/MovieScene

   
Name FComponentRegistry
Type struct
Header File /Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneComponentRegistry.h
Include Path #include "EntitySystem/MovieSceneComponentRegistry.h"

Syntax

struct FComponentRegistry

Constructors

Name Remarks Include Path Unreal Specifiers
  EntitySystem/MovieSceneComponentRegistry.h  
  EntitySystem/MovieSceneComponentRegistry.h  
  EntitySystem/MovieSceneComponentRegistry.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Factories FEntityFactories   EntitySystem/MovieSceneComponentRegistry.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ComponentStructs TSparseArray< UScriptStruct * >   EntitySystem/MovieSceneComponentRegistry.h  
ComponentTypes TSparseArray< FComponentTypeInfo >   EntitySystem/MovieSceneComponentRegistry.h  
CopyAndMigrationMask FComponentMask Mask containing all components that have the EComponentTypeFlags::CopyToOutput and EComponentTypeFlags::MigrateToOutput EntitySystem/MovieSceneComponentRegistry.h  
MigrationMask FComponentMask Mask containing all components that have the flag EComponentTypeFlags::MigrateToOutput EntitySystem/MovieSceneComponentRegistry.h  
NonTagComponentMask FComponentMask A component mask for all component types that are NOT tags, cached and updated when ComponentTypes is modified. EntitySystem/MovieSceneComponentRegistry.h  
PreservationMask FComponentMask Mask containing all components that have the flag EComponentTypeFlags::Preserved EntitySystem/MovieSceneComponentRegistry.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DestroyComponentTypeSafe ( FComponentTypeID ComponentTypeID
)

 Destroy a component type by first removing it from all existing entities EntitySystem/MovieSceneComponentRegistry.h  

void DestroyComponentUnsafeFast ( FComponentTypeID ComponentTypeID
)

 Destroy a component type that definitely does not exist on any entities or is cached elsewhere EntitySystem/MovieSceneComponentRegistry.h  

const FComponentTypeInfo & GetComponentTypeChecked ( FComponentTypeID ComponentTypeID
) const

   EntitySystem/MovieSceneComponentRegistry.h  

const FComponentMask & GetCopyAndMigrationMask()

 Retrive a mask of all components to be copied or migrated to outputs EntitySystem/MovieSceneComponentRegistry.h  

const FComponentMask & GetDataComponentTypes()

 Retrieve a mask of all data component types (ie all components that are not tags). EntitySystem/MovieSceneComponentRegistry.h  

const FComponentMask & GetMigrationMask()

 Retrieve a mask of all components that are to be migrated to outputs if there are multiple entities animating the same thing EntitySystem/MovieSceneComponentRegistry.h  

const FComponentMask & GetPreservationMask()

 Retrieve a mask of all components that are to be preserved EntitySystem/MovieSceneComponentRegistry.h  

TComponentTypeID< T > NewComponentType ( const TCHAR*const DebugName,
const FNewComponentTypeParams& Params
)

 Define a new transient tag type using the specified information. EntitySystem/MovieSceneComponentRegistry.h  

void NewComponentType ( TComponentTypeID< T >* Ref,
const TCHAR*const DebugName,
const FNewComponentTypeParams& Params
)

   EntitySystem/MovieSceneComponentRegistry.h  

void NewComponentTypeNoAddReferencedObjects ( TComponentTypeID< T >* Ref,
const TCHAR*const DebugName,
const FNewComponentTypeParams& Params
)

   EntitySystem/MovieSceneComponentRegistry.h  

TComponentTypeID< T > NewComponentTypeNoAddReferencedObjects ( const TCHAR*const DebugName,
const FNewComponentTypeParams& Params
)

 Same as NewComponentType but specifically does not expose the component type to the reference graph. EntitySystem/MovieSceneComponentRegistry.h  

void NewPropertyType ( TPropertyComponents< PropertyTraits >& OutComponents,
const TCHAR* DebugName
)

   EntitySystem/MovieSceneComponentRegistry.h  

FComponentTypeID NewTag ( const TCHAR*const DebugName,
EComponentTypeFlags Flags
)

 Define a new tag type using the specified information. EntitySystem/MovieSceneComponentRegistry.h  

Operators

Name Remarks Include Path Unreal Specifiers
  EntitySystem/MovieSceneComponentRegistry.h  
  EntitySystem/MovieSceneComponentRegistry.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page