Navigation
API > API/Runtime > API/Runtime/Engine
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.
| Name | FLevelCollection |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/Engine/World.h |
| Include Path | #include "Engine/World.h" |
Syntax
USTRUCT ()
struct FLevelCollection
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLevelCollection
(
FLevelCollection&& Other |
Engine/World.h | ||
FLevelCollection
(
const FLevelCollection& |
Engine/World.h | ||
| Engine/World.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FLevelCollection() |
The destructor will clear the cached collection pointers in this collection's levels. | Engine/World.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsVisible | bool | Whether or not this collection is currently visible. | Engine/World.h | |
| CollectionType | ELevelCollectionType | The type of this collection. | Engine/World.h | |
| DemoNetDriver | TObjectPtr< class UDemoNetDriver > | The demo network driver associated with this collection. | Engine/World.h | |
| GameState | TObjectPtr< class AGameStateBase > | The GameState associated with this collection. | Engine/World.h | |
| Levels | TSet< TObjectPtr< ULevel > > | All the levels in this collection. | Engine/World.h | |
| NetDriver | TObjectPtr< class UNetDriver > | The network driver associated with this collection. | Engine/World.h | |
| PersistentLevel | TObjectPtr< class ULevel > | The persistent level associated with this collection. | Engine/World.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddLevel
(
ULevel*const Level |
Adds a level to this collection and caches the collection pointer on the level for fast access. | Engine/World.h | |
UDemoNetDriver * GetDemoNetDriver() |
Gets the demo net driver for this collection. | Engine/World.h | |
AGameStateBase * GetGameState() |
Gets the game state for this collection. | Engine/World.h | |
const TSet< TObjectPtr< ULevel > > & GetLevels() |
Returns the set of levels in this collection. | Engine/World.h | |
UNetDriver * GetNetDriver() |
Gets the net driver for this collection. | Engine/World.h | |
ULevel * GetPersistentLevel() |
Returns this collection's PersistentLevel. | Engine/World.h | |
ELevelCollectionType GetType() |
Gets the type of this collection. | Engine/World.h | |
bool IsVisible() |
Gets whether this collection is currently visible. | Engine/World.h | |
void RemoveLevel
(
ULevel*const Level |
Removes a level from this collection and clears the cached collection pointer on the level. | Engine/World.h | |
void SetDemoNetDriver
(
UDemoNetDriver*const InDemoNetDriver |
Sets the demo net driver for this collection. | Engine/World.h | |
void SetGameState
(
AGameStateBase*const InGameState |
Sets the game state for this collection. | Engine/World.h | |
void SetIsVisible
(
const bool bInIsVisible |
Sets whether this collection is currently visible. | Engine/World.h | |
void SetNetDriver
(
UNetDriver*const InNetDriver |
Sets the net driver for this collection. | Engine/World.h | |
void SetPersistentLevel
(
ULevel*const Level |
Sets this collection's PersistentLevel and adds it to the Levels set. | Engine/World.h | |
void SetType
(
const ELevelCollectionType InType |
Sets the type of this collection. | Engine/World.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FLevelCollection & operator=
(
FLevelCollection&& Other |
Engine/World.h | ||
FLevelCollection & operator=
(
const FLevelCollection& |
Engine/World.h |