Navigation
Unreal Engine C++ API Reference > Runtime > Engine > Engine
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UWorldComposition
References
Module | Engine |
Header | /Engine/Source/Runtime/Engine/Classes/Engine/WorldComposition.h |
Include | #include "Engine/WorldComposition.h" |
Syntax
UCLASS (Config=Engine, MinimalAPI)
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 | |
---|---|---|---|
![]() ![]() ![]() |
bool | bLoadAllTilesDuringCinematic | Whether all distance dependent tiles should be loaded and visible during cinematic. |
![]() ![]() |
bool | bLockTilesLocation | Whether all tiles locations are locked. |
![]() ![]() ![]() |
bool | bRebaseOriginIn3DSpace | Whether to rebase origin in 3D space, otherwise only on XY plane. |
![]() |
bool | bTemporallyDisableOriginTracking | |
![]() |
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 |
![]() ![]() ![]() |
float | RebaseOriginDistance | Maximum distance to current view point where we should initiate origin rebasing. |
![]() ![]() ![]() |
TArray< TObjectPtr< ULevelStreaming > > | TilesStreaming | Streaming level objects for each tile. |
![]() ![]() ![]() |
double | TilesStreamingTimeThreshold | Time threshold between tile streaming state changes. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
UWorldComposition
(
const FObjectInitializer& ObjectInitializer |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | CollectTilesToCook
(
TArray< FString >& PackageNames |
Collect tiles package names to cook |
![]() ![]() |
bool | DoesTileExists
(
const FName& TilePackageName |
|
![]() |
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 |
![]() ![]() |
TArray< FWorldTileLayer > | ||
![]() ![]() |
void | GetDistanceVisibleLevels
(
const FVector* InLocations, |
|
![]() ![]() |
void | GetDistanceVisibleLevels
(
const FVector& InLocation, |
Returns currently visible and hidden levels based on distance based streaming |
![]() ![]() |
FBox | GetLevelBounds
(
ULevel* InLevel |
|
![]() ![]() |
FIntVector | GetLevelOffset
(
ULevel* InLevel |
|
![]() ![]() |
FWorldTileInfo | GetTileInfo
(
const FName& InPackageName |
|
![]() |
FTilesList & | GetTilesList () |
|
![]() ![]() |
UWorld * | GetWorld () |
|
![]() ![]() |
FString | GetWorldRoot () |
|
![]() ![]() |
bool | IsDistanceDependentLevel
(
FName PackageName |
|
![]() |
void | OnLevelAddedToWorld
(
ULevel* InLevel |
Handles level is being added to world |
![]() ![]() |
void | OnLevelPostLoad
(
ULevel* InLevel |
Handles level OnPostLoad event |
![]() |
void | OnLevelPostSave
(
ULevel* InLevel |
Handles level just after it was saved to disk |
![]() |
void | OnLevelPreSave
(
ULevel* InLevel |
Handles level just before it going to be saved to disk |
![]() |
void | OnLevelRemovedFromWorld
(
ULevel* InLevel |
Handles level is being removed from the world |
![]() |
void | OnTileInfoUpdated
(
const FName& InPackageName, |
Notification from World browser about changes in tile info structure |
![]() |
void | ||
![]() |
void | Rescan () |
Scans world root folder for relevant packages and initializes world composition structures |
![]() |
void | RestoreDirtyTilesInfo
(
const FTilesList& TilesPrevState |
Restores dirty tiles information after world composition being rescanned |
![]() |
bool | UpdateEditorStreamingState
(
const FVector& InLocation |
Simulates streaming in editor world, only visibility, no loading/unloading, no LOD sub-levels |
![]() |
void | UpdateStreamingState
(
const FVector& InLocation |
Adds or removes level streaming objects to world based on distance settings from current view point |
![]() |
void | Adds or removes level streaming objects to world based on distance settings from players current view | |
![]() |
void | UpdateStreamingState
(
const FVector* InLocation, |
|
![]() |
void | UpdateStreamingStateCinematic
(
const FVector* InLocation, |
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 |