ULevelStreamingDynamic Class Reference

Public Member Functions
Functions
void	SetbInitiallyVisible (bool Value)
	Whether the level should be visible at startup if it is loaded.
void	SetbInitiallyLoaded (bool Value)
	Whether the level should be loaded at startup.
Public Member Functions inherited from ULevelStreaming
void	SetPriority (int NewPriority)
	Sets the relative priority of considering the streaming level. Changing the priority will not interrupt the currently considered level, but will affect the next time a level is being selected for evaluation.
void	SetShouldBeLoaded (bool bInShouldBeLoaded)
	Virtual that can be overridden to change whether a streaming level should be loaded. Doesn't do anything at the base level as should be loaded defaults to true.
void	SetShouldBeVisible (bool bInShouldBeVisible)
	Sets the should be visible flag and marks the streaming level as requiring consideration.
bool	ShouldBeLoaded () const
	Return whether this level should be present in memory which in turn tells the streaming code to stream it in. Please note that a change in value from false to true only tells the streaming code that it needs to START streaming it in so the code needs to return true an appropriate amount of time before it is needed.
void	SetStreamingPriority (int NewPriority)
	The relative priority of considering the streaming level. Changing the priority will not interrupt the currently considered level, but will affect the next time a level is being selected for evaluation.
void	SetLevelLODIndex (int LODIndex)
	Sets the world composition level LOD index and marks the streaming level as requiring consideration.
void	SetbShouldBeVisible (bool bInShouldBeVisible)
	Whether the level should be visible if it is loaded.
bool	GetbShouldBeLoaded () const
	Whether the level should be loaded.
void	SetbShouldBeLoaded (bool bInShouldBeLoaded)
	Whether the level should be loaded.
const int &	GetStreamingPriority () const
	The relative priority of considering the streaming level. Changing the priority will not interrupt the currently considered level, but will affect the next time a level is being selected for evaluation.
const int &	GetLevelLODIndex () const
	Requested LOD. Non LOD sub-levels have Index = -1.
bool	GetbShouldBeVisible () const
	Whether the level should be visible if it is loaded.
void	SetbIsStatic (bool Value)
	Whether this level only contains static actors that aren't affected by gameplay or replication. If true, the engine can make certain optimizations and will add this level to the StaticLevels collection.
bool	GetbShouldBlockOnLoad () const
	Whether we want to force a blocking load.
void	SetbShouldBlockOnLoad (bool Value)
	Whether we want to force a blocking load.
bool	GetbShouldBlockOnUnload () const
	Whether we want to force a blocking unload.
void	SetbShouldBlockOnUnload (bool Value)
	Whether we want to force a blocking unload.
bool	GetbDisableDistanceStreaming () const
	Whether this level streaming object should be ignored by world composition distance streaming, so streaming state can be controlled by other systems (ex: in blueprints).
void	SetbDisableDistanceStreaming (bool Value)
	Whether this level streaming object should be ignored by world composition distance streaming, so streaming state can be controlled by other systems (ex: in blueprints).
void	SetbDrawOnLevelStatusMap (bool Value)
	If true, will be drawn on the 'level streaming status' map (STAT LEVELMAP console command).
bool	IsStreamingStatePending () const
	Returns whether level has streaming state change pending.
ULevel	GetLoadedLevel () const
	Gets a pointer to the LoadedLevel value.
FName	GetWorldAssetPackageFName () const
	Gets the package name for the world asset referred to by this level streaming as an FName.
bool	IsLevelLoaded () const
	Returns whether streaming level is loaded.
bool	IsLevelVisible () const
	Returns whether streaming level is visible.
ULevelStreaming	CreateInstance (FString UniqueInstanceName)
	Creates a new instance of this streaming level with a provided unique instance name.
bool	GetIsRequestingUnloadAndRemoval () const
	Returns if the streaming level has requested to be unloaded and removed.
void	SetIsRequestingUnloadAndRemoval (bool bInIsRequestingUnloadAndRemoval)
	Sets if the streaming level should be unloaded and removed.
Public Member Functions inherited from UObject
bool	MarkPackageDirty () const
void	RemoveFromRoot ()
bool	GetIsRooted () const
bool	IsTransient () const
bool	Modify (bool bAlwaysMarkDirty=true)
void	SetTransactional (bool bTransactional)
bool	IsSupportedForNetworking () const
UClass	GetClass () const
UObject	GetOuter () const
UObject	GetTypedOuter (TSubclassOf< UObject > Target) const
	Traverses the outer chain searching for the next object of a certain type.
UPackage	GetOutermost () const
UPackage	GetPackage () const
void	AddToRoot ()
UWorld	GetWorld () const
FName	GetName () const
FString	GetFullName (const UObject StopOuter=nullptr) const
FString	GetPathName (const UObject StopOuter=nullptr) const
bool	IsA (const UClass Class) const
	Returns true if this object is of the specified type, or a child of that type.
void	SaveConfig ()
void	LoadConfig ()
void	ReloadConfig ()
void	CopyScriptPropertiesFrom (const UObject OtherObject)
void	opCast (?&Address) const
FString	ToString () const

Static Public Member Functions
LevelStreaming
static ULevelStreamingDynamic	LoadLevelInstance (FString LevelName, FVector Location, FRotator Rotation, bool &bOutSuccess, FString OptionalLevelNameOverride="", TSubclassOf< ULevelStreamingDynamic > OptionalLevelStreamingClass=nullptr, bool bLoadAsTempPackage=false)
	Stream in a level with a specific location and rotation. You can create multiple instances of the same level!
static ULevelStreamingDynamic	LoadLevelInstanceBySoftObjectPtr (TSoftObjectPtr< UWorld > Level, FVector Location, FRotator Rotation, bool &bOutSuccess, FString OptionalLevelNameOverride="", TSubclassOf< ULevelStreamingDynamic > OptionalLevelStreamingClass=nullptr, bool bLoadAsTempPackage=false)
Static Functions
static UClass	StaticClass ()
Static Public Member Functions inherited from ULevelStreaming
static UClass	StaticClass ()
Static Public Member Functions inherited from UObject
static UClass	StaticClass ()

Additional Inherited Members
Public Attributes inherited from ULevelStreaming
FLevelStreamingLoadedStatus	OnLevelLoaded
	Called when level is streamed in.
FLevelStreamingLoadedStatus	OnLevelUnloaded
	Called when level is streamed out.
const ULevel	LoadedLevel
	Pointer to Level object if currently loaded/ streamed in.
FLevelStreamingVisibilityStatus	OnLevelHidden
	Called when level is no longer visible, may not be removed from world yet.
FLevelStreamingVisibilityStatus	OnLevelShown
	Called when level is added to the world and is visible.
const FName	WorldAssetPackageFName
	Gets the package name for the world asset referred to by this level streaming as an FName.
FLinearColor	LevelColor
	The level color used for visualization. (Show -> Advanced -> Level Coloration).
TArray< TObjectPtr< ALevelStreamingVolume > >	EditorStreamingVolumes
	The level streaming volumes bound to this level.
float32	MinTimeBetweenVolumeUnloadRequests
	Cooldown time in seconds between volume-based unload requests. Used in preventing spurious unload requests.
FTransform	LevelTransform
	Transform applied to actors after loading.
bool	IsRequestingUnloadAndRemoval
	Returns if the streaming level has requested to be unloaded and removed.
bool	bShouldBeLoaded
	Whether the level should be loaded.
int	StreamingPriority
	The relative priority of considering the streaming level. Changing the priority will not interrupt the currently considered level, but will affect the next time a level is being selected for evaluation.
bool	bShouldBeVisible
	Whether the level should be visible if it is loaded.
bool	bShouldBlockOnUnload
	Whether we want to force a blocking unload.
bool	bShouldBlockOnLoad
	Whether we want to force a blocking load.
TSoftObjectPtr< UWorld >	WorldAsset
	The reference to the world containing the level to load.
bool	bDisableDistanceStreaming
	Whether this level streaming object should be ignored by world composition distance streaming, so streaming state can be controlled by other systems (ex: in blueprints).
int	LevelLODIndex
	Requested LOD. Non LOD sub-levels have Index = -1.
Public Attributes inherited from UObject
const UClass	Class
const UObject	Outer
const UPackage	Outermost
const UPackage	Package
const UWorld	World
const FName	Name
const bool	IsRooted

Member Function Documentation

LoadLevelInstance()

ULevelStreamingDynamic LoadLevelInstance ( FString LevelName, FVector Location, FRotator Rotation, bool & bOutSuccess, FString OptionalLevelNameOverride = "", TSubclassOf< ULevelStreamingDynamic > OptionalLevelStreamingClass = nullptr, bool bLoadAsTempPackage = false )

static

Stream in a level with a specific location and rotation. You can create multiple instances of the same level!

The level to be loaded does not have to be in the persistent map's Levels list, however to ensure that the .umap does get packaged, please be sure to include the .umap in your Packaging Settings:

Project Settings -> Packaging -> List of Maps to Include in a Packaged Build (you may have to show advanced or type in filter)

Parameters

LevelName	Level package name to load, ex: /Game/Maps/MyMapName, specifying short name like MyMapName will force very slow search on disk
Location	World space location where the level should be spawned
Rotation	World space rotation for rotating the entire level
bOutSuccess	Whether operation was successful (map was found and added to the sub-levels list)
OptionalLevelNameOverride	If set, the loaded level package have this name, which is used by other functions like UnloadStreamLevel. Note this is necessary for server and client networking because the level must have the same name on both.
OptionalLevelStreamingClass	If set, the level streaming class will be used instead of ULevelStreamingDynamic
bLoadAsTempPackage	If set, package path is prefixed by /Temp

Returns

Streaming level object for a level instance

LoadLevelInstanceBySoftObjectPtr()

ULevelStreamingDynamic LoadLevelInstanceBySoftObjectPtr ( TSoftObjectPtr< UWorld > Level, FVector Location, FRotator Rotation, bool & bOutSuccess, FString OptionalLevelNameOverride = "", TSubclassOf< ULevelStreamingDynamic > OptionalLevelStreamingClass = nullptr, bool bLoadAsTempPackage = false )

static

SetbInitiallyLoaded()

void SetbInitiallyLoaded

(

bool

Value

)

Whether the level should be loaded at startup.

SetbInitiallyVisible()

void SetbInitiallyVisible

(

bool

Value

)

Whether the level should be visible at startup if it is loaded.

StaticClass()

UClass StaticClass ( )

static