UWorldPartitionStreamingSourceComponent

Choose your operating system:

Windows

macOS

Linux

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

Name Description

Public variable

FColor

 

DebugColor

Color used for debugging.

Public variable

float

 

DefaultVisualizerLoadingRange

Value used by debug visualizer when grid loading range is chosen.

Public variable

EStreamingSourc...

 

Priority

Public variable

TArray< FStream...

 

Shapes

Optional aggregated shape list used to build a custom shape for the streaming source.

Public variable

FName

 

TargetGrid

Optional target grid affected by streaming source.

Public variable

TObjectPtr< con...

 

TargetHLODLayer

Optional target HLODLayer affected by the streaming source.

Constructors

Name Description

Public function

UWorldPartitionStreamingSourceComponent

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

void

 

DisableStreamingSource()

Disable the component

Public function Const

void

 

DrawVisualization

(
    const FSceneView* View,
    FPrimitiveDrawInterface* PDI
)

Displays a debug visualizer of the streaming source. Useful when using Shapes.

Public function

void

 

EnableStreamingSource()

Enable the component

Public function Const

bool

 

IsStreamingCompleted()

Returns true if streaming is completed for this streaming source component.

Public function Const

bool

 

IsStreamingSourceEnabled()

Returns true if the component is active.

Overridden from UActorComponent

Name Description

Public function Virtual

void

 

OnRegister()

Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.

Public function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

CanEditChange

(
    const FProperty* InProperty
)

Called by the editor to query whether a property of this object is allowed to be modified.

Overridden from IWorldPartitionStreamingSourceProvider

Name Description

Public function Virtual

bool

 

GetStreamingSource