RigVM.DisableExecutionAll

RigVM.DisableExecutionAll

#Overview

name: RigVM.DisableExecutionAll

This variable is created as a Console Variable (cvar).

• type: Var
• help: if nonzero we disable all execution of rigvms.

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of RigVM.DisableExecutionAll is to provide a way to disable all execution of RigVMs (Rig Virtual Machines) in Unreal Engine 5. This setting variable is part of the RigVM system, which is likely used for animation and rigging purposes within the engine.

• The RigVM plugin, which is part of the Runtime plugins in Unreal Engine 5, relies on this setting variable. Specifically, it’s used in the RigVMHost class within the RigVM module.

• The value of this variable is set through a console variable (CVar) named CVarRigVMDisableExecutionAll. It’s initialized with a default value of 0, meaning RigVM execution is enabled by default.

• This variable interacts with the URigVMHost::DisableExecution() function, which checks the value of CVarRigVMDisableExecutionAll to determine if execution should be disabled.

• Developers must be aware that setting this variable to a non-zero value will disable all RigVM execution, which could have significant impacts on animation and rigging functionality in their project.

• Best practices when using this variable include:

  1. Using it for debugging purposes when investigating RigVM-related issues.
  2. Ensuring it’s set back to 0 (enabled) for normal operation.
  3. Being cautious when modifying this in a production environment, as it could break animation systems.

Regarding the associated variable CVarRigVMDisableExecutionAll:

• Its purpose is to act as the actual console variable that controls the RigVM.DisableExecutionAll setting.

• It’s defined in the RigVMHost.cpp file and is used within the RigVM module.

• The value is set when the variable is initialized, but can be changed at runtime through console commands.

• It directly interacts with the DisableExecution() function of the URigVMHost class.

• Developers should be aware that this is a TAutoConsoleVariable, meaning it can be modified at runtime through console commands.

• Best practices include:

  1. Using console commands to toggle this setting for debugging.
  2. Avoiding direct manipulation of this variable in code; instead, use the DisableExecution() function.
  3. Documenting any use of this variable in project documentation to ensure team awareness of potential animation system impacts.

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Plugins/Runtime/RigVM/Source/RigVM/Private/RigVMHost.cpp:20

Scope: file

Source code excerpt:

// CVar to disable all rigvm execution 
static TAutoConsoleVariable<int32> CVarRigVMDisableExecutionAll(TEXT("RigVM.DisableExecutionAll"), 0, TEXT("if nonzero we disable all execution of rigvms."));

// CVar to disable swapping to nativized vms 
static TAutoConsoleVariable<int32> CVarRigVMDisableNativizedVMs(TEXT("RigVM.DisableNativizedVMs"), 1, TEXT("if nonzero we disable swapping to nativized VMs."));

URigVMHost::URigVMHost(const FObjectInitializer& ObjectInitializer)
	: Super(ObjectInitializer)

#Associated Variable and Callsites

This variable is associated with another variable named CVarRigVMDisableExecutionAll. They share the same value. See the following C++ source code.

#Loc: <Workspace>/Engine/Plugins/Runtime/RigVM/Source/RigVM/Private/RigVMHost.cpp:20

Scope: file

Source code excerpt:

// CVar to disable all rigvm execution 
static TAutoConsoleVariable<int32> CVarRigVMDisableExecutionAll(TEXT("RigVM.DisableExecutionAll"), 0, TEXT("if nonzero we disable all execution of rigvms."));

// CVar to disable swapping to nativized vms 
static TAutoConsoleVariable<int32> CVarRigVMDisableNativizedVMs(TEXT("RigVM.DisableNativizedVMs"), 1, TEXT("if nonzero we disable swapping to nativized VMs."));

URigVMHost::URigVMHost(const FObjectInitializer& ObjectInitializer)
	: Super(ObjectInitializer)

#Loc: <Workspace>/Engine/Plugins/Runtime/RigVM/Source/RigVM/Private/RigVMHost.cpp:644

Scope (from outer to inner):

file
function     bool URigVMHost::DisableExecution

Source code excerpt:

bool URigVMHost::DisableExecution()
{
	return CVarRigVMDisableExecutionAll->GetInt() == 1;
}

bool URigVMHost::InitializeCDOVM()
{
	check(VM != nullptr);
	check(VM->HasAnyFlags(RF_ClassDefaultObject | RF_DefaultSubObject));