1. Epic GamesDeveloper
  3. UWorldPartitionStreamingSourceComponent

UWorldPartitionStreamingSourceComponent

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/WorldPartitionStreamingSourceComponent.h
Include #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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere FColor DebugColor Color used for debugging.
Public variable UProperty Category, EditAnywhere float DefaultVisualizerLoadingRange Value used by debug visualizer when grid loading range is chosen.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EStreamingSourcePriority Priority  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FStreamingSourceShape > Shapes Optional aggregated shape list used to build a custom shape for the streaming source.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EStreamingSourceTargetBehavior TargetBehavior When TargetGrids or TargetHLODLayers are specified, this indicates the behavior.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FName > TargetGrids Optional target grids affected by streaming source.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void 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 UFunction BlueprintCallable, Category void Enable the component
Public function Const UFunction BlueprintCallable, Category bool Returns true if streaming is completed for this streaming source component.
Public function Const UFunction BlueprintPure, Category bool Returns true if the component is active.

Overridden from UActorComponent

  Type Name Description
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from IWorldPartitionStreamingSourceProvider

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const const UObject *  

Deprecated Variables

  Type Name Description
Public variable UProperty Meta FName TargetGrid_DEPRECATED  
Public variable UProperty Meta TObjectPtr< const UHLODLayer > TargetHLODLayer_DEPRECATED  
Public variable UProperty Meta TArray< TObjectPtr< const UHLODLayer > > TargetHLODLayers_DEPRECATED Optional target HLODLayers affected by the streaming source.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page