1. Epic GamesDeveloper
  3. FRigVMStruct

FRigVMStruct

The base class for all RigVM enabled structs.

API > API/Plugins > API/Plugins/RigVM > API/Plugins/RigVM/RigVMCore

Inheritance Hierarchy

References

   
Module RigVM
Header /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMStruct.h
Include #include "RigVMCore/RigVMStruct.h"

Syntax

USTRUCT ()  
struct FRigVMStruct

Remarks

The base class for all RigVM enabled structs.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function bool

ApplyUpgradeInfo ( const FRigVMStructUpgradeInfo& InUpgradeInfo
)

  
Public function Virtual Const bool  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Virtual void

Execute ()

 Execute logic for this struct
Public function Static FString

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

  
Public function Static FString

ExportToFullyQualifiedText ( const T& InStructValue
)

  
Public function Static FString

ExportToFullyQualifiedText ( const T& InStructValue
)

  
Public function Static FString

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

  
Public function Const FString

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

  
Public function Const const TArray< FName > &  
Protected function Virtual Const const TArray< FName > &  
Protected function Const TMap< FName, FString >

GetDefaultValues ( UScriptStruct* InScriptStruct
)

  
Public function Virtual Const FName  
Public function Virtual Const FName

GetNextAggregateName ( const FName& InLastAggregatePinName
)

  
Public function Virtual Const int32  
Public function Static ERigVMPinDirection

GetPinDirectionFromProperty ( FProperty* InProperty
)

  
Protected function Static float

GetRatioFromIndex ( int32 InIndex,
int32 InCount
)

  
Protected function Virtual Const TArray< FRigVMUserWorkflow >

GetSupportedWorkflows ( const UObject* InSubject
)

  
Public function Virtual Const FString  
Public function Virtual Const FString  
Public function Virtual Const FRigVMStructUpgradeInfo  
Public function Const TArray< FRigVMUserWorkflow >

GetWorkflows ( ERigVMUserWorkflowType InType,
const UObject* InSubject
)

 User workflow
Public function Virtual void Initialize logic for this struct
Public function Virtual Const const bool

IsControlFlowBlockSliced ( const FName& InBlockName
)

  
Public function Const bool  
Public function Const bool Control flow related
Public function Virtual Const void Node creation
Public function Virtual Const FString  
Public function Virtual Const bool

ShouldCreatePinForProperty ( const FProperty* InProperty
)

  
Protected function Static void

ValidateControlFlowBlocks ( const TArray< FName >& InBlocks
)

  
Public function Static bool

ValidateStruct ( UScriptStruct* InStruct,
FString* OutErrorMessage
)

  

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page