1. Epic GamesDeveloper
  3. UWorldComposition

UWorldComposition

WorldComposition represents world structure:

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

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/WorldComposition.h
Include #include "Engine/WorldComposition.h"

Syntax

class UWorldComposition : public UObject

Remarks

WorldComposition represents world structure:

  • Holds list of all level packages participating in this world and theirs base parameters (bounding boxes, offset from origin)
  • Holds list of streaming level objects to stream in and out based on distance from current view point
  • Handles properly levels repositioning during level loading and saving

Variables

  Type Name Description
Public variable bool bLoadAllTilesDuringCinematic Whether all distance dependent tiles should be loaded and visible during cinematic.
Public variable bool bLockTilesLocation Whether all tiles locations are locked.
Public variable bool bRebaseOriginIn3DSpace Whether to rebase origin in 3D space, otherwise only on XY plane.
Public variable bool bTemporarilyDisableOriginTracking Hack for a World Browser to be able to temporarily show hidden levels regardless of current world origin and without offsetting them temporarily
Public variable float RebaseOriginDistance Maximum distance to current view point where we should initiate origin rebasing.
Public variable TArray< TObjectPtr< ULevelStreaming > > TilesStreaming Streaming level objects for each tile.
Public variable double TilesStreamingTimeThreshold Time threshold between tile streaming state changes.

Constructors

  Type Name Description
Public function  

UWorldComposition ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void

CollectTilesToCook ( TArray< FString >& PackageNames
)

 Collect tiles package names to cook
Public function Const bool

DoesTileExists ( const FName& TilePackageName
)

  
Public function void

EvaluateWorldOriginLocation ( const FVector& ViewLocation
)

 Evaluates current world origin location against provided view location Issues request for world origin rebasing in case location is far enough from current origin
Public function Const TArray< FWorldTileLayer >  
Public function Const void

GetDistanceVisibleLevels ( const FVector* InLocations,
int32 Num,
TArray< FDistanceVisibleLevel >& OutVisibleLevels,
TArray< FDistanceVisibleLevel >& OutHiddenLevels
)

 Returns currently visible and hidden levels based on distance based streaming
Public function Const void

GetDistanceVisibleLevels ( const FVector& InLocation,
TArray< FDistanceVisibleLevel >& OutVisibleLevels,
TArray< FDistanceVisibleLevel >& OutHiddenLevels
)

 Returns currently visible and hidden levels based on distance based streaming
Public function Const FBox

GetLevelBounds ( ULevel* InLevel
)

  
Public function Const FIntVector

GetLevelOffset ( ULevel* InLevel
)

  
Public function Const FWorldTileInfo

GetTileInfo ( const FName& InPackageName
)

  
Public function FTilesList &  
Public function Const UWorld *  
Public function Const FString  
Public function Const bool  
Public function void Handles level is being added to world
Public function Static void

OnLevelPostLoad ( ULevel* InLevel
)

 Handles level OnPostLoad event
Public function void

OnLevelPostSave ( ULevel* InLevel
)

 Handles level just after it was saved to disk
Public function void

OnLevelPreSave ( ULevel* InLevel
)

 Handles level just before it going to be saved to disk
Public function void Handles level is being removed from the world
Public function void

OnTileInfoUpdated ( const FName& InPackageName,
const FWorldTileInfo& InInfo
)

 Notification from World browser about changes in tile info structure
Public function void  
Public function void

Rescan ()

 Scans world root folder for relevant packages and initializes world composition structures
Public function void

RestoreDirtyTilesInfo ( const FTilesList& TilesPrevState
)

 Restores dirty tiles information after world composition being rescanned
Public function bool

UpdateEditorStreamingState ( const FVector& InLocation
)

 Simulates streaming in editor world, only visibility, no loading/unloading, no LOD sub-levels
Public function void

UpdateStreamingState ( const FVector& InLocation
)

 Adds or removes level streaming objects to world based on distance settings from current view point
Public function void Adds or removes level streaming objects to world based on distance settings from players current view
Public function void

UpdateStreamingState ( const FVector* InLocation,
int32 Num
)

 Adds or removes level streaming objects to world based on distance settings from players current view
Public function void

UpdateStreamingStateCinematic ( const FVector* InLocation,
int32 Num
)

 Adds or removes level streaming objects to world based on distance settings from players current view

Typedefs

Name Description
FEnableWorldCompositionEvent Event to enable/disable world composition in the world.
FTilesList  
FWorldCompositionChangedEvent Event when world composition was successfully enabled/disabled in the world.

Constants

Name Description
EnableWorldCompositionEvent  
WorldCompositionChangedEvent  

Deprecated Variables

  Type Name Description
Public variable bool bTemporallyDisableOriginTracking No longer used; use bTemporarilyDisableOriginTracking instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page