1. Epic GamesDeveloper
  3. FWorldPartitionStreamingSource

FWorldPartitionStreamingSource

Structure containing all properties required to stream from a source

API > API/Runtime > API/Runtime/Engine

Structure containing all properties required to stream from a source

   
Name FWorldPartitionStreamingSource
Type struct
Header File /Engine/Source/Runtime/Engine/Public/WorldPartition/WorldPartitionStreamingSource.h
Include Path #include "WorldPartition/WorldPartitionStreamingSource.h"

Syntax

struct FWorldPartitionStreamingSource

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  WorldPartition/WorldPartitionStreamingSource.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FWorldPartitionStreamingSource ( const FWorldPartitionStreamingSource& Other
)

   WorldPartition/WorldPartitionStreamingSource.h  
  WorldPartition/WorldPartitionStreamingSource.h  

FWorldPartitionStreamingSource ( FName InName,
const FVector& InLocation,
const FRotator& InRotation,
EStreamingSourceTargetState InTargetState,
bool bInBlockOnSlowLoading,
EStreamingSourcePriority InPriority,
bool bRemote,
FVector InVelocity
)

   WorldPartition/WorldPartitionStreamingSource.h  

Constants

Name Type Remarks Include Path
CVarDebugDisplaySpeedUnit FAutoConsoleVariableRef   WorldPartition/WorldPartitionStreamingSource.h
CVarLocationQuantization FAutoConsoleVariableRef   WorldPartition/WorldPartitionStreamingSource.h
CVarRotationQuantization FAutoConsoleVariableRef   WorldPartition/WorldPartitionStreamingSource.h
DebugDisplaySpeedUnit int32   WorldPartition/WorldPartitionStreamingSource.h
LocationQuantization int32   WorldPartition/WorldPartitionStreamingSource.h
RotationQuantization int32   WorldPartition/WorldPartitionStreamingSource.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bBlockOnSlowLoading bool Whether this source will be considered when world partition detects slow loading and waits for cell streaming to complete. WorldPartition/WorldPartitionStreamingSource.h  
bForce2D bool If true, this streaming source will force intersecting cells in 2D WorldPartition/WorldPartitionStreamingSource.h  
bRemote bool If true, this streaming source is from a remote session WorldPartition/WorldPartitionStreamingSource.h  
bReplay bool If true, this streaming source is from a replay recording WorldPartition/WorldPartitionStreamingSource.h  
bUseVelocityContributionToCellsSorting bool Use velocity contribution to streaming cells priority streaming. WorldPartition/WorldPartitionStreamingSource.h  
DebugColor FColor Color used for debugging. WorldPartition/WorldPartitionStreamingSource.h  
Location FVector Source location. WorldPartition/WorldPartitionStreamingSource.h  
Name FName Source unique name. WorldPartition/WorldPartitionStreamingSource.h  
Priority EStreamingSourcePriority Streaming source priority. WorldPartition/WorldPartitionStreamingSource.h  
Rotation FRotator Source orientation (can impact streaming cell prioritization). WorldPartition/WorldPartitionStreamingSource.h  
Shapes TArray< FStreamingSourceShape > Source internal shapes. WorldPartition/WorldPartitionStreamingSource.h  
TargetBehavior EStreamingSourceTargetBehavior Defines how TargetGrids/TargetHLODLayers will be applied to this streaming source. WorldPartition/WorldPartitionStreamingSource.h  
TargetGrids TSet< FName > When set, this will change how this streaming source is applied to the provided runtime streaming grids based on the TargetBehavior. WorldPartition/WorldPartitionStreamingSource.h  
TargetHLODLayers TSet< FSoftObjectPath > When set, this will change how this streaming source is applied to the provided HLODLayers based on the TargetBehavior. WorldPartition/WorldPartitionStreamingSource.h  
TargetState EStreamingSourceTargetState Target streaming state. WorldPartition/WorldPartitionStreamingSource.h  
Velocity FVector Source velocity (computed automatically). WorldPartition/WorldPartitionStreamingSource.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ExtraAngle float   WorldPartition/WorldPartitionStreamingSource.h  
ExtraRadius float Used internally for server streaming WorldPartition/WorldPartitionStreamingSource.h  
Hash2D uint32 Hash of streaming source (used to detect changes) WorldPartition/WorldPartitionStreamingSource.h  
Hash3D uint32   WorldPartition/WorldPartitionStreamingSource.h  
QuantizedLocation FVector Source values used for hash computations. WorldPartition/WorldPartitionStreamingSource.h  
QuantizedRotation FRotator   WorldPartition/WorldPartitionStreamingSource.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FBox CalcBounds ( float InGridLoadingRange,
FName InGridName,
bool bCalcIn2D
) const

 Returns a box encapsulating all shapes. WorldPartition/WorldPartitionStreamingSource.h  

void ForEachShape ( float InGridLoadingRange,
bool bInProjectIn2D,
TFunctionRef< void(const FSphericalSector&)> InOperation
) const

 Helper method that iterates over all shapes. WorldPartition/WorldPartitionStreamingSource.h  

void ForEachShape ( float InGridLoadingRange,
FName InGridName,
bool bInProjectIn2D,
TFunctionRef< void(const FSphericalSector&)> InOperation
) const

 Helper method that iterates over all shapes affecting a specific grid. WorldPartition/WorldPartitionStreamingSource.h  

FColor GetDebugColor()

   WorldPartition/WorldPartitionStreamingSource.h  

uint32 GetHash ( bool bInclude3DInformation
) const

   WorldPartition/WorldPartitionStreamingSource.h  

FString ToString()

   WorldPartition/WorldPartitionStreamingSource.h  

void UpdateHash()

   WorldPartition/WorldPartitionStreamingSource.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetLocationQuantization()

   WorldPartition/WorldPartitionStreamingSource.h  

static int32 GetRotationQuantization()

   WorldPartition/WorldPartitionStreamingSource.h  

Operators

Name Remarks Include Path Unreal Specifiers
  WorldPartition/WorldPartitionStreamingSource.h  
  WorldPartition/WorldPartitionStreamingSource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page