FLevelCollection

Contains a group of levels of a particular ELevelCollectionType within a [UWorld](API\Runtime\Engine\Engine\UWorld) and the context required to properly tick/update those levels.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/Engine/World.h

Include

#include "Engine/World.h"

Syntax

struct FLevelCollection

Remarks

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.

Constructors

Name Description

Public function

FLevelCollection()

Public function

FLevelCollection

(
    const FLevelCollection&
)

Public function

FLevelCollection

(
    FLevelCollection&& Other
)

Destructors

Name Description

Public function

~FLevelCollection()

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

Functions

Name Description

Public function

void

 

AddLevel

(
    ULevel*const Level
)

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

Public function Const

UDemoNetDriv...

 

GetDemoNetDriver()

Gets the demo net driver for this collection.

Public function Const

AGameStateBa...

 

GetGameState()

Gets the game state for this collection.

Public function Const

const TSet< ...

 

GetLevels()

Returns the set of levels in this collection.

Public function Const

UNetDriver &...

 

GetNetDriver()

Gets the net driver for this collection.

Public function Const

ULevel *

 

GetPersistentLevel()

Returns this collection's PersistentLevel.

Public function Const

ELevelCollec...

 

GetType()

Gets the type of this collection.

Public function Const

bool

 

IsVisible()

Gets whether this collection is currently visible.

Public function

void

 

RemoveLevel

(
    ULevel*const Level
)

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

Public function

void

 

SetDemoNetDriver

(
    UDemoNetDriver*const InDemoNet...
)

Sets the demo net driver for this collection.

Public function

void

 

SetGameState

(
    AGameStateBase*const InGameSta...
)

Sets the game state for this collection.

Public function

void

 

SetIsVisible

(
    const bool bInIsVisible
)

Sets whether this collection is currently visible.

Public function

void

 

SetNetDriver

(
    UNetDriver*const InNetDriver
)

Sets the net driver for this collection.

Public function

void

 

SetPersistentLevel

(
    ULevel*const Level
)

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

Public function

void

 

SetType

(
    const ELevelCollectionType InType
)

Sets the type of this collection.

Operators

Name Description

Public function

FLevelCollec...

 

operator=

(
    FLevelCollection&& Other
)

Public function

FLevelCollec...

 

operator=

(
    const FLevelCollection&
)

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback