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

Inheritance Hierarchy

References

   
Module UserToolBoxCore
Header /Engine/Plugins/Experimental/UserToolBoxCore/Source/UserToolBoxCore/Public/UTBBaseTab.h
Include #include "UTBBaseTab.h"

Syntax

UCLASS&40;&41;  
class UUserToolBoxBaseTab : public UDataAsset

Remarks

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.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere assetregistrysearchable bool bIsVisibleInDrawer  
Public variable UProperty Category, EditAnywhere assetregistrysearchable bool bIsVisibleInViewportOverlay  
Public variable UProperty Category, EditAnywhere assetregistrysearchable bool bIsVisibleInWindowsMenu  
Public variable UProperty Category, EditAnywhere, Meta TObjectPtr< UClass > DefaultCommandUIOverride The default override for each command ( does not override ui command specified in the command)
Public variable UProperty Category, EditAnywhere bool IsSettingShouldBeVisible Should the setting's icon be visible on the top right of the tab ( for easy access)
Public variable UProperty Category, EditAnywhere assetregistrysearchable FString Name The name of the toolbox
Public variable UProperty Category, EditAnywhere TSubclassOf< UUTBDefaultUITemplate > TabUI The UI template to use to render this tab

Functions

  Type Name Description
Public function Const bool

ContainsCommand ( const UUTBBaseCommand* Command
)

 Return the presence of the command in the tab
Public function TSharedPtr< SWidget >

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

 Function to generate the raw widget of the tab.
Public function TSharedPtr< SWidget > Function to generate the raw widget of the tab.
Public function UUTBTabSection *

GetOrCreateSection ( const FString SectionName
)

 Return the section with the specified name or create it if it does not exist
Public function UUTBTabSection * Return the placeholder section
Public function UUTBTabSection *

GetSection ( const FString SectionName
)

 Return the section with the specified name
Public function TArray< UUTBTabSection * > Get all the section of that tab
Public function void

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

 Insert a command at a specific location in a specific section
Public function 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
Public function void

MoveSectionAfterExistingSection ( const FString SectionToMoveName,
const FString SectionToTargetName
)

  
Public function void Registering the command list
Public function void Remove a command
Public function void

RemoveCommand ( const FString SectionName,
const int Index
)

 Remove a command at a specific location in a specific section
Public function void

RemoveCommandFromSection ( UUTBBaseCommand* Command,
const FString SectionName
)

 Remove a command contained in a specific section
Public function void  
Public function void Remove a section
Public function void

RemoveSection ( const FString SectionName
)

 Remove a section with a specific name
Public function void

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

 Replace a batch of command
Public function void Unregistering the command list

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Constants

Name Description
PlaceHolderSectionName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page