Navigation
API > API/Editor > API/Editor/Kismet
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
| Type | Name | Description | |
|---|---|---|---|
| TArray< FFavoritedBlueprintPaletteItem > | 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. | |
| FBlueprintFavoritesUpdatedEvent | OnFavoritesUpdated |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UBlueprintPaletteFavorites
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
| 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). | |
| void | AddFavorites
(
TArray< TSharedPtr< FEdGraphSchemaAction > > PaletteActions |
Adds the specified actions to the current favorites list. | |
| bool | CanBeFavorited
(
TSharedPtr< FEdGraphSchemaAction > PaletteAction |
Not all palette actions can be turned into a favorite. This method is meant to catch those cases. | |
| void | Removes every single favorite and sets the user's profile to a custom one (if it isn't already). | ||
| FString const & | Gets the user's currently set profile. | ||
| bool | IsFavorited
(
TSharedPtr< FEdGraphSchemaAction > PaletteAction |
This method can be used to see if a specified action is already favorited by the user. | |
| bool | IsFavorited
(
FBlueprintActionInfo& BlueprintAction |
||
| bool | IsFavorited
(
UBlueprintNodeSpawner const* BlueprintAction |
||
| bool | 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 > PaletteAction |
Removes the specified action to the current favorites list (if it's there). | |
| void | RemoveFavorites
(
TArray< TSharedPtr< FEdGraphSchemaAction > > PaletteActions |
Remove the specified actions from the current favorites list. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally | |
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |
Classes
| Type | Name | Description | |
|---|---|---|---|
| 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. |