1. Epic GamesDeveloper
  3. FRigVMStruct

FRigVMStruct

The base class for all RigVM enabled structs.

API > API/Plugins > API/Plugins/RigVM

The base class for all RigVM enabled structs.

   
Name FRigVMStruct
Type struct
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMStruct.h
Include Path #include "RigVMCore/RigVMStruct.h"

Syntax

USTRUCT ()  
struct FRigVMStruct

Derived Classes

FRigVMStruct derived class hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FRigVMStruct()

   RigVMCore/RigVMStruct.h  

Constants

Name Type Remarks Include Path        
AbstractMetaName const FLazyName   RigVMCore/RigVMStruct.h        
AggregateMetaName const FLazyName   RigVMCore/RigVMStruct.h        
ArraySizeMetaName const FLazyName   RigVMCore/RigVMStruct.h        
CategoryMetaName const FLazyName   RigVMCore/RigVMStruct.h        
ComputeLazilyMetaName const FLazyName   RigVMCore/RigVMStruct.h        
ConstantMetaName const FLazyName   RigVMCore/RigVMStruct.h        
ControlFlowBlockToRunName const FLazyName   RigVMCore/RigVMStruct.h        
ControlFlowCompletedName const FLazyName   RigVMCore/RigVMStruct.h        
ControlFlowCountName const FLazyName   RigVMCore/RigVMStruct.h        
ControlFlowIndexName const FLazyName   RigVMCore/RigVMStruct.h        
CustomWidgetMetaName const FLazyName   RigVMCore/RigVMStruct.h        
DefaultArraySizeMetaName const FLazyName   RigVMCore/RigVMStruct.h        
DeprecatedMetaName const FLazyName   RigVMCore/RigVMStruct.h        
DetailsOnlyMetaName const FLazyName   RigVMCore/RigVMStruct.h        
DisplayNameMetaName const FLazyName   RigVMCore/RigVMStruct.h        
ExecuteContextName const FLazyName   RigVMCore/RigVMStruct.h        
ExecuteName const FLazyName   RigVMCore/RigVMStruct.h        
ExecutePinName const FLazyName   RigVMCore/RigVMStruct.h        
ExpandPinByDefaultMetaName const FLazyName   RigVMCore/RigVMStruct.h        
FixedSizeArrayMetaName const FLazyName   RigVMCore/RigVMStruct.h        
ForLoopCompletedPinName const FLazyName   RigVMCore/RigVMStruct.h        
ForLoopContinuePinName const FLazyName   RigVMCore/RigVMStruct.h        
ForLoopCountPinName const FLazyName   RigVMCore/RigVMStruct.h        
ForLoopIndexPinName const FLazyName   RigVMCore/RigVMStruct.h        
HiddenMetaName const FLazyName   RigVMCore/RigVMStruct.h        
HideSubPinsMetaName const FLazyName   RigVMCore/RigVMStruct.h        
IconMetaName const FLazyName Icon meta name format: StyleSetName StyleName SmallStyleName StatusOverlayStyleName the last two names are optional, see FSlateIcon() for reference Example: Icon="EditorStyle GraphEditor.Sequence_16x" RigVMCore/RigVMStruct.h
InputMetaName const FLazyName   RigVMCore/RigVMStruct.h        
IOMetaName const FLazyName   RigVMCore/RigVMStruct.h        
KeywordsMetaName const FLazyName   RigVMCore/RigVMStruct.h        
MenuDescSuffixMetaName const FLazyName   RigVMCore/RigVMStruct.h        
NodeColorMetaName const FLazyName   RigVMCore/RigVMStruct.h        
OutputMetaName const FLazyName   RigVMCore/RigVMStruct.h        
ShowOnlySubPinsMetaName const FLazyName   RigVMCore/RigVMStruct.h        
ShowVariableNameInTitleMetaName const FLazyName   RigVMCore/RigVMStruct.h        
SingletonMetaName const FLazyName   RigVMCore/RigVMStruct.h        
SliceContextMetaName const FLazyName   RigVMCore/RigVMStruct.h        
TitleColorMetaName const FLazyName   RigVMCore/RigVMStruct.h        
VaryingMetaName const FLazyName   RigVMCore/RigVMStruct.h        
VisibleMetaName const FLazyName   RigVMCore/RigVMStruct.h        

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanOnlyExistOnce()

   RigVMCore/RigVMStruct.h  

virtual void Execute()

 Execute logic for this struct RigVMCore/RigVMStruct.h  

FString ExportToFullyQualifiedText ( const UScriptStruct* InScriptStruct,
const FName& InPropertyName,
const uint8* InStructMemoryPointer,
bool bUseQuotes
) const

   RigVMCore/RigVMStruct.h  

const TArray< FName > & GetControlFlowBlocks()

   RigVMCore/RigVMStruct.h  

virtual FName GetEventName()

   RigVMCore/RigVMStruct.h  

virtual const UScriptStruct * GetExecuteContextStruct()

 Return the execute script struct this unit wants to use RigVMCore/RigVMStruct.h  

virtual FName GetNextAggregateName ( const FName& InLastAggregatePinName
) const

   RigVMCore/RigVMStruct.h  

virtual int32 GetNumSlices()

   RigVMCore/RigVMStruct.h  

virtual FString GetUnitLabel()

   RigVMCore/RigVMStruct.h  

virtual FString GetUnitSubTitle()

   RigVMCore/RigVMStruct.h  

virtual FRigVMStructUpgradeInfo GetUpgradeInfo()

   RigVMCore/RigVMStruct.h  

TArray< FRigVMUserWorkflow > GetWorkflows ( ERigVMUserWorkflowType InType,
const UObject* InSubject
) const

 User workflow RigVMCore/RigVMStruct.h  

virtual void Initialize()

 Initialize logic for this struct RigVMCore/RigVMStruct.h  

virtual const bool IsControlFlowBlockSliced ( const FName& InBlockName
) const

   RigVMCore/RigVMStruct.h  

bool IsControlFlowNode()

   RigVMCore/RigVMStruct.h  

bool IsForLoop()

 Control flow related RigVMCore/RigVMStruct.h  

virtual void OnUnitNodeCreated ( FRigVMUnitNodeCreatedContext& InContext
) const

 Node creation RigVMCore/RigVMStruct.h  

virtual FString ProcessPinLabelForInjection ( const FString& InLabel
) const

   RigVMCore/RigVMStruct.h  

virtual bool ShouldCreatePinForProperty ( const FProperty* InProperty
) const

   RigVMCore/RigVMStruct.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool ApplyUpgradeInfo ( const FRigVMStructUpgradeInfo& InUpgradeInfo
)

   RigVMCore/RigVMStruct.h  

virtual const TArray< FName > & GetControlFlowBlocks_Impl()

   RigVMCore/RigVMStruct.h  

TMap< FName, FString > GetDefaultValues ( UScriptStruct* InScriptStruct
) const

   RigVMCore/RigVMStruct.h  

virtual TArray< FRigVMUserWorkflow > GetSupportedWorkflows ( const UObject* InSubject
) const

   RigVMCore/RigVMStruct.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CheckFunctionExists ( UScriptStruct* InStruct,
const FName& FunctionName,
FString* OutErrorMessage
)

   RigVMCore/RigVMStruct.h  

static bool CheckMetadata ( UScriptStruct* InStruct,
const FName& PinName,
const FName& InMetadataKey,
FString* OutErrorMessage
)

   RigVMCore/RigVMStruct.h  

static bool CheckPinDirection ( UScriptStruct* InStruct,
const FName& PinName,
const FName& InDirectionMetaName
)

   RigVMCore/RigVMStruct.h  

static bool CheckPinExists ( UScriptStruct* InStruct,
const FName& PinName,
const FString& ExpectedType,
FString* OutErrorMessage
)

   RigVMCore/RigVMStruct.h  

static bool CheckPinType ( UScriptStruct* InStruct,
const FName& PinName,
const FString& ExpectedType,
FString* OutErrorMessage
)

   RigVMCore/RigVMStruct.h  

static FString ExportToFullyQualifiedText ( const FProperty* InMemberProperty,
const uint8* InMemberMemoryPtr,
bool bUseQuotes
)

   RigVMCore/RigVMStruct.h  

static FString ExportToFullyQualifiedText ( const T& InStructValue
)

   RigVMCore/RigVMStruct.h  

static FString ExportToFullyQualifiedText ( const T& InStructValue
)

   RigVMCore/RigVMStruct.h  

static FString ExportToFullyQualifiedText ( const UScriptStruct* InStruct,
const uint8* InStructMemoryPtr,
bool bUseQuotes
)

   RigVMCore/RigVMStruct.h  

static ERigVMPinDirection GetPinDirectionFromProperty ( FProperty* InProperty
)

   RigVMCore/RigVMStruct.h  

static float GetRatioFromIndex ( int32 InIndex,
int32 InCount
)

   RigVMCore/RigVMStruct.h  

static void ValidateControlFlowBlocks ( const TArray< FName >& InBlocks
)

   RigVMCore/RigVMStruct.h  

static bool ValidateStruct ( UScriptStruct* InStruct,
FString* OutErrorMessage
)

   RigVMCore/RigVMStruct.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page