FRigVMDispatch_SwitchEnum

Run a branch based on an enum index

API > API/Plugins > API/Plugins/RigVM

Run a branch based on an enum index

   
Name FRigVMDispatch_SwitchEnum
Type struct
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMFunctions/RigVMDispatch_Switch.h
Include Path #include "RigVMFunctions/RigVMDispatch_Switch.h"

Syntax

USTRUCT (  
        Meta=(DisplayName="Switch Enum", Category="Execution", Keywords="Case", NodeColor="0,1,0,1", Pure))  
struct FRigVMDispatch_SwitchEnum : public FRigVMDispatch_SwitchBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigVMDispatch_SwitchEnum()

   RigVMFunctions/RigVMDispatch_Switch.h  

Functions

Public

Public Virtual

Overridden from FRigVMDispatchFactory

Name Remarks Include Path Unreal Specifiers

virtual const TArray< FRigVMTemplateArgumentInfo > & GetArgumentInfos ( FRigVMRegistryHandle& InRegistry
) const

 Returns the arguments of the template RigVMFunctions/RigVMDispatch_Switch.h  

virtual const TArray< FName > & GetControlFlowBlocks_Impl ( const FRigVMDispatchContext& InContext,
const FRigVMTemplateTypeMap& InTypeMap
) const

   RigVMFunctions/RigVMDispatch_Switch.h  

virtual FName GetDisplayNameForArgument ( const FName& InArgumentName,
const FRigVMTemplateTypeMap& InTypes
) const

 Returns the display name text for an argument. RigVMFunctions/RigVMDispatch_Switch.h  

virtual FRigVMTemplateTypeMap OnNewArgumentType ( const FName& InArgumentName,
TRigVMTypeIndex InTypeIndex,
FRigVMRegistryHandle& InRegistry
) const

 This function is deprecated, please use GetPermutationsFromArgumentType returns the new permutation argument types after a new type is defined for one argument this happens if types are being loaded later after this factory has already been deployed (like UUserDefinedStruct) RigVMFunctions/RigVMDispatch_Switch.h  

Protected Virtual

Overridden from FRigVMDispatchFactory

Name Remarks Include Path Unreal Specifiers

virtual FRigVMFunctionPtr GetDispatchFunctionImpl ( const FRigVMTemplateTypeMap& InTypes,
const FRigVMRegistryHandle& InRegistry
) const

   RigVMFunctions/RigVMDispatch_Switch.h  

Static

Name Remarks Include Path Unreal Specifiers

static void Execute ( FRigVMExtendedExecuteContext& InContext,
FRigVMMemoryHandleArray Handles,
FRigVMPredicateBranchArray Predicates
)

   RigVMFunctions/RigVMDispatch_Switch.h  

static FName GetCaseDisplayName ( int32 InIndex,
const UEnum* InEnum
)

   RigVMFunctions/RigVMDispatch_Switch.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page