Navigation
API > API/Plugins > API/Plugins/RigVMDeveloper
The Function Library is a graph used only to store the sub graphs used for functions.
| Name | URigVMFunctionLibrary |
| Type | class |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVMDeveloper/Public/RigVMModel/RigVMFunctionLibrary.h |
| Include Path | #include "RigVMModel/RigVMFunctionLibrary.h" |
Syntax
UCLASS (BlueprintType)
class URigVMFunctionLibrary : public URigVMGraph
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → URigVMGraph → URigVMFunctionLibrary
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URigVMFunctionLibrary() |
Default constructor. | RigVMModel/RigVMFunctionLibrary.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| GetFunctionHostObjectPathDelegate | URigVMFunctionLibrary_GetFunctionHostObjectPath | RigVMModel/RigVMFunctionLibrary.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FunctionToVariant | TMap< FName, FRigVMVariant > | RigVMModel/RigVMFunctionLibrary.h | ||
| LocalizedFunctions | TMap< FString, TObjectPtr< URigVMLibraryNode > > | A map which stores a library node per original pathname. | RigVMModel/RigVMFunctionLibrary.h | |
| PublicFunctionNames | TArray< FName > | RigVMModel/RigVMFunctionLibrary.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
URigVMLibraryNode * FindFunction
(
const FName& InFunctionName |
Finds a function by name. | RigVMModel/RigVMFunctionLibrary.h |
|
URigVMLibraryNode * FindFunctionForNode
(
URigVMNode* InNode |
Finds a function by a node within a function (or a sub graph of that) | RigVMModel/RigVMFunctionLibrary.h |
|
URigVMLibraryNode * FindPreviouslyLocalizedFunction
(
FRigVMGraphFunctionIdentifier InFunctionToLocalize |
Returns a function that has been previously localized based on the provided function to localize. | RigVMModel/RigVMFunctionLibrary.h | |
void ForEachReference
(
const FName& InFunctionName, |
Iterator function to invoke a lambda / TFunction for each reference of a function | RigVMModel/RigVMFunctionLibrary.h | |
void ForEachReferenceSoftPtr
(
const FName& InFunctionName, |
Iterator function to invoke a lambda / TFunction for each reference of a function | RigVMModel/RigVMFunctionLibrary.h | |
const FSoftObjectPath GetFunctionHostObjectPath() |
RigVMModel/RigVMFunctionLibrary.h | ||
TArray< URigVMLibraryNode * > GetFunctions() |
Returns all of the stored functions. | RigVMModel/RigVMFunctionLibrary.h |
|
const FRigVMVariant * GetFunctionVariant
(
const FName& InFunctionName |
RigVMModel/RigVMFunctionLibrary.h | ||
FRigVMVariant * GetFunctionVariant
(
const FName& InFunctionName |
RigVMModel/RigVMFunctionLibrary.h | ||
| Returns all references for a given function name. | RigVMModel/RigVMFunctionLibrary.h |
|
|
TArray< TSoftObjectPtr< URigVMFunctionReferenceNode > > GetReferencesForFunction
(
const FName& InFunctionName |
Returns all references for a given function name. | RigVMModel/RigVMFunctionLibrary.h |
|
bool IsFunctionPublic
(
const FName& InFunctionName |
RigVMModel/RigVMFunctionLibrary.h |
Overridden from URigVMGraph
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual URigVMFunctionLibrary * GetDefaultFunctionLibrary() |
Returns the locally available function library. | RigVMModel/RigVMFunctionLibrary.h | |
virtual FString GetNodePath() |
Returns the path of this graph as defined by its invoking nodes. | RigVMModel/RigVMFunctionLibrary.h |