FLevelCollection Struct Reference

#include <World.h>

Public Member Functions
UE_API	FLevelCollection ()
	FLevelCollection (const FLevelCollection &)=delete
FLevelCollection &	operator= (const FLevelCollection &)=delete
UE_API	FLevelCollection (FLevelCollection &&Other)
UE_API FLevelCollection &	operator= (FLevelCollection &&Other)
UE_API	~FLevelCollection ()
ELevelCollectionType	GetType () const
void	SetType (const ELevelCollectionType InType)
AGameStateBase *	GetGameState () const
void	SetGameState (AGameStateBase *const InGameState)
UNetDriver *	GetNetDriver () const
void	SetNetDriver (UNetDriver *const InNetDriver)
UDemoNetDriver *	GetDemoNetDriver () const
void	SetDemoNetDriver (UDemoNetDriver *const InDemoNetDriver)
const TSet< TObjectPtr< ULevel > > &	GetLevels () const
UE_API void	AddLevel (ULevel *const Level)
UE_API void	RemoveLevel (ULevel *const Level)
UE_API void	SetPersistentLevel (ULevel *const Level)
ULevel *	GetPersistentLevel () const
bool	IsVisible () const
void	SetIsVisible (const bool bInIsVisible)

Detailed Description

Contains a group of levels of a particular ELevelCollectionType within a UWorld and the context required to properly tick/update those levels. This object is move-only.

Constructor & Destructor Documentation

FLevelCollection() [1/3]

FLevelCollection::FLevelCollection

(

)

FLevelCollection() [2/3]

FLevelCollection::FLevelCollection ( const FLevelCollection &  )

delete

FLevelCollection() [3/3]

FLevelCollection::FLevelCollection

(

FLevelCollection &&

Other

)

~FLevelCollection()

FLevelCollection::~FLevelCollection

(

)

The destructor will clear the cached collection pointers in this collection's levels.

Member Function Documentation

AddLevel()

void FLevelCollection::AddLevel

(

ULevel *const

Level

)

Adds a level to this collection and caches the collection pointer on the level for fast access.

GetDemoNetDriver()

UDemoNetDriver * FLevelCollection::GetDemoNetDriver ( ) const

inline

Gets the demo net driver for this collection.

GetGameState()

AGameStateBase * FLevelCollection::GetGameState ( ) const

inline

Gets the game state for this collection.

GetLevels()

const TSet< TObjectPtr< ULevel > > & FLevelCollection::GetLevels ( ) const

inline

Returns the set of levels in this collection.

GetNetDriver()

UNetDriver * FLevelCollection::GetNetDriver ( ) const

inline

Gets the net driver for this collection.

GetPersistentLevel()

ULevel * FLevelCollection::GetPersistentLevel ( ) const

inline

Returns this collection's PersistentLevel.

GetType()

ELevelCollectionType FLevelCollection::GetType ( ) const

inline

Gets the type of this collection.

IsVisible()

bool FLevelCollection::IsVisible ( ) const

inline

Gets whether this collection is currently visible.

operator=() [1/2]

FLevelCollection & FLevelCollection::operator= ( const FLevelCollection &  )

delete

operator=() [2/2]

FLevelCollection & FLevelCollection::operator=

(

FLevelCollection &&

Other

)

RemoveLevel()

void FLevelCollection::RemoveLevel

(

ULevel *const

Level

)

Removes a level from this collection and clears the cached collection pointer on the level.

SetDemoNetDriver()

void FLevelCollection::SetDemoNetDriver ( UDemoNetDriver *const  InDemoNetDriver )

inline

Sets the demo net driver for this collection.

SetGameState()

void FLevelCollection::SetGameState ( AGameStateBase *const  InGameState )

inline

Sets the game state for this collection.

SetIsVisible()

void FLevelCollection::SetIsVisible ( const bool  bInIsVisible )

inline

Sets whether this collection is currently visible.

SetNetDriver()

void FLevelCollection::SetNetDriver ( UNetDriver *const  InNetDriver )

inline

Sets the net driver for this collection.

SetPersistentLevel()

void FLevelCollection::SetPersistentLevel

(

ULevel *const

Level

)

Sets this collection's PersistentLevel and adds it to the Levels set.

SetType()

void FLevelCollection::SetType ( const ELevelCollectionType  InType )

inline

Sets the type of this collection.

---

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

• Engine/Source/Runtime/Engine/Classes/Engine/World.h
• Engine/Source/Runtime/Engine/Private/World.cpp