Navigation
API > API/Editor > API/Editor/PlacementMode
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
Constructors
| Type | Name | Description | |
|---|---|---|---|
Overridden from IPlacementModeModule
| Type | Name | Description | |
|---|---|---|---|
| void | AddToRecentlyPlaced
(
UObject* Asset, |
Add the specified asset to the recently placed items list | |
| void | AddToRecentlyPlaced
(
const TArray< UObject* >& PlacedObjects, |
Add the specified assets to the recently placed items list | |
| TSharedRef< SWidget > | CreatePlacementModeBrowser
(
TSharedRef< SDockTab > ParentTab |
Creates the placement browser widget | |
| TSharedRef< FNamePermissionList > & | Placement categories deny list | ||
| void | GetFilteredItemsForCategory
(
FName Category, |
Get all items in a given category, system and user filtered, unsorted | |
| void | GetItemsForCategory
(
FName Category, |
Get all items in a given category, system filtered, unsorted | |
| const TArray< FActorPlacementInfo > & | Get a copy of the recently placed items list | ||
| const FPlacementCategoryInfo * | GetRegisteredPlacementCategory
(
FName UniqueHandle |
Retrieve an already registered category | |
| void | GetSortedCategories
(
TArray< FPlacementCategoryInfo >& OutCategories |
Get all placement categories that aren't denied, sorted by SortOrder | |
| FOnAllPlaceableAssetsChanged & | |||
| FOnPlaceableItemFilteringChanged & | |||
| FOnPlacementModeCategoryListChanged & | |||
| FOnPlacementModeCategoryRefreshed & | |||
| FOnRecentlyPlacedChanged & | |||
| void | RegenerateItemsForCategory
(
FName Category |
Instruct the category associated with the specified unique handle that it should regenerate its items | |
| TOptional< FPlacementModeID > | RegisterPlaceableItem
(
FName CategoryName, |
Register a new placeable item for the specified category | |
| bool | RegisterPlaceableItemFilter
(
TPlaceableItemPredicate Predicate, |
Registers system-level (not user) filtering for placeable items. | |
| bool | RegisterPlacementCategory
(
const FPlacementCategoryInfo& Info |
Register a new category of placement items | |
| void | Unregister a previously registered placeable item | ||
| void | UnregisterPlaceableItemFilter
(
FName OwnerName |
Registers system-level (not user) filtering for placeable items. | |
| void | UnregisterPlacementCategory
(
FName Handle |
Unregister a previously registered category |
Overridden from IModuleInterface
| Type | Name | Description | |
|---|---|---|---|
| void | Called before the module is unloaded, right before the module object is destroyed. | ||
| void | Called right after the module's DLL has been loaded and the module object has been created |