UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Member Functions | Static Public Member Functions | List of all members
IWorldPartitionEditorModule Class Referenceabstract

#include <IWorldPartitionEditorModule.h>

+ Inheritance diagram for IWorldPartitionEditorModule:

Classes

struct  FRunBuilderParams
 
struct  FWriteHLODStatsParams
 

Public Member Functions

virtual ~IWorldPartitionEditorModule ()
 
virtual bool ConvertMap (const FString &InLongPackageName)=0
 
virtual bool RunBuilder (TSubclassOf< UWorldPartitionBuilder > BuilderClass, const FString &InLongPackageName)
 
virtual bool RunBuilder (TSubclassOf< UWorldPartitionBuilder > BuilderClass, UWorld *InWorld)
 
virtual bool RunBuilder (const FRunBuilderParams &Params)=0
 
virtual int32 GetPlacementGridSize () const =0
 
virtual int32 GetInstancedFoliageGridSize () const =0
 
virtual int32 GetMinimapLowQualityWorldUnitsPerPixelThreshold () const =0
 
virtual bool GetEnableLoadingInEditor () const =0
 
virtual void SetEnableLoadingInEditor (bool bInEnableLoadingInEditor)=0
 
virtual bool GetEnableStreamingGenerationLogOnPIE () const =0
 
virtual void SetEnableStreamingGenerationLogOnPIE (bool bInEnableLoadingInEditor)=0
 
virtual bool GetDisablePIE () const =0
 
virtual void SetDisablePIE (bool bInDisablePIE)=0
 
virtual bool GetDisableBugIt () const =0
 
virtual void SetDisableBugIt (bool bInDisableBugIt)=0
 
virtual bool GetAdvancedMode () const =0
 
virtual void SetAdvancedMode (bool bInAdvancedMode)=0
 
virtual bool GetRequireExplicitHLODLayerPartitionAssignation () const =0
 
virtual void SetRequireExplicitHLODLayerPartitionAssignation (bool bInRequireExplicitHLODLayerPartitionAssignation)=0
 
virtual bool IsEditingContentBundle () const =0
 
virtual bool IsEditingContentBundle (const FGuid &ContentBundleGuid) const =0
 
virtual bool GetShowHLODsInEditor () const =0
 
virtual void SetShowHLODsInEditor (bool bInShowHLODsInEditor)=0
 
virtual bool GetShowHLODsOverLoadedRegions () const =0
 
virtual void SetShowHLODsOverLoadedRegions (bool bInShowHLODsOverLoadedRegions)=0
 
virtual double GetHLODInEditorMinDrawDistance () const =0
 
virtual void SetHLODInEditorMinDrawDistance (double InMinDrawDistance)=0
 
virtual double GetHLODInEditorMaxDrawDistance () const =0
 
virtual void SetHLODInEditorMaxDrawDistance (double InMaxDrawDistance)=0
 
virtual bool IsHLODInEditorAllowed (UWorld *InWorld, FText *OutDisallowedReason=nullptr) const =0
 
virtual bool HasErrors (UWorld *World) const =0
 
virtual void RepairErrors (UWorld *World)=0
 
virtual bool WriteHLODStats (const FWriteHLODStatsParams &Params) const =0
 
 DECLARE_EVENT_OneParam (IWorldPartitionEditorModule, FWorldPartitionCreated, UWorld *)
 
 DECLARE_EVENT_OneParam (IWorldPartitionEditorModule, FOnPreExecuteCommandlet, FRunBuilderParams &)
 
 DECLARE_EVENT_OneParam (IWorldPartitionEditorModule, FOnExecuteCommandlet, TArray< FString > &)
 
 DECLARE_EVENT (IWorldPartitionEditorModule, FOnPostExecuteCommandlet)
 
virtual FWorldPartitionCreated & OnWorldPartitionCreated ()=0
 
virtual FOnPreExecuteCommandlet & OnPreExecuteCommandlet ()=0
 
virtual FOnExecuteCommandlet & OnExecuteCommandlet ()=0
 
virtual FOnPostExecuteCommandlet & OnPostExecuteCommandlet ()=0
 
- Public Member Functions inherited from IModuleInterface
virtual ~IModuleInterface ()
 
virtual void StartupModule ()
 
virtual void PreUnloadCallback ()
 
virtual void PostLoadCallback ()
 
virtual void ShutdownModule ()
 
virtual bool SupportsDynamicReloading ()
 
virtual bool SupportsAutomaticShutdown ()
 
virtual bool IsGameModule () const
 

Static Public Member Functions

static ENGINE_API IWorldPartitionEditorModule & Get ()
 

Detailed Description

The module holding all of the UI related pieces for WorldPartition

Constructor & Destructor Documentation

◆ ~IWorldPartitionEditorModule()

virtual IWorldPartitionEditorModule::~IWorldPartitionEditorModule ( )
inlinevirtual

Member Function Documentation

◆ ConvertMap()

virtual bool IWorldPartitionEditorModule::ConvertMap ( const FString &  InLongPackageName)
pure virtual

◆ DECLARE_EVENT()

IWorldPartitionEditorModule::DECLARE_EVENT ( IWorldPartitionEditorModule  ,
FOnPostExecuteCommandlet   
)

Triggered when the editor has launched a commandlet.

◆ DECLARE_EVENT_OneParam() [1/3]

IWorldPartitionEditorModule::DECLARE_EVENT_OneParam ( IWorldPartitionEditorModule  ,
FOnExecuteCommandlet  ,
TArray< FString > &   
)

Triggered when the editor launches a commandlet. Can be used to provide project specific arguments.

◆ DECLARE_EVENT_OneParam() [2/3]

IWorldPartitionEditorModule::DECLARE_EVENT_OneParam ( IWorldPartitionEditorModule  ,
FOnPreExecuteCommandlet  ,
FRunBuilderParams &   
)

Triggered when the editor is about to launch a commandlet. Can be used to modify the builder params.

◆ DECLARE_EVENT_OneParam() [3/3]

IWorldPartitionEditorModule::DECLARE_EVENT_OneParam ( IWorldPartitionEditorModule  ,
FWorldPartitionCreated  ,
UWorld *   
)

Triggered when a world is added.

◆ Get()

IWorldPartitionEditorModule & IWorldPartitionEditorModule::Get ( )
static

Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.

Returns
Returns singleton instance, loading the module on demand if needed

◆ GetAdvancedMode()

virtual bool IWorldPartitionEditorModule::GetAdvancedMode ( ) const
pure virtual

◆ GetDisableBugIt()

virtual bool IWorldPartitionEditorModule::GetDisableBugIt ( ) const
pure virtual

◆ GetDisablePIE()

virtual bool IWorldPartitionEditorModule::GetDisablePIE ( ) const
pure virtual

◆ GetEnableLoadingInEditor()

virtual bool IWorldPartitionEditorModule::GetEnableLoadingInEditor ( ) const
pure virtual

◆ GetEnableStreamingGenerationLogOnPIE()

virtual bool IWorldPartitionEditorModule::GetEnableStreamingGenerationLogOnPIE ( ) const
pure virtual

◆ GetHLODInEditorMaxDrawDistance()

virtual double IWorldPartitionEditorModule::GetHLODInEditorMaxDrawDistance ( ) const
pure virtual

◆ GetHLODInEditorMinDrawDistance()

virtual double IWorldPartitionEditorModule::GetHLODInEditorMinDrawDistance ( ) const
pure virtual

◆ GetInstancedFoliageGridSize()

virtual int32 IWorldPartitionEditorModule::GetInstancedFoliageGridSize ( ) const
pure virtual

◆ GetMinimapLowQualityWorldUnitsPerPixelThreshold()

virtual int32 IWorldPartitionEditorModule::GetMinimapLowQualityWorldUnitsPerPixelThreshold ( ) const
pure virtual

◆ GetPlacementGridSize()

virtual int32 IWorldPartitionEditorModule::GetPlacementGridSize ( ) const
pure virtual

◆ GetRequireExplicitHLODLayerPartitionAssignation()

virtual bool IWorldPartitionEditorModule::GetRequireExplicitHLODLayerPartitionAssignation ( ) const
pure virtual

◆ GetShowHLODsInEditor()

virtual bool IWorldPartitionEditorModule::GetShowHLODsInEditor ( ) const
pure virtual

◆ GetShowHLODsOverLoadedRegions()

virtual bool IWorldPartitionEditorModule::GetShowHLODsOverLoadedRegions ( ) const
pure virtual

◆ HasErrors()

virtual bool IWorldPartitionEditorModule::HasErrors ( UWorld *  World) const
pure virtual

Returns if the partitioned world contains errors.

◆ IsEditingContentBundle() [1/2]

virtual bool IWorldPartitionEditorModule::IsEditingContentBundle ( ) const
pure virtual

◆ IsEditingContentBundle() [2/2]

virtual bool IWorldPartitionEditorModule::IsEditingContentBundle ( const FGuid &  ContentBundleGuid) const
pure virtual

◆ IsHLODInEditorAllowed()

virtual bool IWorldPartitionEditorModule::IsHLODInEditorAllowed ( UWorld *  InWorld,
FText *  OutDisallowedReason = nullptr 
) const
pure virtual

◆ OnExecuteCommandlet()

virtual FOnExecuteCommandlet & IWorldPartitionEditorModule::OnExecuteCommandlet ( )
pure virtual

Return the commandlet execution event

◆ OnPostExecuteCommandlet()

virtual FOnPostExecuteCommandlet & IWorldPartitionEditorModule::OnPostExecuteCommandlet ( )
pure virtual

Return the commandlet post-execution event

◆ OnPreExecuteCommandlet()

virtual FOnPreExecuteCommandlet & IWorldPartitionEditorModule::OnPreExecuteCommandlet ( )
pure virtual

Return the commandlet pre-execution event

◆ OnWorldPartitionCreated()

virtual FWorldPartitionCreated & IWorldPartitionEditorModule::OnWorldPartitionCreated ( )
pure virtual

Return the world added event.

◆ RepairErrors()

virtual void IWorldPartitionEditorModule::RepairErrors ( UWorld *  World)
pure virtual

Repairs detected errors in the partitioned world.

◆ RunBuilder() [1/3]

virtual bool IWorldPartitionEditorModule::RunBuilder ( const FRunBuilderParams &  Params)
pure virtual

◆ RunBuilder() [2/3]

virtual bool IWorldPartitionEditorModule::RunBuilder ( TSubclassOf< UWorldPartitionBuilder >  BuilderClass,
const FString &  InLongPackageName 
)
inlinevirtual

◆ RunBuilder() [3/3]

virtual bool IWorldPartitionEditorModule::RunBuilder ( TSubclassOf< UWorldPartitionBuilder >  BuilderClass,
UWorld *  InWorld 
)
virtual

◆ SetAdvancedMode()

virtual void IWorldPartitionEditorModule::SetAdvancedMode ( bool  bInAdvancedMode)
pure virtual

◆ SetDisableBugIt()

virtual void IWorldPartitionEditorModule::SetDisableBugIt ( bool  bInDisableBugIt)
pure virtual

◆ SetDisablePIE()

virtual void IWorldPartitionEditorModule::SetDisablePIE ( bool  bInDisablePIE)
pure virtual

◆ SetEnableLoadingInEditor()

virtual void IWorldPartitionEditorModule::SetEnableLoadingInEditor ( bool  bInEnableLoadingInEditor)
pure virtual

◆ SetEnableStreamingGenerationLogOnPIE()

virtual void IWorldPartitionEditorModule::SetEnableStreamingGenerationLogOnPIE ( bool  bInEnableLoadingInEditor)
pure virtual

◆ SetHLODInEditorMaxDrawDistance()

virtual void IWorldPartitionEditorModule::SetHLODInEditorMaxDrawDistance ( double  InMaxDrawDistance)
pure virtual

◆ SetHLODInEditorMinDrawDistance()

virtual void IWorldPartitionEditorModule::SetHLODInEditorMinDrawDistance ( double  InMinDrawDistance)
pure virtual

◆ SetRequireExplicitHLODLayerPartitionAssignation()

virtual void IWorldPartitionEditorModule::SetRequireExplicitHLODLayerPartitionAssignation ( bool  bInRequireExplicitHLODLayerPartitionAssignation)
pure virtual

◆ SetShowHLODsInEditor()

virtual void IWorldPartitionEditorModule::SetShowHLODsInEditor ( bool  bInShowHLODsInEditor)
pure virtual

◆ SetShowHLODsOverLoadedRegions()

virtual void IWorldPartitionEditorModule::SetShowHLODsOverLoadedRegions ( bool  bInShowHLODsOverLoadedRegions)
pure virtual

◆ WriteHLODStats()

virtual bool IWorldPartitionEditorModule::WriteHLODStats ( const FWriteHLODStatsParams &  Params) const
pure virtual

Writes various HLOD stats to a file.

The documentation for this class was generated from the following files: