Navigation
API > API/Editor > API/Editor/Kismet
| Name | UBlueprintPaletteFavorites |
| Type | class |
| Header File | /Engine/Source/Editor/Kismet/Classes/BlueprintPaletteFavorites.h |
| Include Path | #include "BlueprintPaletteFavorites.h" |
Syntax
UCLASS (Config=EditorPerProjectUserSettings)
class UBlueprintPaletteFavorites : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UBlueprintPaletteFavorites
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UBlueprintPaletteFavorites
(
const FObjectInitializer& ObjectInitializer |
BlueprintPaletteFavorites.h |
Classes
| Name | Remarks |
|---|---|
| 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. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CurrentFavorites | TArray< FFavoritedBlueprintPaletteItem > | A list of favorites that is constructed in PostLoad() (either from a profile or the user's set of CustomFavorites). | BlueprintPaletteFavorites.h |
|
| CurrentProfile | FString | Users could load pre-existing profiles (intended to share favorites, and hook into tutorials). | BlueprintPaletteFavorites.h |
|
| CustomFavorites | TArray< FString > | A list of strings that are used to identify specific palette actions. | BlueprintPaletteFavorites.h |
|
| OnFavoritesUpdated | FBlueprintFavoritesUpdatedEvent | BlueprintPaletteFavorites.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddFavorite
(
TSharedPtr< FEdGraphSchemaAction > PaletteAction |
Adds the specified action to the current favorites list (fails if the action action can't be favorited, or if the favorite already exists). | BlueprintPaletteFavorites.h | |
void AddFavorites
(
TArray< TSharedPtr< FEdGraphSchemaAction > > PaletteActions |
Adds the specified actions to the current favorites list. | BlueprintPaletteFavorites.h | |
bool CanBeFavorited
(
TSharedPtr< FEdGraphSchemaAction > PaletteAction |
Not all palette actions can be turned into a favorite. This method is meant to catch those cases. | BlueprintPaletteFavorites.h | |
void ClearAllFavorites() |
Removes every single favorite and sets the user's profile to a custom one (if it isn't already). | BlueprintPaletteFavorites.h | |
FString const & GetCurrentProfile () |
Gets the user's currently set profile. | BlueprintPaletteFavorites.h | |
bool IsFavorited
(
const FEdGraphSchemaAction& InCurrentAction |
BlueprintPaletteFavorites.h | ||
bool IsFavorited
(
TSharedPtr< FEdGraphSchemaAction > PaletteAction |
This method can be used to see if a specified action is already favorited by the user. | BlueprintPaletteFavorites.h | |
bool IsFavorited
(
FBlueprintActionInfo& BlueprintAction |
BlueprintPaletteFavorites.h | ||
bool IsFavorited
(
UBlueprintNodeSpawner const* BlueprintAction |
BlueprintPaletteFavorites.h | ||
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). | BlueprintPaletteFavorites.h | |
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). | BlueprintPaletteFavorites.h | |
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
BlueprintPaletteFavorites.h | ||
virtual void PostInitProperties() |
BlueprintPaletteFavorites.h | ||
void RemoveFavorite
(
TSharedPtr< FEdGraphSchemaAction > PaletteAction |
Removes the specified action to the current favorites list (if it's there). | BlueprintPaletteFavorites.h | |
void RemoveFavorites
(
TArray< TSharedPtr< FEdGraphSchemaAction > > PaletteActions |
Remove the specified actions from the current favorites list. | BlueprintPaletteFavorites.h |