FEntityManager::ReadComponent

Attempt to read a component from an entity.

Windows
MacOS
Linux

References

Module

MovieScene

Header

/Engine/Source/Runtime/MovieScene/Public/EntitySystem/MovieSceneEntityManager.h

Include

#include "EntitySystem/MovieSceneEntityManager.h"

Syntax

template<typename T>
TComponentLock< TReadOptional< T > > ReadComponent
(
    FMovieSceneEntityID Entity,
    TComponentTypeID< T > ComponentTypeID
) const

Remarks

Attempt to read a component from an entity. @note this is a general purpose convenience utility which should not be used for high-performance runtime code. See FEntityTaskBuilder.

Returns

A scoped component ptr that points directly to the entity's component, or nullptr if it does not exist

Parameters

Parameter

Description

Entity

The ID of the entity to read from

ComponentTypeID

The component that is to be read

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