Navigation
API > API/Editor > API/Editor/PlacementMode
| Name | FPlacementModeModule |
| Type | class |
| Header File | /Engine/Source/Editor/PlacementMode/Public/PlacementModeModule.h |
| Include Path | #include "PlacementModeModule.h" |
Syntax
class FPlacementModeModule : public IPlacementModeModule
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPlacementModeModule() |
PlacementModeModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AllPlaceableAssetsChanged | FOnAllPlaceableAssetsChanged | PlacementModeModule.h | ||
| Categories | TMap< FName, FPlacementCategory > | PlacementModeModule.h | ||
| CategoryPermissionList | TSharedRef< FNamePermissionList > | PlacementModeModule.h | ||
| ContentPaletteFiltersExtenders | TArray< TSharedPtr< FExtender > > | PlacementModeModule.h | ||
| ManuallyCreatedPlaceableItems | TMap< FActorPlacementInfo, TWeakPtr< FPlaceableItem > > | When users explicitly add placeable items, they may add custom icons/descriptions, so we need to store extra data to be able to recreate the placeable item in "recently placed" | PlacementModeModule.h | |
| PaletteExtenders | TArray< TSharedPtr< FExtender > > | PlacementModeModule.h | ||
| PlaceableItemFilteringChanged | FOnPlaceableItemFilteringChanged | PlacementModeModule.h | ||
| PlaceableItemPredicates | TMap< FName, TPlaceableItemPredicate > | PlacementModeModule.h | ||
| PlacementModeCategoryListChanged | FOnPlacementModeCategoryListChanged | PlacementModeModule.h | ||
| PlacementModeCategoryRefreshed | FOnPlacementModeCategoryRefreshed | PlacementModeModule.h | ||
| RecentlyPlaced | TArray< FActorPlacementInfo > | PlacementModeModule.h | ||
| RecentlyPlacedChanged | FOnRecentlyPlacedChanged | PlacementModeModule.h |
Functions
Public
Overridden from IPlacementModeModule
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddToRecentlyPlaced
(
UObject* Asset, |
PlacementModeModule.h | ||
virtual void AddToRecentlyPlaced
(
UObject* Asset, |
Add the specified asset to the recently placed items list | PlacementModeModule.h | |
virtual void AddToRecentlyPlaced
(
const TArray< UObject* >& Assets, |
PlacementModeModule.h | ||
virtual void AddToRecentlyPlaced
(
const TArray< UObject* >& PlacedObjects, |
Add the specified assets to the recently placed items list | PlacementModeModule.h | |
virtual TSharedRef< SWidget > CreatePlacementModeBrowser
(
TSharedRef< SDockTab > ParentTab |
Creates the placement browser widget | PlacementModeModule.h | |
virtual TSharedRef< FNamePermissionList > & GetCategoryPermissionList() |
Placement categories deny list | PlacementModeModule.h | |
virtual void GetFilteredItemsForCategory
(
FName Category, |
Get all items in a given category, system and user filtered, unsorted | PlacementModeModule.h | |
virtual void GetItemsForCategory
(
FName Category, |
Get all items in a given category, system filtered, unsorted | PlacementModeModule.h | |
virtual void GetItemsWithNamesForCategory
(
FName CategoryName, |
Puts the FPlaceableItem instances with names matching the FNames in ItemNames for the placement category CategoryName in the OutItems TArray | PlacementModeModule.h | |
virtual const TArray< FActorPlacementInfo > & GetRecentlyPlaced() |
Get a copy of the recently placed items list | PlacementModeModule.h | |
virtual const FPlacementCategoryInfo * GetRegisteredPlacementCategory
(
FName UniqueHandle |
Retrieve an already registered category | PlacementModeModule.h | |
virtual void GetSortedCategories
(
TArray< FPlacementCategoryInfo >& OutCategories |
Get all placement categories that aren't denied, sorted by SortOrder | PlacementModeModule.h | |
virtual FOnAllPlaceableAssetsChanged & OnAllPlaceableAssetsChanged() |
PlacementModeModule.h | ||
virtual FOnPlaceableItemFilteringChanged & OnPlaceableItemFilteringChanged() |
PlacementModeModule.h | ||
virtual FOnPlacementModeCategoryListChanged & OnPlacementModeCategoryListChanged() |
PlacementModeModule.h | ||
virtual FOnPlacementModeCategoryRefreshed & OnPlacementModeCategoryRefreshed() |
PlacementModeModule.h | ||
virtual FOnRecentlyPlacedChanged & OnRecentlyPlacedChanged() |
PlacementModeModule.h | ||
virtual void RegenerateItemsForCategory
(
FName Category |
Instruct the category associated with the specified unique handle that it should regenerate its items | PlacementModeModule.h | |
virtual TOptional< FPlacementModeID > RegisterPlaceableItem
(
FName CategoryName, |
Register a new placeable item for the specified category | PlacementModeModule.h | |
virtual bool RegisterPlaceableItemFilter
(
TPlaceableItemPredicate Predicate, |
Registers system-level (not user) filtering for placeable items. | PlacementModeModule.h | |
virtual bool RegisterPlacementCategory
(
const FPlacementCategoryInfo& Info |
Register a new category of placement items | PlacementModeModule.h | |
virtual void UnregisterPlaceableItem
(
FPlacementModeID ID |
Unregister a previously registered placeable item | PlacementModeModule.h | |
virtual void UnregisterPlaceableItemFilter
(
FName OwnerName |
Registers system-level (not user) filtering for placeable items. | PlacementModeModule.h | |
virtual void UnregisterPlacementCategory
(
FName Handle |
Unregister a previously registered category | PlacementModeModule.h |
Overridden from IModuleInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PreUnloadCallback() |
Called before the module is unloaded, right before the module object is destroyed. | PlacementModeModule.h | |
virtual void StartupModule() |
Called right after the module's DLL has been loaded and the module object has been created | PlacementModeModule.h |