UE::MovieScene::FEntityGroupID Struct Reference

#include <BuiltInComponentTypes.h>

Public Member Functions
	FEntityGroupID ()
	FEntityGroupID (const FEntityGroupingPolicyKey InPolicyKey, int32 InGroupIndex)
bool	IsValid () const
bool	HasGroup () const

Static Public Member Functions
static const FEntityGroupID	Invalid ()

Public Attributes
FEntityGroupingPolicyKey	PolicyKey
int32	GroupIndex = INDEX_NONE
EEntityGroupFlags	Flags = EEntityGroupFlags::None

Friends
uint32	GetTypeHash (const FEntityGroupID &GroupID)
bool	operator== (const FEntityGroupID &A, const FEntityGroupID &B)

Detailed Description

The component data for describing what group an entity belongs to (see UMovieSceneEntityGroupingSystem)

Constructor & Destructor Documentation

FEntityGroupID() [1/2]

UE::MovieScene::FEntityGroupID::FEntityGroupID ( )

inline

FEntityGroupID() [2/2]

UE::MovieScene::FEntityGroupID::FEntityGroupID ( const FEntityGroupingPolicyKey  InPolicyKey, int32  InGroupIndex  )

inline

Member Function Documentation

HasGroup()

bool UE::MovieScene::FEntityGroupID::HasGroup ( ) const

inline

Returns whether this component is valid (see IsValid) and if it still belongs to a group. If the entity was removed from its group, the GroupIndex would still be valid, but we would have set Flags to RemovedFromGroup. This lets downstream systems still know what group the entity used to be part of, for their own book-keeping.

Invalid()

static const FEntityGroupID UE::MovieScene::FEntityGroupID::Invalid ( )

inlinestatic

IsValid()

bool UE::MovieScene::FEntityGroupID::IsValid ( ) const

inline

Returns whether this component points to a valid grouping policy, and has a valid group.

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FEntityGroupID &  GroupID )

friend

operator==

bool operator== ( const FEntityGroupID &  A, const FEntityGroupID &  B  )

friend

Member Data Documentation

Flags

EEntityGroupFlags UE::MovieScene::FEntityGroupID::Flags = EEntityGroupFlags::None

GroupIndex

int32 UE::MovieScene::FEntityGroupID::GroupIndex = INDEX_NONE

PolicyKey

FEntityGroupingPolicyKey UE::MovieScene::FEntityGroupID::PolicyKey

---

The documentation for this struct was generated from the following file:

• Engine/Source/Runtime/MovieScene/Public/EntitySystem/BuiltInComponentTypes.h