1. Epic GamesDeveloper
  3. FEntityFactories

FEntityFactories

A class that contains all the component factory relationships.

API > API/Runtime > API/Runtime/MovieScene

A class that contains all the component factory relationships.

A source component (imported from an entity provider) can trigger the creation of other components on the same entity or on children entities of its entity.

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

Syntax

struct FEntityFactories

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ChildInitializers TArray< TInlineValue< FChildEntityInitializer > >   EntitySystem/MovieSceneEntityFactory.h  
MutualInclusivityGraph UE::MovieScene::FMutualInclusivityGraph   EntitySystem/MovieSceneEntityFactory.h  
ParentToChildComponentTypes TMultiMap< FComponentTypeID, FComponentTypeID >   EntitySystem/MovieSceneEntityFactory.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 ComputeChildComponents ( const FComponentMask& ParentComponentMask,
FComponentMask& ChildComponentMask
)

 Given a set of components on a parent entity, compute what components should exist on a child entity. EntitySystem/MovieSceneEntityFactory.h  
Given a set of components on an entity, computes what other components should also exist on this entity. EntitySystem/MovieSceneEntityFactory.h  

void ConditionallyDuplicateChildComponent ( TComponentTypeID< ComponentType > InComponent,
FComponentMask InParentComponentMask
)

 Makes the given component automatically copied from a parent entity to all its children entities, but only if the parent entity passes the given InParentComponentMask. EntitySystem/MovieSceneEntityFactory.h  

void DefineChildComponent ( FComponentTypeID InChildComponent
)

 Defines a component as something that should always be created on every child entity. EntitySystem/MovieSceneEntityFactory.h  
Adds the definition for a child component. The helper methods above are easier and preferrable. EntitySystem/MovieSceneEntityFactory.h  

void DefineChildComponent ( FComponentTypeID InParentComponent,
FComponentTypeID InChildComponent
)

 Specifies that if a component is present on a parent entity, the given child component should be created on any child entity. EntitySystem/MovieSceneEntityFactory.h  

void DefineChildComponent ( TComponentTypeID< ParentComponent > InParentType,
TComponentTypeID< ChildComponent > InChildType,
InitializerCallback&& InInitializer
)

 Specifies that if a component is present on a parent entity, the given child component should be created on any child entity, and initialized with the given initializer. EntitySystem/MovieSceneEntityFactory.h  
Specifies that if an entity matches the given filter, the specified component should be created on it. EntitySystem/MovieSceneEntityFactory.h  

void DefineComplexInclusiveComponents ( const FComplexInclusivityFilter& InFilter,
std::initializer_list< FComponentTypeID > InComponents,
FMutuallyInclusiveComponentParams&& Params
)

 Specifies that if an entity matches the given filter, the specified components should be created on it. EntitySystem/MovieSceneEntityFactory.h  
Indicates that if the first component exists on an entity, the second component should be created on that entity too. EntitySystem/MovieSceneEntityFactory.h  

void DefineMutuallyInclusiveComponents ( FComponentTypeID InComponentA,
std::initializer_list< FComponentTypeID > InMutualComponents
)

 Indicates that if the first component exists on an entity, the specified components should be created on that entity too. EntitySystem/MovieSceneEntityFactory.h  

void DefineMutuallyInclusiveComponents ( FComponentTypeID InComponentA,
std::initializer_list< FComponentTypeID > InMutualComponents,
FMutuallyInclusiveComponentParams&& Params
)

 Specifies a mutual inclusivity relationship along with a custom initializer for initializing the mutual component(s) EntitySystem/MovieSceneEntityFactory.h  

void DuplicateChildComponent ( TComponentTypeID< ComponentType > InComponent
)

 Makes the given component automatically copied from a parent entity to all its children entities. EntitySystem/MovieSceneEntityFactory.h  

void RunInitializers ( const FComponentMask& ParentType,
const FComponentMask& ChildType,
const FEntityAllocation* ParentAllocation,
TArrayView< const int32 > ParentAllocationOffsets,
const FEntityRange& InChildEntityRange
)

   EntitySystem/MovieSceneEntityFactory.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page