UE::Tick::FWorldContextId Struct Reference

#include <TaskSyncManager.h>

Public Types
typedef int32	FInternalId

Public Member Functions
	FWorldContextId ()
	FWorldContextId (FInternalId InWorldId)
	FWorldContextId (const UWorld *InWorld)
bool	IsValid () const
bool	operator== (const FWorldContextId &Other) const
bool	operator!= (const FWorldContextId &Other) const

Static Public Member Functions
static ENGINE_API FWorldContextId	GetContextIdForWorld (const UWorld *World)

Public Attributes
FInternalId	WorldId

Static Public Attributes
static constexpr FInternalId	InvalidWorldContextId = -1
static constexpr FInternalId	DefaultWorldContextId = 0

Friends
uint32	GetTypeHash (const FWorldContextId &Context)

Detailed Description

Identifies a specific WorldContext that has objects which are allowed to tick and run tasks

Member Typedef Documentation

FInternalId

typedef int32 UE::Tick::FWorldContextId::FInternalId

Constructor & Destructor Documentation

FWorldContextId() [1/3]

UE::Tick::FWorldContextId::FWorldContextId ( )

inline

Construct an invalid world context id

FWorldContextId() [2/3]

UE::Tick::FWorldContextId::FWorldContextId ( FInternalId  InWorldId )

inlineexplicit

Construct from an internal id TODO: May make private

FWorldContextId() [3/3]

UE::Tick::FWorldContextId::FWorldContextId ( const UWorld *  InWorld )

inline

Construct from a world pointer, if it is null or not part of a tickable world context it will return an invalid id

Member Function Documentation

GetContextIdForWorld()

FWorldContextId FWorldContextId::GetContextIdForWorld ( const UWorld *  World )

static

Construct from a world pointer, if it is null or not part of a tickable world context it will return an invalid id

IsValid()

bool UE::Tick::FWorldContextId::IsValid ( ) const

inline

Returns true if this points to a valid tickable world context

operator!=()

bool UE::Tick::FWorldContextId::operator!= ( const FWorldContextId &  Other ) const

inline

operator==()

bool UE::Tick::FWorldContextId::operator== ( const FWorldContextId &  Other ) const

inline

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FWorldContextId &  Context )

friend

Member Data Documentation

DefaultWorldContextId

constexpr FInternalId UE::Tick::FWorldContextId::DefaultWorldContextId = 0

staticconstexpr

Default id which is used for the default game world outside the editor

InvalidWorldContextId

constexpr FInternalId UE::Tick::FWorldContextId::InvalidWorldContextId = -1

staticconstexpr

WorldId

FInternalId UE::Tick::FWorldContextId::WorldId

---

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

• Engine/Source/Runtime/Engine/Public/TaskSyncManager.h
• Engine/Source/Runtime/Engine/Private/TaskSyncManager.cpp