1. Epic GamesDeveloper
  3. URigVMHost

URigVMHost

API > API/Plugins > API/Plugins/RigVM

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, EditInlineNew)  
class URigVMHost :  
    public UObject,  
    public IInterface_AssetUserData

Variables

  Type Name Description
Protected variable float AbsoluteTime Current delta time
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay instanced TArray< TObjectPtr< UAssetUserData > > AssetUserData Array of user data stored with the asset
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay instanced TArray< TObjectPtr< UAssetUserData > > AssetUserDataEditorOnly Array of user data stored with the asset
Protected variable bool bAccumulateTime True if we should increase the AbsoluteTime
Protected variable bool bEnableLogging  
Protected variable bool bRequiresInitExecution  
Protected variable FRigVMDebugInfo DebugInfo  
Protected variable float DeltaTime Current delta time
Public variable UProperty FRigVMDrawContainer DrawContainer  
Public variable FRigVMDrawInterface DrawInterface The draw interface for the units to use
Public variable UProperty Transient TArray< FName > EventQueue The event name used during an update
Public variable UProperty Transient TArray< FName > EventQueueToRun  
Public variable TMap< FName, int32 > EventsToRunOnce  
Protected variable int32 ExecuteBracket  
Public variable FRigVMExecutedEvent ExecutedEvent Broadcasts a not ification whenever the RigVMHost is executed / updated.
Protected variable float FramesPerSecond Current delta time
Protected variable int32 InitBracket  
Public variable FRigVMExecutedEvent InitializedEvent Broadcasts a notification whenever the RigVMHost's memory is initialized.
Protected variable FRigVMInstructionVisitInfo InstructionVisitInfo  
Protected variable TMap< FString, bool > LoggedMessages  
Protected variable TWeakObjectPtr< USceneComponent > OuterSceneComponent  
Protected variable FRigVMProfilingInfo ProfilingInfo  
Protected variable FRigVMLog * RigVMLog  
Protected variable UProperty TMap< FString, FSoftObjectPath > UserDefinedEnumToPathName  
Protected variable UProperty TMap< FString, FSoftObjectPath > UserDefinedStructGuidToPathName  
Protected variable UProperty Transient TObjectPtr< URigVM > VM  
Public variable UProperty FRigVMRuntimeSettings VMRuntimeSettings  

Constructors

  Type Name Description
Public function  

URigVMHost ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

AdaptEventQueueForEvaluate ( TArray< FName >& InOutEventQueueToRun
)

 Provides the chance to a subclass to modify the event queue as needed
Public function Virtual void

AddAssetUserData ( UAssetUserData* InUserData
)

  
Public function void

AddBreakpoint ( int32 InstructionIndex,
UObject* InSubject,
uint16 InDepth
)

 Adds a breakpoint in the VM at the InstructionIndex for the Node / Subject
Public function Static bool  
Public function Virtual void  
Public function void These are needed so that sequencer can have a chance to update its RigVMHost instances after the package is fully end-loaded
Public function Virtual Const UFunction BlueprintPure, Category bool Is valid for execution
Public function void Copy the default values of external variables from the default object
Protected function Virtual void  
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Protected function Static bool  
Public function void

DrawIntoPDI ( FPrimitiveDrawInterface* PDI,
const FTransform& InTransform
)

  
Public function Virtual void Evaluate at Any Thread
Public function Virtual UFunction BlueprintCallable, Category bool

Execute ( const FName& InEventName
)

 Execute
Protected function Virtual bool

Execute_Internal ( const FName& InEventName
)

 ExecuteUnits
Public function bool

ExecuteBreakpointAction ( const ERigVMBreakpointAction BreakpointAction
)

 If the VM is halted at a breakpoint, it sets a breakpoint action so that it is applied on the next VM execution
Public function UFunction BlueprintCallable, Category bool

ExecuteEvent ( const FName& InEventName
)

 Execute a user defined event
Public function Static UFunction BlueprintCallable, Category TArray< URigVMHost * >

FindRigVMHosts ( UObject* Outer,
TSubclassOf< URigVMHost > OptionalClass
)

  
Protected function void  
Public function Const UFunction BlueprintPure, Category float Gets the current absolute time
Public function Virtual Const const TArray< UAssetUserData * > *  
Public function Virtual UAssetUserData *

GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

  
Public function Const UFunction BlueprintPure, Category float Returns the current frames per second (this may change over time)
Public function Const const FRigVMDebugInfo &  
Public function FRigVMDebugInfo &  
Public function Const const FRigVMMemoryStorageStruct *  
Public function FRigVMMemoryStorageStruct * The instanced debug watch memory.
Public function Virtual Const const FRigVMMemoryStorageStruct * Returns the compiler generated VM memory storage by type.
Public function Const UFunction BlueprintPure, Category float Gets the current delta time
Public function Const const FRigVMDrawContainer &  
Public function FRigVMDrawContainer &  
Public function FRigVMDrawInterface &  
Public function Const const FRigVMDrawInterface &  
Public function FCriticalSection & Locks for the scope of Evaluate_AnyThread
Public function Const const TArray< FName > & Returns the queue of events to run
Public function Virtual Const const FRigVMExtendedExecuteContext & Provide access to the ExtendedExecuteContext
Public function Virtual UFunction BlueprintCallable, Category, Meta FRigVMExtendedExecuteContext & Provide access to the ExtendedExecuteContext
Public function Const TArray< FRigVMExternalVariable > Returns the member properties as an external variable array
Protected function Const TArray< FRigVMExternalVariable >

GetExternalVariablesImpl ( bool bFallbackToBlueprint
)

  
Public function Const const FRigVMBreakpoint &  
Public function FRigVMMemoryStorageStruct * The default const literal memory.
Public function Const const FRigVMMemoryStorageStruct *  
Public function FRigVMLog *

GetLog ()

  
Public function Const const FRigVMLog *

GetLog ()

  
Public function Virtual Const const FRigVMMemoryStorageStruct *  
Public function Virtual FRigVMMemoryStorageStruct * Returns an instanced VM memory storage by type.
Public function Virtual Const FString

GetName ()

  
Public function Virtual USceneComponent *  
Public function Const const FRigVMProfilingInfo &  
Public function FRigVMProfilingInfo &  
Public function Virtual Const UScriptStruct * Returns the public context script struct to use for this owner
Public function Const FRigVMExternalVariable

GetPublicVariableByName ( const FName& InVariableName
)

 Returns a public variable given its name
Protected function Const FProperty *

GetPublicVariableProperty ( const FName& InVariableName
)

  
Public function Const TArray< FRigVMExternalVariable > Returns the public member properties as an external variable array
Public function T

GetPublicVariableValue ( const FName& InVariableName
)

  
Public function FRigVMExtendedExecuteContext &  
Public function Const const FRigVMExtendedExecuteContext &  
Public function Const UFunction BlueprintPure, Category, Meta TArray< FName > Returns the names of variables accessible in scripting
Public function FRigVMExtendedExecuteContext &  
Public function URigVM *

GetSnapshotVM ( bool bCreateIfNeeded
)

 Creates the snapshot VM if required and returns it
Public function Virtual Const UFunction BlueprintPure, Category const TArray< FName > &  
Protected function TArray< const UObject * >  
Public function Const UFunction BlueprintPure, Category FString

GetVariableAsString ( const FName& InVariableName
)

 Returns the value of a given variable as a string
Public function Const UFunction BlueprintPure, Category FName

GetVariableType ( const FName& InVariableName
)

 Returns the type of a given variable
Public function UFunction BlueprintPure, Category URigVM *

GetVM ()

  
Public function Const const FRigVMMemoryStorageStruct *  
Public function FRigVMMemoryStorageStruct * The instanced mutable work memory.
Public function Virtual Const UWorld * UObject interface
Protected function void

HandleExecutionReachedExit ( const FName& InEventName
)

  
Public function Virtual void

Initialize ( bool bRequestInit
)

 Initialize things for the RigVM owner
Protected function Virtual bool Initialize the CDO VM
Protected function Virtual void  
Public function Virtual bool

InitializeVM ( const FName& InEventName
)

 Initialize this Host VM Instance
Public function void Copy the VM from the default object
Public function Virtual void  
Public function Const bool Returns true if Evaluate_AnyThread is currently executing
Protected function Const bool  
Public function Static bool

IsGarbageOrDestroyed ( const UObject* InObject
)

  
Public function Const bool  
Protected function Const bool  
Public function Virtual Const UFunction BlueprintPure, Category bool Returns true if this host requires the VM memory to be initialized
Public function Const bool  
Public function Const bool

IsRunOnceEvent ( const FName& InEventName
)

 Returns true if an event is queued to run once
Protected function void

LogOnce ( EMessageSeverity::Type InSeverity,
int32 InInstructionIndex,
const FString& InMessage
)

  
Public function FOnEndLoadPackage &  
Public function FRigVMExecutedEvent &  
Public function FRigVMExecutedEvent &  
Protected function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  
Public function Virtual void Regenerates cached handles after a structural change (i.e. new UUserStruct)
Public function UFunction BlueprintCallable, Category bool

RemoveRunOnceEvent ( const FName& InEventName
)

 Removes an event running once
Public function Virtual void

RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

  
Public function Virtual UFunction BlueprintCallable, Category void Requests to perform an init during the next execution
Public function UFunction BlueprintCallable, Category void

RequestRunOnceEvent ( const FName& InEventName,
int32 InEventIndex
)

 Requests to run an event once
Public function Const UObject *

ResolveUserDefinedTypeById ( const FString& InTypeName
)

  
Public function Virtual void

Serialize ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category void

SetAbsoluteAndDeltaTime ( float InAbsoluteTime,
float InDeltaTime
)

 Set the current absolute and delta times
Public function UFunction BlueprintCallable, Category void

SetAbsoluteTime ( float InAbsoluteTime,
bool InSetDeltaTimeZero
)

 Set the current absolute time
Public function void  
Public function UFunction BlueprintCallable, Category void

SetDeltaTime ( float InDeltaTime
)

 Set the current delta time
Public function void

SetEventQueue ( const TArray< FName >& InEventNames
)

 Sets the queue of events to run
Public function UFunction BlueprintCallable, Category void

SetFramesPerSecond ( float InFramesPerSecond
)

 Set the current fps
Public function void

SetIsInDebugMode ( const bool bValue
)

  
Public function void

SetLog ( FRigVMLog* InLog
)

  
Public function void

SetPublicVariableValue ( const FName& InVariableName,
const T& InValue
)

  
Public function void  
Public function UFunction BlueprintCallable, Category bool

SetVariableFromString ( const FName& InVariableName,
const FString& InValue
)

 Returns the value of a given variable as a string
Public function Const bool  
Public function Virtual Const UFunction BlueprintPure, Category bool

SupportsEvent ( const FName& InEventName
)

  
Public function void

SwapVMToNativizedIfRequired ( UClass* InNativizedClass
)

  
Public function void Update the settings such as array bound and log facilities

Classes

  Type Name Description
Public class FOnEndLoadPackage Bindable event for external objects to be notified that a RigVMHost is fully end-loaded  
Public class FRigVMExecutedEvent    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page