| UObjectBase
|
Module |
|
Header |
/Engine/Source/Developer/ToolMenus/Public/ToolMenus.h |
Include |
#include "ToolMenus.h" |
class UToolMenus : public UObject
Name | Description | ||
---|---|---|---|
|
EditMenuDelegate |
||
|
EditMenuIcon |
Icon to display in menus for command to open menu editor |
|
|
EditToolbarIcon |
Icon to display in toolbars for command to open menu editor |
|
|
ShouldDisplayExtensionPoints |
Name | Description | |
---|---|---|
|
UToolMenus() |
Name | Description | ||
---|---|---|---|
|
AddEntry ( |
Registers an entry for a menu's section |
|
|
FCustomizedT... |
AddMenuCustomization ( |
Find or add customization settings for a menu |
|
AddMenuEntryObject ( |
Registers menu entry object from blueprint/script |
|
|
AddMenuSubstitutionDuringGenerate |
Substitute one menu for another during generate but not during find or extend |
|
|
AddReferencedObjects ( |
||
|
FCustomizedT... |
AddRuntimeMenuCustomization ( |
Find or add runtime customization settings for a menu |
|
AddSection ( |
Registers a section for a menu |
|
|
AssembleMenuHierarchy |
Bake final menu including calls to construction delegates, sorting, and customization |
|
|
AssignSetTimerForNextTickDelegate ( |
Sets delegate to setup timer for deferred one off ticks |
|
|
CanSafelyRouteCall() |
Returns true if safe to call into script |
|
|
CleanupStaleWidgetsNextTick ( |
Release references to UObjects of widgets that have been deleted. |
|
|
CollectHierarchy ( |
Returns list of menus starting with root parent |
|
|
FToolMenuOwn... |
CurrentOwner() |
For advanced use cases |
|
UToolMenu &#... |
ExtendMenu ( |
Extends a menu without registering the menu or claiming ownership of it. |
|
UObject *... |
FindContext ( |
Finds a context object of a given class if it exists |
|
UToolMenu &#... |
FindMenu ( |
Finds an existing menu that has been registered or extended. |
|
FCustomizedT... |
FindMenuCustomization ( |
Find customization settings for a menu |
|
FindMenuCustomizationIndex ( |
Find index of customization settings for a menu |
|
|
FCustomizedT... |
FindRuntimeMenuCustomization ( |
Find runtime customization settings for a menu |
|
UToolMenu &#... |
GenerateMenu ( |
Create a finalized menu that combines all parents used to generate a widget. |
|
UToolMenu &#... |
GenerateMenuAsBuilder ( |
Create a finalized menu based on a custom crafted menu. Advanced special use cases only. |
|
UToolMenu &#... |
GenerateMenuOrSubMenuForEdit ( |
Generate either a menu or submenu ready for editing |
|
UToolMenu &#... |
GenerateSubMenu |
Generates sub menu by entry name in the given generated menu parent |
|
TSharedRef< ... |
GenerateWidget ( |
Generate widget from a final collapsed menu. For advanced specialized use cases. |
|
TSharedRef< ... |
GenerateWidget ( |
Generate widget from a hierarchy of menus. For advanced specialized use cases. |
|
TSharedRef< ... |
GenerateWidget ( |
Generate widget from a registered menu. Most common function used to generate new menu widgets. |
|
UToolMenus &... |
Get() |
|
|
GetEditMenusMode() |
When true, adds command to open edit menu dialog to each menu |
|
|
HandleNextTick() |
Timer function used to consolidate multiple duplicate requests into a single frame. |
|
|
IsMenuRegistered ( |
Determines if a menu has already been registered. |
|
|
IsToolMenuUIEnabled() |
Returns true if slate initialized and editor GUI is being used. |
|
|
JoinMenuPaths |
Join two paths together |
|
|
RefreshAllWidgets() |
Rebuilds all currently generated widgets next tick. |
|
|
RefreshMenuWidget ( |
Rebuilds all widgets generated from a specific menu. |
|
|
UToolMenu &#... |
RegisterMenu ( |
Registers a menu by name |
|
FDelegateHan... |
RegisterStartupCallback ( |
Delays menu registration until safe and ready Will not trigger if Slate does not end up being enabled after loading Will not trigger when running commandlet, game, dedicated server or client only |
|
RegisterStringCommandHandler ( |
Registers a new type of string based command handler. |
|
|
RemoveAllCustomizations() |
Remove all menu customizations for all menus |
|
|
RemoveCustomization ( |
Remove customization for a menu |
|
|
RemoveEntry |
Removes a menu entry from a given menu and section |
|
|
RemoveMenu ( |
Unregisters a menu by name |
|
|
RemoveSection |
Removes a section from a given menu |
|
|
RemoveSubstitutionDuringGenerate ( |
Remove substitute one menu for another during generate |
|
|
SaveCustomizations() |
Save menu customizations to ini files |
|
|
SetEditMenusMode ( |
Enables adding command to open edit menu dialog to each menu |
|
|
SetSectionLabel |
Sets a section's displayed label text. |
|
|
SetSectionPosition ( |
Sets where to insert a section into a menu when generating relative to other section names. |
|
|
SplitMenuPath |
Break apart a menu path into components |
|
|
UToolMenus &... |
TryGet() |
Try to get UToolMenus without forcing ToolMenus module to load. |
|
UnregisterOwner ( |
Unregister everything associated with the given owner without forcing ToolMenus module to load. |
|
|
UnregisterOwnerByName ( |
Removes all entries that were registered under a specific owner name |
|
|
UnRegisterStartupCallback ( |
Unregister a startup callback delegate by pointer |
|
|
UnRegisterStartupCallback ( |
Unregister a startup callback delegate by handle |
|
|
UnregisterStringCommandHandler ( |
Removes a string based command handler. |
Name | Description | ||
---|---|---|---|
|
BeginDestroy() |
Called before destroying the object. |
Name |
Description |
---|---|
FEditMenuDelegate |
Delegate that opens a menu editor |
FShouldDisplayExtensionPoints |
Displaying extension points is for debugging menus |
Name |
Description |
---|---|
bHasShutDown |
|
InternalStartupCallbackHandle |
|
Singleton |
|
StartupCallbacks |