Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. URigVMHost

URigVMHost

API > API/Plugins > API/Plugins/RigVM

   
Name URigVMHost
Type class
Header File /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMHost.h
Include Path #include "RigVMHost.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

URigVMHost ( const FObjectInitializer& ObjectInitializer
)

   RigVMHost.h  

Classes

Name Remarks
FOnEndLoadPackage Bindable event for external objects to be notified that a RigVMHost is fully end-loaded
FRigVMExecutedEvent  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
DrawContainer FRigVMDrawContainer   RigVMHost.h  
DrawInterface FRigVMDrawInterface The draw interface for the units to use RigVMHost.h  
EventQueue TArray< FName > The event name used during an update RigVMHost.h
  • Transient
EventQueueToRun TArray< FName >   RigVMHost.h
  • Transient
EventsToRunOnce TArray< FName >   RigVMHost.h  
ExecutedEvent FRigVMExecutedEvent Broadcasts a notification whenever the RigVMHost is executed / updated. RigVMHost.h  
InitializedEvent FRigVMExecutedEvent Broadcasts a notification whenever the RigVMHost's memory is initialized. RigVMHost.h  
PreExecutedEvent FRigVMExecutedEvent Broadcasts a notification before the RigVMHost is executed / updated. RigVMHost.h  
VMRuntimeSettings FRigVMRuntimeSettings   RigVMHost.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsInDebugMode bool The current execution mode RigVMHost.h
  • Transient
EndLoadPackageEvent FOnEndLoadPackage   RigVMHost.h  
EvaluateMutex FTransactionallySafeCriticalSection   RigVMHost.h  
EventQueueToRunOnceMutex FTransactionallySafeCriticalSection   RigVMHost.h  
RigVMExtendedExecuteContext FRigVMExtendedExecuteContext *   RigVMHost.h  
UserDefinedTypesInUse TSet< TObjectPtr< UObject > >   RigVMHost.h
  • Transient

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AdaptEventQueueForEvaluate ( TArray< FName >& InOutEventQueueToRun
)

 Provides the chance to a subclass to modify the event queue as needed RigVMHost.h  

virtual void AddAssetUserData ( UAssetUserData* InUserData
)

   RigVMHost.h  

void BroadCastEndLoadPackage()

 These are needed so that sequencer can have a chance to update its RigVMHost instances after the package is fully end-loaded RigVMHost.h  

virtual bool CanExecute()

 Is valid for execution RigVMHost.h
  • BlueprintPure
  • Category="RigVM"

void CopyExternalVariableDefaultValuesFromCDO()

 Copy the default values of external variables from the default object RigVMHost.h  

void DrawIntoPDI ( FPrimitiveDrawInterface* PDI,
const FTransform& InTransform
)

   RigVMHost.h  

virtual void Evaluate_AnyThread()

 Evaluate at Any Thread RigVMHost.h  

virtual bool Execute ( const FName& InEventName
)

 Execute RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

bool ExecuteEvent ( const FName& InEventName
)

 Execute a user defined event RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

float GetAbsoluteTime()

 Gets the current absolute time RigVMHost.h
  • BlueprintPure
  • Category="RigVM"

virtual const TArray< UAssetUserData * > * GetAssetUserDataArray()

   RigVMHost.h  

virtual UAssetUserData * GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

   RigVMHost.h  

float GetCurrentFramesPerSecond()

 Returns the current frames per second (this may change over time) RigVMHost.h
  • BlueprintPure
  • Category="RigVM"
  RigVMHost.h  
  RigVMHost.h  
  RigVMHost.h  
The instanced debug watch memory. RigVMHost.h  

virtual const FRigVMMemoryStorageStruct * GetDefaultMemoryByType ( ERigVMMemoryType InMemoryType
) const

 Returns the compiler generated VM memory storage by type. RigVMHost.h  

float GetDeltaTime()

 Gets the current delta time RigVMHost.h
  • BlueprintPure
  • Category="RigVM"
  RigVMHost.h  
  RigVMHost.h  
  RigVMHost.h  
  RigVMHost.h  

FTransactionallySafeCriticalSection & GetEvaluateMutex()

 Locks for the scope of Evaluate_AnyThread RigVMHost.h  

const TArray< FName > & GetEventQueue()

 Returns the queue of events to run RigVMHost.h  

FTransactionallySafeCriticalSection & GetEventQueueToRunOnceMutex()

 Lock for editing the event queue to run once RigVMHost.h  
Provide access to the ExtendedExecuteContext RigVMHost.h  
Provide access to the ExtendedExecuteContext RigVMHost.h
  • BlueprintCallable
  • Category=RigVM
  • Meta=(DeprecatedFunction, DeprecationMessage="This function has been deprecated and it is no longer supported.")

TArray< FRigVMExternalVariable > GetExternalVariables()

 Returns the member properties as an external variable array RigVMHost.h  
The default const literal memory. RigVMHost.h  
  RigVMHost.h  
  RigVMHost.h  

const FRigVMLog * GetLog ()

   RigVMHost.h  
Returns an instanced VM memory storage by type. RigVMHost.h  

virtual const FRigVMMemoryStorageStruct * GetMemoryByType ( ERigVMMemoryType InMemoryType
) const

   RigVMHost.h  

virtual FString GetName()

   RigVMHost.h  

virtual USceneComponent * GetOwningSceneComponent()

   RigVMHost.h  
  RigVMHost.h  
  RigVMHost.h  

virtual UScriptStruct * GetPublicContextStruct()

 Returns the public context script struct to use for this owner RigVMHost.h  

FRigVMExternalVariable GetPublicVariableByName ( const FName& InVariableName
) const

 Returns a public variable given its name RigVMHost.h  

TArray< FRigVMExternalVariable > GetPublicVariables()

 Returns the public member properties as an external variable array RigVMHost.h  

T GetPublicVariableValue ( const FName& InVariableName
)

   RigVMHost.h  
  RigVMHost.h  
  RigVMHost.h  

TArray< FName > GetScriptAccessibleVariables()

 Returns the names of variables accessible in scripting RigVMHost.h
  • BlueprintPure
  • Category="RigVM"
  • Meta=(DisplayName="Get Variables")

virtual const TArray< FName > & GetSupportedEvents()

   RigVMHost.h
  • BlueprintPure
  • Category="RigVM"

FString GetVariableAsString ( const FName& InVariableName
) const

 Returns the value of a given variable as a string RigVMHost.h
  • BlueprintPure
  • Category="RigVM"

FName GetVariableType ( const FName& InVariableName
) const

 Returns the type of a given variable RigVMHost.h
  • BlueprintPure
  • Category="RigVM"

URigVM * GetVM()

   RigVMHost.h
  • BlueprintPure
  • Category="RigVM"
  RigVMHost.h  
The instanced mutable work memory. RigVMHost.h  

virtual UWorld * GetWorld()

 UObject interface RigVMHost.h  

virtual void Initialize ( bool bRequestInit
)

 Initialize things for the RigVM owner RigVMHost.h  

virtual bool InitializeVM ( const FName& InEventName
)

 Initialize this Host VM Instance RigVMHost.h  

void InstantiateVMFromCDO()

 Copy the VM from the default object RigVMHost.h  

virtual void InvalidateCachedMemory()

   RigVMHost.h  

bool IsEvaluating()

 Returns true if Evaluate_AnyThread is currently executing RigVMHost.h  

bool IsInDebugMode()

   RigVMHost.h  

virtual bool IsInitRequired()

 Returns true if this host requires the VM memory to be initialized RigVMHost.h
  • BlueprintPure
  • Category="RigVM"

bool IsProfilingEnabled()

   RigVMHost.h  

bool IsRunOnceEvent ( const FName& InEventName
) const

 Returns true if an event is queued to run once RigVMHost.h  

FOnEndLoadPackage & OnEndLoadPackage()

   RigVMHost.h  

FRigVMExecutedEvent & OnExecuted_AnyThread()

   RigVMHost.h  

FRigVMExecutedEvent & OnInitialized_AnyThread()

   RigVMHost.h  

FRigVMExecutedEvent & OnPreExecuted_AnyThread()

   RigVMHost.h  

virtual void PostInitInstanceIfRequired()

   RigVMHost.h  

virtual void RecreateCachedMemory()

 Regenerates cached handles after a structural change (i.e. new UUserStruct) RigVMHost.h  

bool RemoveRunOnceEvent ( const FName& InEventName
)

 Removes an event running once RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

virtual void RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUserDataClass
)

   RigVMHost.h  

virtual void RequestInit()

 Requests to perform an init during the next execution RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

virtual void RequestRunOnceEvent ( const FName& InEventName,
int32 InEventIndex
)

 Requests to run an event once RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

UObject * ResolveUserDefinedTypeById ( const FString& InTypeName
) const

   RigVMHost.h  

void SetAbsoluteAndDeltaTime ( float InAbsoluteTime,
float InDeltaTime
)

 Set the current absolute and delta times RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

void SetAbsoluteTime ( float InAbsoluteTime,
bool InSetDeltaTimeZero
)

 Set the current absolute time RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

void SetDeltaTime ( float InDeltaTime
)

 Set the current delta time RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

void SetEventQueue ( const TArray< FName >& InEventNames
)

 Sets the queue of events to run RigVMHost.h  

void SetFramesPerSecond ( float InFramesPerSecond
)

 Set the current fps RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

void SetIsInDebugMode ( const bool bValue
)

   RigVMHost.h  

void SetLog ( FRigVMLog* InLog
)

   RigVMHost.h  

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

   RigVMHost.h  

void SetRigVMExtendedExecuteContext ( FRigVMExtendedExecuteContext* InRigVMExtendedExecuteContext
)

   RigVMHost.h  

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

 Returns the value of a given variable as a string RigVMHost.h
  • BlueprintCallable
  • Category="RigVM"

bool SupportsEvent ()

   RigVMHost.h  

virtual bool SupportsEvent ( const FName& InEventName
) const

   RigVMHost.h
  • BlueprintPure
  • Category="RigVM"

void SwapVMToNativizedIfRequired ( UClass* InNativizedClass
)

   RigVMHost.h  

void UpdateVMSettings()

 Update the settings such as array bound and log facilities RigVMHost.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   RigVMHost.h  

virtual void PostLoad()

   RigVMHost.h  

virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext
)

   RigVMHost.h  

virtual void Serialize ( FArchive& Ar
)

   RigVMHost.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void CopyVMMemory ( FRigVMExtendedExecuteContext& TargetContext,
const FRigVMExtendedExecuteContext& SourceContext
)

   RigVMHost.h  

virtual bool Execute_Internal ( const FName& InEventName
)

 ExecuteUnits RigVMHost.h  

void GenerateUserDefinedDependenciesData ( FRigVMExtendedExecuteContext& Context
)

   RigVMHost.h  

virtual TArray< FRigVMExternalVariable > GetExternalVariablesImpl ( bool bFallbackToBlueprint
) const

   RigVMHost.h  

FProperty * GetPublicVariableProperty ( const FName& InVariableName
) const

   RigVMHost.h  

TArray< const UObject * > GetUserDefinedDependencies ( const TArray< const FRigVMMemoryStorageStruct* > InMemory
)

   RigVMHost.h  

void HandleExecutionReachedExit ( const FName& InEventName
)

   RigVMHost.h  

virtual bool InitializeCDOVM()

 Initialize the CDO VM RigVMHost.h  

virtual void InitializeFromCDO()

   RigVMHost.h  

bool IsExecuting()

   RigVMHost.h  

bool IsInitializing()

   RigVMHost.h  

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

   RigVMHost.h  

virtual void PostInitInstance ( URigVMHost* InCDO
)

   RigVMHost.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool AreNativizedVMsDisabled()

   RigVMHost.h  

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

   RigVMHost.h  

static bool DisableExecution()

   RigVMHost.h  

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

   RigVMHost.h
  • BlueprintCallable
  • Category=RigVM

static bool IsGarbageOrDestroyed ( const UObject* InObject
)

   RigVMHost.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page