I'm a doctor, not a mechanic

UE3:LevelStreaming (UDK)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UDK Object >> LevelStreaming
Package: 
Engine
Direct subclasses:
LevelStreamingAlwaysLoaded, LevelStreamingDistance, LevelStreamingKismet, LevelStreamingPersistent
This class in other games:
UT3

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.

Properties[edit]

Property group 'LevelStreaming'[edit]

bIsFullyStatic[edit]

Type: bool

Modifiers: const

Whether this level is fully static - if it is, then assumptions can be made about it, ie it doesn't need to be reloaded since nothing could have changed

bLocked[edit]

Type: bool

Modifiers: const

Whether this level is locked; that is, its actors are read-only.

bShouldBeVisibleInEditor[edit]

Type: bool

Modifiers: const

Whether this level should be visible in the Editor

Default value: True

DrawColor[edit]

Type: Object.Color

Modifiers: const

The level's color; used to make the level easily identifiable in the level browser, for actor level visulization, etc.

Default value:

Member Value
A 255
B 255
G 255
R 255

EditorStreamingVolumes[edit]

Type: array<LevelStreamingVolume>

Modifiers: const, editconst

The level streaming volumes bound to this level.

MinTimeBetweenVolumeUnloadRequests[edit]

Type: float

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

Default value: 2.0

Offset[edit]

Type: Object.Vector

Modifiers: const

Offset applied to actors after loading.

PackageName[edit]

Type: name

Modifiers: editconst, const

Name of the level package name used for loading.

Internal variables[edit]

bBoundingBoxVisible[edit]

Type: bool

Modifiers: const

Whether this level's bounding box should be visible in the Editor.

bHasLoadRequestPending[edit]

Type: bool

Modifiers: const, transient

Whether we currently have a load request pending.

bHasUnloadRequestPending[edit]

Type: bool

Modifiers: const, transient

Whether we currently have an unload request pending.

bIsRequestingUnloadAndRemoval[edit]

Type: bool

Modifiers: const, transient

Whether this level streaming object's level should be unloaded and the object be removed from the level list.

bIsVisible[edit]

Type: bool

Modifiers: const, transient

Whether the level is currently visible/ associated with the world

bShouldBeLoaded[edit]

Type: bool

Modifiers: const, transient

Whether the level should be loaded

bShouldBeVisible[edit]

Type: bool

Modifiers: const, transient

Whether the level should be visible if it is loaded

bShouldBlockOnLoad[edit]

Type: bool

Modifiers: transient

Whether we want to force a blocking load

Keywords[edit]

Type: array<string>

List of keywords to filter on in the level browser

LastVolumeUnloadRequestTime[edit]

Type: float

Modifiers: const, transient

Time of last volume unload request. Used in preventing spurious unload requests.

LoadedLevel[edit]

Type: Level

Modifiers: transient, const

Pointer to Level object if currently loaded/ streamed in.

OldOffset[edit]

Type: Object.Vector

Modifiers: const

Current/ old offset required for changing the offset at runtime, e.g. in the Editor.