1. Epic GamesDeveloper
  3. UUserToolBoxBaseTab

UUserToolBoxBaseTab

[UUserToolBoxBaseTab](API\Plugins\UserToolBoxCore\UUserToolBoxBaseTab) is the class that represent a configurable tab This class contains the name of the tab and a section's list.

API > API/Plugins > API/Plugins/UserToolBoxCore

UUserToolBoxBaseTab is the class that represent a configurable tab This class contains the name of the tab and a section's list. In that class, you can also specified an UTBUICommand to override "by default" the UI of each command. Note: The override define in the command override the UI override define in the tab. This is the class serialized as an asset.

   
Name UUserToolBoxBaseTab
Type class
Header File /Engine/Plugins/Experimental/UserToolBoxCore/Source/UserToolBoxCore/Public/UTBBaseTab.h
Include Path #include "UTBBaseTab.h"

Syntax

UCLASS ()  
class UUserToolBoxBaseTab : public UDataAsset

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
PlaceHolderSectionName const FName   UTBBaseTab.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsVisibleInDrawer bool   UTBBaseTab.h
  • EditAnywhere
  • Category="Command Tab"
  • AssetRegistrySearchable
bIsVisibleInViewportOverlay bool   UTBBaseTab.h
  • EditAnywhere
  • Category="Command Tab"
  • AssetRegistrySearchable
bIsVisibleInWindowsMenu bool   UTBBaseTab.h
  • EditAnywhere
  • Category="Command Tab"
  • AssetRegistrySearchable
DefaultCommandUIOverride TObjectPtr< UClass > The default override for each command ( does not override ui command specified in the command) UTBBaseTab.h
  • EditAnywhere
  • Meta=(MustImplement="/Script/UserToolBoxCore.UTBUICommand", AllowAbstract="false")
  • Category="Command Tab"
IsSettingShouldBeVisible bool Should the setting's icon be visible on the top right of the tab ( for easy access) UTBBaseTab.h
  • EditAnywhere
  • Category="Command Tab"
Name FString The name of the toolbox UTBBaseTab.h
  • EditAnywhere
  • Category="Command Tab"
  • AssetRegistrySearchable
TabUI TSubclassOf< UUTBDefaultUITemplate > The UI template to use to render this tab UTBBaseTab.h
  • EditAnywhere
  • Category="Command Tab"

Protected

Name Type Remarks Include Path Unreal Specifiers
OnObjectReplacedHandle FDelegateHandle   UTBBaseTab.h  
PlaceholderSection TObjectPtr< UUTBTabSection > The placeholder section UTBBaseTab.h  
Sections TArray< TObjectPtr< UUTBTabSection > > The array of sections UTBBaseTab.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   UTBBaseTab.h  

bool ContainsCommand ( const UUTBBaseCommand* Command
) const

 Return the presence of the command in the tab UTBBaseTab.h  

TSharedPtr< SWidget > GenerateUI ( const TSubclassOf< UUTBDefaultUITemplate > TabUiClass,
const FUITemplateParameters& Params
)

   UTBBaseTab.h  

TSharedPtr< SWidget > GenerateUI ()

 Function to generate the raw widget of the tab. UTBBaseTab.h  

UUTBTabSection * GetOrCreateSection ( const FString SectionName
)

 Return the section with the specified name or create it if it does not exist UTBBaseTab.h  

UUTBTabSection * GetPlaceHolderSection()

 Return the placeholder section UTBBaseTab.h  

UUTBTabSection * GetSection ( const FString SectionName
)

 Return the section with the specified name UTBBaseTab.h  

TArray< UUTBTabSection * > GetSections()

 Get all the section of that tab UTBBaseTab.h  

void InsertCommand ( const UUTBBaseCommand* InCommand,
const FString SectionName,
const int Index
)

 Insert a command at a specific location in a specific section UTBBaseTab.h  

void InsertCommandFromClass ( const TSubclassOf< UUTBBaseCommand > InClass,
const FString Section,
const int Index
)

 Insert a default command from the class at a specific location in a specific section UTBBaseTab.h  

void MoveSectionAfterExistingSection ( const FString SectionToMoveName,
const FString SectionToTargetName
)

   UTBBaseTab.h  

virtual void PostLoad()

   UTBBaseTab.h  

void RegisterCommand()

 Registering the command list UTBBaseTab.h  

void RemoveCommand ( UUTBBaseCommand* Command
)

 Remove a command UTBBaseTab.h  

void RemoveCommand ( const FString SectionName,
const int Index
)

 Remove a command at a specific location in a specific section UTBBaseTab.h  

void RemoveCommandFromSection ( UUTBBaseCommand* Command,
const FString SectionName
)

 Remove a command contained in a specific section UTBBaseTab.h  

void RemoveInvalidCommand()

   UTBBaseTab.h  

void RemoveSection ( UUTBTabSection* Section
)

 Remove a section UTBBaseTab.h  

void RemoveSection ( const FString SectionName
)

 Remove a section with a specific name UTBBaseTab.h  

void ReplaceCommands ( const TMap< UObject*, UObject* >& ReplacementMap
)

 Replace a batch of command UTBBaseTab.h  

void UnregisterCommand()

 Unregistering the command list UTBBaseTab.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page