UBlueprintPaletteFavorites

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintPaletteFavorites

References

Module

Kismet

Header

/Engine/Source/Editor/Kismet/Classes/BlueprintPaletteFavorites.h

Include

#include "BlueprintPaletteFavorites.h"

Syntax

class UBlueprintPaletteFavorites : public UObject

Variables

Name Description

Public variable

TArray< FFavori...

 

CurrentFavorites

A list of favorites that is constructed in PostLoad() (either from a profile or the user's set of CustomFavorites).

Public variable

FString

 

CurrentProfile

Users could load pre-existing profiles (intended to share favorites, and hook into tutorials).

Public variable

TArray< FString...

 

CustomFavorites

A list of strings that are used to identify specific palette actions.

Public variable

FBlueprintFavor...

 

OnFavoritesUpdated

Constructors

Name Description

Public function

UBlueprintPaletteFavorites

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function

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).

Public function

void

 

AddFavorites

Adds the specified actions to the current favorites list.

Public function Const

bool

 

CanBeFavorited

(
    TSharedPtr< FEdGraphSchemaAction > ...
)

Not all palette actions can be turned into a favorite. This method is meant to catch those cases.

Public function

void

 

ClearAllFavorites()

Removes every single favorite and sets the user's profile to a custom one (if it isn't already).

Public function Const

FString cons...

 

GetCurrentProfile()

Gets the user's currently set profile.

Public function Const

bool

 

IsFavorited

(
    TSharedPtr< FEdGraphSchemaAction > ...
)

This method can be used to see if a specified action is already favorited by the user.

Public function Const

bool

 

IsFavorited

(
    FBlueprintActionInfo& BlueprintAct...
)

Public function Const

bool

 

IsFavorited

(
    UBlueprintNodeSpawner const* B...
)

Public function Const

bool

 

IsUsingCustomProfile()

Provides any easy way to see if the user is currently using his/her own manual profile (one he/she set up through the tool).

Public function

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).

Public function

void

 

RemoveFavorite

(
    TSharedPtr< FEdGraphSchemaAction > ...
)

Removes the specified action to the current favorites list (if it's there).

Public function

void

 

RemoveFavorites

Remove the specified actions from the current favorites list.

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Classes

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.