Navigation
API > API/Runtime > API/Runtime/Engine
A mini map to preview the world in world partition window. (editor-only)
| Name | AWorldPartitionMiniMap |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/WorldPartition/WorldPartitionMiniMap.h |
| Include Path | #include "WorldPartition/WorldPartitionMiniMap.h" |
Syntax
UCLASS (
HideCategories=(Actor, Advanced, Display, Events, Object, Attachment, Info, Input, Blueprint, Layers, Tags, Replication, Physics, Cooking, Networking, LevelInstance),
NotPlaceable, MinimalAPI)
class AWorldPartitionMiniMap : public AInfo
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → AInfo → AWorldPartitionMiniMap
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AWorldPartitionMiniMap
(
const FObjectInitializer& ObjectInitializer |
WorldPartition/WorldPartitionMiniMap.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BuilderCellSize | int32 | Size of the loading region that will be used when iterating over the whole map during the minimap build process. | WorldPartition/WorldPartitionMiniMap.h |
|
| CaptureSource | TEnumAsByte< ESceneCaptureSource > | Specifies which component of the scene rendering should be output to the minimap texture. | WorldPartition/WorldPartitionMiniMap.h |
|
| CaptureWarmupFrames | uint32 | Number of frames to render before each capture in order to warmup various rendering systems (VT/Nanite/etc). | WorldPartition/WorldPartitionMiniMap.h |
|
| ExcludedDataLayers | TSet< TObjectPtr< UDataLayerAsset > > | Datalayers excluded from MiniMap rendering | WorldPartition/WorldPartitionMiniMap.h |
|
| MiniMapTexture | TObjectPtr< UTexture2D > | MiniMap Texture for displaying on world partition window | WorldPartition/WorldPartitionMiniMap.h |
|
| MiniMapWorldBounds | FBox | WorldBounds for MinMapTexture | WorldPartition/WorldPartitionMiniMap.h |
|
| UVOffset | FBox2D | UVOffset used to setup Virtual Texture | WorldPartition/WorldPartitionMiniMap.h |
|
| WorldUnitsPerPixel | int32 | Target world units per pixel for the minimap texture. | WorldPartition/WorldPartitionMiniMap.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GetMiniMapResolution
(
int32& OutMinimapImageSizeX, |
WorldPartition/WorldPartitionMiniMap.h | ||
FBox GetMiniMapWorldBounds() |
WorldPartition/WorldPartitionMiniMap.h |
Overridden from AActor
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CheckForErrors() |
Function that gets called from within Map_Check to allow this actor to check itself for any potential errors and register them with map check dialog. | WorldPartition/WorldPartitionMiniMap.h | |
virtual bool IsLockLocation() |
Returns true if actor location should be locked. | WorldPartition/WorldPartitionMiniMap.h | |
virtual bool IsUserManaged() |
Used to know if actor supports some editor operations. (Delete, Replace) | WorldPartition/WorldPartitionMiniMap.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsEditorOnly() |
WorldPartition/WorldPartitionMiniMap.h | ||
virtual void PostLoad() |
WorldPartition/WorldPartitionMiniMap.h |