Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > PlacementMode > FPlacementModeModule

Light Theme

Dark Theme

FPlacementModeModule

Windows

MacOS

Linux

Inheritance Hierarchy

IModuleInterface

IPlacementModeModule

FPlacementModeModule

References

Module	PlacementMode
Header	/Engine/Source/Editor/PlacementMode/Public/PlacementModeModule.h
Include	#include "PlacementModeModule.h"

Syntax

class FPlacementModeModule : public IPlacementModeModule

Functions

		Name	Description
	void	OnAssetAdded ( const FAssetData& AssetData )
	void	OnAssetRemoved ( const FAssetData& )
	void	OnAssetRenamed ( const FAssetData& AssetData, const FString& OldObjectPath )

Overridden from IPlacementModeModule

	Name	Description
void	AddToRecentlyPlaced ( UObject* Asset, UActorFactory* FactoryUsed )	Add the specified asset to the recently placed items list
void	AddToRecentlyPlaced ( const TArray< UObject* >& Pla..., UActorFactory* FactoryUsed )	Add the specified assets to the recently placed items list
void	BroadcastStartedPlacing ( const TArray< UObject* >& Ass... )
void	BroadcastStoppedPlacing ( bool bWasSuccessfullyPlaced )
TSharedRef< ...	CreatePlacementModeBrowser()	Creates the placement browser widget
void	GetFilteredItemsForCategory ( FName Category, TArray< TSharedPtr< FPlaceableItem ..., TFunctionRef< bool... )	Get all the items in a given category, filtered by the specified predicate
void	GetItemsForCategory ( FName Category, TArray< TSharedPtr< FPlaceableItem ... )	Get all the items in a given category, unsorted
const TArray...	GetRecentlyPlaced()	Get a copy of the recently placed items list
const FPlace...	GetRegisteredPlacementCategory ( FName UniqueHandle )	Retrieve an already registered category
void	GetSortedCategories ( TArray< FPlacementCategoryInfo >& ... )	Populate the specified array with all registered category information, sorted by SortOrder
FOnAllPlacea...	OnAllPlaceableAssetsChanged()
FOnPlacement...	OnPlacementModeCategoryRefreshed()
FOnRecentlyP...	OnRecentlyPlacedChanged()
FOnStartedPl...	OnStartedPlacing()
FOnStoppedPl...	OnStoppedPlacing()
void	RegenerateItemsForCategory ( FName Category )	Instruct the category associated with the specified unique handle that it should regenerate its items
TOptional< F...	RegisterPlaceableItem ( FName CategoryName, const TSharedRef< FPlaceableItem > ... )	Register a new placeable item for the specified category
bool	RegisterPlacementCategory ( const FPlacementCategoryInfo& Info )	Register a new category of placement items
void	UnregisterPlaceableItem ( FPlacementModeID ID )	Unregister a previously registered placeable item
void	UnregisterPlacementCategory ( FName Handle )	Unregister a previously registered category

Overridden from IModuleInterface

		Name	Description
	void	PreUnloadCallback()	Called before the module is unloaded, right before the module object is destroyed.
	void	StartupModule()	Called right after the module's DLL has been loaded and the module object has been created

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss