FRigVMPrototype

The Prototype is used to group multiple rigvm functions that share the same notation.

Windows
MacOS
Linux

References

Module

RigVM

Header

/Engine/Source/Runtime/RigVM/Public/RigVMCore/RigVMPrototype.h

Include

#include "RigVMCore/RigVMPrototype.h"

Syntax

struct FRigVMPrototype

Remarks

The Prototype is used to group multiple rigvm functions that share the same notation. Prototypes can then be used to build polymorphic nodes (RigVMPrototypeNode) that can take on any of the types supported by the prototype.

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Const

bool

 

ArgSupportsType

(
    const FName& InArgName,
    const FString& InCPPType,
    const FTypeMap& InTypes
)

Returns true if a given arg supports a type

Public function Const

const FRigVM...

 

FindArg

(
    const FName& InArgName
)

Returns an argument given a name (or nullptr)

Public function Const

const FRigVM...

 

GetArg

(
    int32 InIndex
)

Returns an argument for a given index

Public function Const

FString

 

GetCategory()

Public function Const

const FRigVM...

 

GetFunction

(
    int32 InIndex
)

Returns a function given an index

Public function Const

FString

 

GetKeywords()

Public function Const

FName

 

GetName()

Returns the name of the prototype.

Public function Const

const FName ...

 

GetNotation()

Returns the notation of this prototype.

Public function Static

FName

 

GetNotationFromStruct

(
    UScriptStruct* InStruct,
    const FString& InPrototypeName
)

Public function Const

bool

 

IsCompatible

(
    const FRigVMPrototype& InOther
)

Returns true if this prototype is compatible with another one

Public function Const

bool

 

IsValid()

Returns true if this is a valid prototype

Public function

bool

 

Merge

(
    const FRigVMPrototype& InOther
)

Returns true if this prototype can merge another one

Public function Const

int32

 

NumArgs()

Returns the number of args of this prototype

Public function Const

int32

 

NumFunctions()

Returns the number of functions supported by this prototype

Public function Const

bool

 

Resolve

(
    FTypeMap& InOutTypes,
    int32& OutFunctionIndex
)

Returns true if the prototype was able to resolve

Typedefs

Name

Description

FTypeMap

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss