UBlueprintPaletteFavorites

Unreal Engine C++ API Reference > Editor > Kismet

Inheritance Hierarchy

References

   
Module Kismet
Header /Engine/Source/Editor/Kismet/Classes/BlueprintPaletteFavorites.h
Include #include "BlueprintPaletteFavorites.h"

Syntax

class UBlueprintPaletteFavorites : public [UObject](API\Runtime\CoreUObject\UObject\UObject)  

Variables

Type Name Description
TArray< FFavori... CurrentFavorites A list of favorites that is constructed in PostLoad() (either from a profile or the user's set of CustomFavorites).
FString CurrentProfile Users could load pre-existing profiles (intended to share favorites, and hook into tutorials).
TArray< FString... CustomFavorites A list of strings that are used to identify specific palette actions.
FBlueprintFavor... OnFavoritesUpdated  

Constructors

Type Name Description
  UBlueprintPaletteFavorites ( const FObjectInitializer& ObjectIn... )  

Functions

Type Name Description
void AddFavorite ( TSharedPtr< FEdGraphSchemaAction > ... ) Adds the specified action to the current favorites list (fails if the action action can't be favorited, or if the favorite already exists).
void AddFavorites ( TArray< TSharedPtr< FEdGraphSchemaA... ) Adds the specified actions to the current favorites list.
bool CanBeFavorited ( TSharedPtr< FEdGraphSchemaAction > ... ) Not all palette actions can be turned into a favorite. This method is meant to catch those cases.
void ClearAllFavorites () Removes every single favorite and sets the user's profile to a custom one (if it isn't already).
FString cons... GetCurrentProfile () Gets the user's currently set profile.
bool IsFavorited ( TSharedPtr< FEdGraphSchemaAction > ... ) This method can be used to see if a specified action is already favorited by the user.
bool IsFavorited ( FBlueprintActionInfo& BlueprintAct... )  
bool IsFavorited ( UBlueprintNodeSpawner const* B... )  
bool IsUsingCustomProfile () Provides any easy way to see if the user is currently using their own manual profile (one they set up through the tool).
void LoadProfile ( FString const& ProfileName ) Throws out all current favorites and loads in ones for the specified profile (explicitly laid out in the editor .ini file).
void RemoveFavorite ( TSharedPtr< FEdGraphSchemaAction > ... ) Removes the specified action to the current favorites list (if it's there).
void RemoveFavorites ( TArray< TSharedPtr< FEdGraphSchemaA... ) Remove the specified actions from the current favorites list.

Overridden from UObject

Type Name Description
void PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... ) Called when a property on this object has been modified externally
void PostInitProperties () Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Classes

Type Name Description
Public class FBlueprintFavoritesUpdatedEvent A event for users to hook into (specifically the UI), so they can be notified when a change to the favorites has been made.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library