Navigation
API > API/Editor > API/Editor/PlacementMode
| Name | IPlacementModeModule |
| Type | class |
| Header File | /Engine/Source/Editor/PlacementMode/Public/IPlacementModeModule.h |
| Include Path | #include "IPlacementModeModule.h" |
Syntax
class IPlacementModeModule : public IModuleInterface
Implements Interfaces
Derived Classes
Classes
| Name | Remarks |
|---|---|
| FOnAllPlaceableAssetsChanged | |
| FOnPlaceableItemFilteringChanged | |
| FOnPlacementModeCategoryListChanged | |
| FOnPlacementModeCategoryRefreshed | |
| FOnRecentlyPlacedChanged |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TPlaceableItemPredicate | TFunction< bool(const TSharedPtr< FPlaceableItem > &)> | IPlacementModeModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddToRecentlyPlaced
(
UObject* Asset, |
IPlacementModeModule.h | ||
virtual void AddToRecentlyPlaced
(
const TArray< UObject* >& Assets, |
IPlacementModeModule.h | ||
void AddToRecentlyPlaced
(
const TArray< UObject* >& Assets, |
Add the specified assets to the recently placed items list | IPlacementModeModule.h | |
void AddToRecentlyPlaced
(
UObject* Asset, |
Add the specified asset to the recently placed items list | IPlacementModeModule.h | |
TSharedRef< SWidget > CreatePlacementModeBrowser
(
TSharedRef< SDockTab > ParentTab |
Creates the placement browser widget | IPlacementModeModule.h | |
TSharedRef< FNamePermissionList > & GetCategoryPermissionList() |
Placement categories deny list | IPlacementModeModule.h | |
void GetFilteredItemsForCategory
(
FName Category, |
Get all items in a given category, system and user filtered, unsorted | IPlacementModeModule.h | |
void GetItemsForCategory
(
FName Category, |
Get all items in a given category, system filtered, unsorted | IPlacementModeModule.h | |
void GetItemsWithNamesForCategory
(
FName CategoryName, |
Puts the items that should be shown for Category CategoryName in the OutItems array | IPlacementModeModule.h | |
const TArray< FActorPlacementInfo > & GetRecentlyPlaced() |
Get a copy of the recently placed items | IPlacementModeModule.h | |
const FPlacementCategoryInfo * GetRegisteredPlacementCategory
(
FName UniqueHandle |
Retrieve an already registered category | IPlacementModeModule.h | |
void GetSortedCategories
(
TArray< FPlacementCategoryInfo >& OutCategories |
Get all placement categories that aren't denied, sorted by SortOrder | IPlacementModeModule.h | |
FOnAllPlaceableAssetsChanged & OnAllPlaceableAssetsChanged() |
IPlacementModeModule.h | ||
FOnPlaceableItemFilteringChanged & OnPlaceableItemFilteringChanged() |
IPlacementModeModule.h | ||
FOnPlacementModeCategoryListChanged & OnPlacementModeCategoryListChanged() |
IPlacementModeModule.h | ||
FOnPlacementModeCategoryRefreshed & OnPlacementModeCategoryRefreshed() |
IPlacementModeModule.h | ||
FOnRecentlyPlacedChanged & OnRecentlyPlacedChanged() |
IPlacementModeModule.h | ||
void RegenerateItemsForCategory
(
FName Category |
Instruct the category associated with the specified unique handle that it should regenerate its items | IPlacementModeModule.h | |
TOptional< FPlacementModeID > RegisterPlaceableItem
(
FName CategoryName, |
Register a new placeable item for the specified category | IPlacementModeModule.h | |
bool RegisterPlaceableItemFilter
(
TPlaceableItemPredicate Predicate, |
Registers system-level (not user) filtering for placeable items. | IPlacementModeModule.h | |
bool RegisterPlacementCategory
(
const FPlacementCategoryInfo& Info |
Register a new category of placement items | IPlacementModeModule.h | |
void UnregisterPlaceableItem
(
FPlacementModeID ID |
Unregister a previously registered placeable item | IPlacementModeModule.h | |
void UnregisterPlaceableItemFilter
(
FName OwnerName |
Registers system-level (not user) filtering for placeable items. | IPlacementModeModule.h | |
void UnregisterPlacementCategory
(
FName Handle |
Unregister a previously registered category | IPlacementModeModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IPlacementModeModule & Get () |
Singleton-like access to this module's interface. | IPlacementModeModule.h | |
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | IPlacementModeModule.h |