Navigation
API > API/Plugins > API/Plugins/RigVMEditor
Responsible for constructing a list of viable blueprint actions. Runs the blueprint actions database through a filter and spawns a series of FRigVMActionMenuItems for actions that pass. Takes care of generating the each menu item's category/name/etc.
| Name | FRigVMActionMenuBuilder |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVMEditor/Public/Editor/RigVMActionMenuBuilder.h |
| Include Path | #include "Editor/RigVMActionMenuBuilder.h" |
Syntax
struct FRigVMActionMenuBuilder : public FGraphActionListBuilderBase
Inheritance Hierarchy
- FGraphActionListBuilderBase → FRigVMActionMenuBuilder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FRigVMActionMenuBuilder
(
EConfigFlags Flags |
Default constructor. | Editor/RigVMActionMenuBuilder.h |
Enums
Public
| Name | Remarks |
|---|---|
| EConfigFlags | Flags used to configure the builder. |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUsePendingActionList | bool | If enabled, actions will be added to the pending list rather than processed immediately. | Editor/RigVMActionMenuBuilder.h | |
| MenuItemListAddHelper | TSharedPtr< FRigVMActionMenuBuilderImpl::FMenuItemListAddHelper > | Defines a utility that assists with building the list of action menu items for each menu section based on a set of action descriptor records. | Editor/RigVMActionMenuBuilder.h | |
| MenuSections | TArray< TSharedRef< FRigVMActionMenuBuilderImpl::FMenuSectionDefinition > > | Defines all the separate sections of the menu (filter, sort order, etc.). | Editor/RigVMActionMenuBuilder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddMenuSection
(
FBlueprintActionFilter const& Filter, |
Some action menus require multiple sections. | Editor/RigVMActionMenuBuilder.h | |
int32 GetNumPendingActions() |
Returns the current number of actions that are still pending | Editor/RigVMActionMenuBuilder.h | |
float GetPendingActionsProgress() |
Returns the normalized completion state when processing pending actions (e.g. for a status indicator) | Editor/RigVMActionMenuBuilder.h | |
bool ProcessPendingActions () |
Processes any actions that may be added asynchronously or across multiple frames. | Editor/RigVMActionMenuBuilder.h | |
void RebuildActionList () |
Regenerates the entire menu list from the cached menu sections. | Editor/RigVMActionMenuBuilder.h |
Overridden from FGraphActionListBuilderBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Empty() |
Editor/RigVMActionMenuBuilder.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void MakeMenuItems
(
FBlueprintActionInfo& InAction |
Adds menu items for the given database action. | Editor/RigVMActionMenuBuilder.h |