Navigation
API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- UWorldPartitionStreamingSourceComponent
References
| Module | Engine |
| Header | /Engine/Source/Runtime/Engine/Classes/Components/WorldPartitionStreamingSourceComponent.h |
| Include | #include "Components/WorldPartitionStreamingSourceComponent.h" |
Syntax
class UWorldPartitionStreamingSourceComponent :
public UActorComponent,
public IWorldPartitionStreamingSourceProvider
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FColor | DebugColor | Color used for debugging. |
 |
float | DefaultVisualizerLoadingRange | Value used by debug visualizer when grid loading range is chosen. |
 |
EStreamingSourcePriority | Priority | |
 |
TArray< FStreamingSourceShape > | Shapes | Optional aggregated shape list used to build a custom shape for the streaming source. |
 |
EStreamingSourceTargetBehavior | TargetBehavior | When TargetGrids or TargetHLODLayers are specified, this indicates the behavior. |
 |
TArray< FName > | TargetGrids | Optional target grids affected by streaming source. |
 |
TArray< TObjectPtr< const UHLODLayer > > | TargetHLODLayers | Optional target HLODLayers affected by the streaming source. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UWorldPartitionStreamingSourceComponent
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Disable the component | |
  |
void | DrawVisualization
(
const FSceneView* View, |
Displays a debug visualizer of the streaming source. Useful when using Shapes. |
 |
void | Enable the component | |
  |
bool | Returns true if streaming is completed for this streaming source component. | |
  |
bool | Returns true if the component is active. |
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnRegister () |
Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. |
  |
void | OnUnregister () |
Called when a component is unregistered. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. |
  |
void | Handles reading, writing, and reference collecting using FArchive. |
Overridden from IWorldPartitionStreamingSourceProvider
| Type | Name | Description | |
|---|---|---|---|
   |
bool | GetStreamingSource
(
FWorldPartitionStreamingSource& OutStreamingSource |
|
   |
const UObject * |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FName | TargetGrid_DEPRECATED | |
 |
TObjectPtr< const UHLODLayer > | TargetHLODLayer_DEPRECATED |