Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

Light Theme

Dark Theme

FComponentMask

Done as a concrete type so that we can make a debug visualizer for the type.

Windows

MacOS

Linux

References

Module	MovieScene
Header	/Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityIDs.h
Include	#include "EntitySystem/MovieSceneEntityIDs.h"

Syntax

struct FComponentMask

Remarks

Done as a concrete type so that we can make a debug visualizer for the type.

Constructors

	Name	Description
	FComponentMask()
	FComponentMask ( std::initializer_list< FComponentTy... )
	FComponentMask ( bool bValue, int32 InNum )

Functions

	Name	Description
FComponentMa...	BitwiseAND ( const FComponentMask& A, const FComponentMask& B, EBitwiseOperatorFlags InFlags )
FComponentMa...	BitwiseNOT ( const FComponentMask& A )
void	BitwiseNOT()
FComponentMa...	BitwiseOR ( const FComponentMask& A, const FComponentMask& B, EBitwiseOperatorFlags InFlags )
FComponentMa...	BitwiseXOR ( const FComponentMask& A, const FComponentMask& B, EBitwiseOperatorFlags InFlags )
FComponentMa...	CombineWithBitwiseAND ( const FComponentMask& Other, EBitwiseOperatorFlags InFlags )
FComponentMa...	CombineWithBitwiseOR ( const FComponentMask& Other, EBitwiseOperatorFlags InFlags )
FComponentMa...	CombineWithBitwiseXOR ( const FComponentMask& Other, EBitwiseOperatorFlags InFlags )
bool	CompareSetBits ( const FComponentMask& Other )
bool	Contains ( FComponentTypeID InComponentType )
bool	ContainsAll ( const FComponentMask& InComponentM... )
bool	ContainsAny ( const FComponentMask& InComponentM... )
int32	Find ( bool bValue )
FComponentTy...	First()	Find the first component type ID in this mask, or Invalid if the mask is empty.
FComponentMa...	Iterate()
int32	Num()
int32	NumComponents()
void	PadToNum ( int32 Num, bool bPadValue )
void	Remove ( FComponentTypeID InComponentType )
void	Reset()
void	Set ( FComponentTypeID InComponentType )
void	SetAll ( std::initializer_list< FComponentTy... )
void	SetAllLenient ( std::initializer_list< FComponentTy... )

Operators

		Name	Description
	FBitReferenc...	operator[] ( FComponentTypeID ComponentType )
	FConstBitRef...	operator[] ( FComponentTypeID ComponentType )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss