UWorldPartitionStreamingSourceComponent | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/Engine


Name	UWorldPartitionStreamingSourceComponent
Type	class
Header File	/Engine/Source/Runtime/Engine/Classes/Components/WorldPartitionStreamingSourceComponent.h
Include Path	#include "Components/WorldPartitionStreamingSourceComponent.h"

Syntax

UCLASS (Meta=(BlueprintSpawnableComponent),  
       HideCategories=(Tags, Sockets, ComponentTick, ComponentReplication, Activation, Cooking, Events, AssetUserData, Collision, Navigation),  
       MinimalAPI)  
class UWorldPartitionStreamingSourceComponent :  
    public UActorComponent ,  
    public IWorldPartitionStreamingSourceProvider

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UWorldPartitionStreamingSourceComponent

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UWorldPartitionStreamingSourceComponent ( const FObjectInitializer& ObjectInitializer )		Components/WorldPartitionStreamingSourceComponent.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
DebugColor	FColor	Color used for debugging.	Components/WorldPartitionStreamingSourceComponent.h	EditAnywhere Category="Streaming"
DefaultVisualizerLoadingRange	float	Value used by debug visualizer when grid loading range is chosen.	Components/WorldPartitionStreamingSourceComponent.h	EditAnywhere Category="Debug"
Priority	EStreamingSourcePriority		Components/WorldPartitionStreamingSourceComponent.h	BlueprintReadWrite EditAnywhere Category="Streaming"
Shapes	TArray< FStreamingSourceShape >	Optional aggregated shape list used to build a custom shape for the streaming source.	Components/WorldPartitionStreamingSourceComponent.h	BlueprintReadWrite EditAnywhere Category="Streaming"
TargetBehavior	EStreamingSourceTargetBehavior	When TargetGrids or TargetHLODLayers are specified, this indicates the behavior.	Components/WorldPartitionStreamingSourceComponent.h	BlueprintReadWrite EditAnywhere Category="Streaming"
TargetGrids	TArray< FName >	Optional target grids affected by streaming source.	Components/WorldPartitionStreamingSourceComponent.h	BlueprintReadWrite EditAnywhere Category="Streaming"

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
bStreamingSourceEnabled	bool	Whether this component is enabled or not	Components/WorldPartitionStreamingSourceComponent.h	EditAnywhere Interp Category="Streaming"
TargetState	EStreamingSourceTargetState		Components/WorldPartitionStreamingSourceComponent.h	EditAnywhere Category="Streaming"

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
void DisableStreamingSource()	Disable the component	Components/WorldPartitionStreamingSourceComponent.h	BlueprintCallable Category="Streaming"
void DrawVisualization ( const FSceneView* View, FPrimitiveDrawInterface* PDI ) const	Displays a debug visualizer of the streaming source. Useful when using Shapes.	Components/WorldPartitionStreamingSourceComponent.h
void EnableStreamingSource()	Enable the component	Components/WorldPartitionStreamingSourceComponent.h	BlueprintCallable Category="Streaming"
bool IsStreamingCompleted()	Returns true if streaming is completed for this streaming source component.	Components/WorldPartitionStreamingSourceComponent.h	BlueprintCallable Category="Streaming"
bool IsStreamingSourceEnabled()	Returns true if the component is active.	Components/WorldPartitionStreamingSourceComponent.h	BlueprintPure Category="Streaming"

Overridden from UActorComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual void OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.	Components/WorldPartitionStreamingSourceComponent.h
virtual void OnUnregister ()	Called when a component is unregistered.	Components/WorldPartitionStreamingSourceComponent.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostLoad()		Components/WorldPartitionStreamingSourceComponent.h
virtual void Serialize ( FArchive& Ar )		Components/WorldPartitionStreamingSourceComponent.h

Overridden from IWorldPartitionStreamingSourceProvider

Name	Remarks	Include Path	Unreal Specifiers
virtual bool GetStreamingSource ( FWorldPartitionStreamingSource& OutStreamingSource ) const		Components/WorldPartitionStreamingSourceComponent.h
virtual const UObject * GetStreamingSourceOwner()		Components/WorldPartitionStreamingSourceComponent.h

Deprecated Variables

Name	Type	Remarks	Include Path	Unreal Specifiers
TargetGrid_DEPRECATED	FName		Components/WorldPartitionStreamingSourceComponent.h	Meta=(DeprecatedProperty, DeprecationMessage="Use TargetGrids instead.")
TargetHLODLayer_DEPRECATED	TObjectPtr< const UHLODLayer >		Components/WorldPartitionStreamingSourceComponent.h	Meta=(DeprecatedProperty, DeprecationMessage="Use TargetHLODLayers instead.")
TargetHLODLayers_DEPRECATED	TArray< TObjectPtr< const UHLODLayer > >	Optional target HLODLayers affected by the streaming source.	Components/WorldPartitionStreamingSourceComponent.h	Meta=(DeprecatedProperty, DeprecationMessage="Use TargetGrids instead.")