Class LevelStreaming

Abstract base class of container object encapsulating data required for streaming and providing interface for when a level should be streamed in and out of memory.

Inheritance
System.Object
UObject
LevelStreaming
LevelStreamingAlwaysLoaded
LevelStreamingDynamic
LevelStreamingPersistent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Engine
Assembly: UE4DotNet.dll
Syntax
public class LevelStreaming : UObject

Properties

| Improve this Doc View Source

bDisableDistanceStreaming

Declaration
public bool bDisableDistanceStreaming { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bDrawOnLevelStatusMap

Declaration
public bool bDrawOnLevelStatusMap { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsStatic

Declaration
public bool bIsStatic { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bLocked

Declaration
public bool bLocked { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShouldBeLoaded

Declaration
public bool bShouldBeLoaded { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShouldBeVisible

Declaration
public bool bShouldBeVisible { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShouldBeVisibleInEditor

Declaration
public bool bShouldBeVisibleInEditor { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShouldBlockOnLoad

Declaration
public bool bShouldBlockOnLoad { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShouldBlockOnUnload

Declaration
public bool bShouldBlockOnUnload { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static LevelStreaming DefaultObject { get; }
Property Value
Type Description
LevelStreaming
| Improve this Doc View Source

EditorStreamingVolumes

The level streaming volumes bound to this level.

Declaration
public ObjectArrayField<LevelStreamingVolume> EditorStreamingVolumes { get; }
Property Value
Type Description
ObjectArrayField<LevelStreamingVolume>
| Improve this Doc View Source

FolderPath

The folder path for this level within the world browser.

Declaration
public Name FolderPath { get; set; }
Property Value
Type Description
Name
Remarks

This is only available in editor builds. A NONE path indicates that it exists at the root. It is '/' separated.

| Improve this Doc View Source

LevelColor

The level color used for visualization. (Show -> Advanced -> Level Coloration)

Declaration
public LinearColor LevelColor { get; set; }
Property Value
Type Description
LinearColor
| Improve this Doc View Source

LevelLODIndex

Requested LOD. Non LOD sub-levels have Index = -1

Declaration
public int LevelLODIndex { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

LevelTransform

Transform applied to actors after loading.

Declaration
public Transform LevelTransform { get; set; }
Property Value
Type Description
Transform
| Improve this Doc View Source

LoadedLevel

Pointer to Level object if currently loaded/ streamed in.

Declaration
public Level LoadedLevel { get; set; }
Property Value
Type Description
Level
| Improve this Doc View Source

MinTimeBetweenVolumeUnloadRequests

Cooldown time in seconds between volume-based unload requests. Used in preventing spurious unload requests.

Declaration
public float MinTimeBetweenVolumeUnloadRequests { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

PackageNameToLoad

If this isn't Name_None, then we load from this package on disk to the new package named PackageName

Declaration
public Name PackageNameToLoad { get; set; }
Property Value
Type Description
Name
| Improve this Doc View Source

PendingUnloadLevel

Pointer to a Level object that was previously active and was replaced with a new LoadedLevel (for LOD switching)

Declaration
public Level PendingUnloadLevel { get; set; }
Property Value
Type Description
Level
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

CreateInstance(String)

Creates a new instance of this streaming level with a provided unique instance name

Declaration
public LevelStreaming CreateInstance(string UniqueInstanceName)
Parameters
Type Name Description
System.String UniqueInstanceName
Returns
Type Description
LevelStreaming
| Improve this Doc View Source

GetLevelScriptActor()

Returns the Level Script Actor of the level if the level is loaded and valid

Declaration
public LevelScriptActor GetLevelScriptActor()
Returns
Type Description
LevelScriptActor
| Improve this Doc View Source

GetWorldAssetPackageFName()

Gets the package name for the world asset referred to by this level streaming as an FName

Declaration
public Name GetWorldAssetPackageFName()
Returns
Type Description
Name
| Improve this Doc View Source

IsLevelLoaded()

Returns whether streaming level is loaded

Declaration
public bool IsLevelLoaded()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsLevelVisible()

Returns whether streaming level is visible

Declaration
public bool IsLevelVisible()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

IsStreamingStatePending()

Returns whether level has streaming state change pending

Declaration
public bool IsStreamingStatePending()
Returns
Type Description
System.Boolean
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static LevelStreaming New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
LevelStreaming
| Improve this Doc View Source

SetLevelLODIndex(Int32)

Sets the world composition level LOD index and marks the streaming level as requiring consideration.

Declaration
public void SetLevelLODIndex(int LODIndex)
Parameters
Type Name Description
System.Int32 LODIndex
| Improve this Doc View Source

SetShouldBeLoaded(Boolean)

Virtual that can be overriden to change whether a streaming level should be loaded.

Declaration
public void SetShouldBeLoaded(bool bInShouldBeLoaded)
Parameters
Type Name Description
System.Boolean bInShouldBeLoaded
Remarks

Doesn't do anything at the base level as should be loaded defaults to true

| Improve this Doc View Source

SetShouldBeVisible(Boolean)

Sets the should be visible flag and marks the streaming level as requiring consideration.

Declaration
public void SetShouldBeVisible(bool bInShouldBeVisible)
Parameters
Type Name Description
System.Boolean bInShouldBeVisible
| Improve this Doc View Source

ShouldBeLoaded()

Return whether this level should be present in memory which in turn tells the streaming code to stream it in.

Declaration
public bool ShouldBeLoaded()
Returns
Type Description
System.Boolean
Remarks

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.

@return true if level should be loaded/ streamed in, false otherwise

Operators

| Improve this Doc View Source

Implicit(IntPtr to LevelStreaming)

Convert from IntPtr to UObject

Declaration
public static implicit operator LevelStreaming(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
LevelStreaming