unreal.RigVM

class unreal.RigVM(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

The RigVM is the main object for evaluating FRigVMByteCode instructions. It combines the byte code, a list of required function pointers for execute instructions and required memory in one class.

C++ Source:

  • Plugin: RigVM

  • Module: RigVM

  • File: RigVM.h

execute(entry_name='None') RigVMExtendedExecuteContext or None

Executes the VM. You can optionally provide external memory to the execution and provide optional additional operands.

Parameters:

entry_name (Name) –

Returns:

context (RigVMExtendedExecuteContext):

Return type:

RigVMExtendedExecuteContext or None

get_parameter_value_bool(parameter_name, array_index=0) bool

Get Parameter Value Bool

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

bool

get_parameter_value_double(parameter_name, array_index=0) double

Get Parameter Value Double

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

double

get_parameter_value_float(parameter_name, array_index=0) float

Get Parameter Value Float

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

float

get_parameter_value_int(parameter_name, array_index=0) int32

Get Parameter Value Int

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

int32

get_parameter_value_name(parameter_name, array_index=0) Name

Get Parameter Value Name

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

Name

get_parameter_value_quat(parameter_name, array_index=0) Quat

Get Parameter Value Quat

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

Quat

get_parameter_value_string(parameter_name, array_index=0) str

Get Parameter Value String

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

str

get_parameter_value_transform(parameter_name, array_index=0) Transform

Get Parameter Value Transform

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

Transform

get_parameter_value_vector(parameter_name, array_index=0) Vector

Get Parameter Value Vector

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

Vector

get_parameter_value_vector2d(parameter_name, array_index=0) Vector2D

Get Parameter Value Vector 2D

Parameters:
  • parameter_name (Name) –

  • array_index (int32) –

Return type:

Vector2D

get_statistics() RigVMStatistics

returns the statistics information deprecated: Function ‘GetStatistics’ is deprecated.

Return type:

RigVMStatistics

set_parameter_value_bool(parameter_name, value, array_index=0) None

Set Parameter Value Bool

Parameters:
  • parameter_name (Name) –

  • value (bool) –

  • array_index (int32) –

set_parameter_value_double(parameter_name, value, array_index=0) None

Set Parameter Value Double

Parameters:
  • parameter_name (Name) –

  • value (double) –

  • array_index (int32) –

set_parameter_value_float(parameter_name, value, array_index=0) None

Set Parameter Value Float

Parameters:
  • parameter_name (Name) –

  • value (float) –

  • array_index (int32) –

set_parameter_value_int(parameter_name, value, array_index=0) None

Set Parameter Value Int

Parameters:
  • parameter_name (Name) –

  • value (int32) –

  • array_index (int32) –

set_parameter_value_name(parameter_name, value, array_index=0) None

Set Parameter Value Name

Parameters:
  • parameter_name (Name) –

  • value (Name) –

  • array_index (int32) –

set_parameter_value_quat(parameter_name, value, array_index=0) None

Set Parameter Value Quat

Parameters:
  • parameter_name (Name) –

  • value (Quat) –

  • array_index (int32) –

set_parameter_value_string(parameter_name, value, array_index=0) None

Set Parameter Value String

Parameters:
  • parameter_name (Name) –

  • value (str) –

  • array_index (int32) –

set_parameter_value_transform(parameter_name, value, array_index=0) None

Set Parameter Value Transform

Parameters:
  • parameter_name (Name) –

  • value (Transform) –

  • array_index (int32) –

set_parameter_value_vector(parameter_name, value, array_index=0) None

Set Parameter Value Vector

Parameters:
  • parameter_name (Name) –

  • value (Vector) –

  • array_index (int32) –

set_parameter_value_vector2d(parameter_name, value, array_index=0) None

Set Parameter Value Vector 2D

Parameters:
  • parameter_name (Name) –

  • value (Vector2D) –

  • array_index (int32) –