unreal.LevelStreaming
¶
- class unreal.LevelStreaming(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
Object
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.
C++ Source:
Module: Engine
File: LevelStreaming.h
Editor Properties: (see get_editor_property/set_editor_property)
disable_distance_streaming
(bool): [Read-Write] 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)draw_on_level_status_map
(bool): [Read-Write] If true, will be drawn on the ‘level streaming status’ map (STAT LEVELMAP console command)editor_streaming_volumes
(Array[LevelStreamingVolume]): [Read-Write] The level streaming volumes bound to this level.is_static
(bool): [Read-Write] 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.level_color
(LinearColor): [Read-Write] The level color used for visualization. (Show -> Advanced -> Level Coloration)level_lod_index
(int32): [Read-Write] Requested LOD. Non LOD sub-levels have Index = -1level_transform
(Transform): [Read-Write] Transform applied to actors after loading.min_time_between_volume_unload_requests
(float): [Read-Write] Cooldown time in seconds between volume-based unload requests. Used in preventing spurious unload requests.on_level_hidden
(LevelStreamingVisibilityStatus): [Read-Write] Called when level is no longer visible, may not be removed from world yeton_level_loaded
(LevelStreamingLoadedStatus): [Read-Write] Called when level is streamed inon_level_shown
(LevelStreamingVisibilityStatus): [Read-Write] Called when level is added to the world and is visibleon_level_unloaded
(LevelStreamingLoadedStatus): [Read-Write] Called when level is streamed outshould_be_loaded
(bool): [Read-Write] Whether the level should be loadedshould_be_visible
(bool): [Read-Write] Whether the level should be visible if it is loadedshould_block_on_load
(bool): [Read-Write] Whether we want to force a blocking loadshould_block_on_unload
(bool): [Read-Write] Whether we want to force a blocking unloadstreaming_priority
(int32): [Read-Write] 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.world_asset
(World): [Read-Only] The reference to the world containing the level to load
- create_instance(unique_instance_name) LevelStreaming ¶
Creates a new instance of this streaming level with a provided unique instance name
- Parameters:
unique_instance_name (str) –
- Return type:
- property disable_distance_streaming: bool¶
[Read-Write] 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)
- Type:
(bool)
- get_is_requesting_unload_and_removal() bool ¶
Returns if the streaming level has requested to be unloaded and removed.
- Return type:
- get_world_asset_package_f_name() Name ¶
Gets the package name for the world asset referred to by this level streaming as an FName
- Return type:
- is_streaming_state_pending() bool ¶
Returns whether level has streaming state change pending
- Return type:
- property level_lod_index: int¶
[Read-Write] Requested LOD. Non LOD sub-levels have Index = -1
- Type:
(int32)
[Read-Write] Called when level is no longer visible, may not be removed from world yet
- Type:
- property on_level_loaded: LevelStreamingLoadedStatus¶
[Read-Write] Called when level is streamed in
- Type:
- property on_level_shown: LevelStreamingVisibilityStatus¶
[Read-Write] Called when level is added to the world and is visible
- Type:
- property on_level_unloaded: LevelStreamingLoadedStatus¶
[Read-Write] Called when level is streamed out
- Type:
- set_is_requesting_unload_and_removal(is_requesting_unload_and_removal) None ¶
Sets if the streaming level should be unloaded and removed.
- Parameters:
is_requesting_unload_and_removal (bool) –
- property should_be_visible: bool¶
[Read-Write] Whether the level should be visible if it is loaded
- Type:
(bool)
- property should_block_on_load: bool¶
[Read-Write] Whether we want to force a blocking load
- Type:
(bool)
- property should_block_on_unload: bool¶
[Read-Write] Whether we want to force a blocking unload
- Type:
(bool)