FRigVMRegisterOffset | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/RigVM

The register offset represents a memory offset within a register's memory. This can be used to represent memory addresses of array elements within a struct, for example. A register offset's path can look like MyTransformStruct.Transforms[3].Translation.X


Name	FRigVMRegisterOffset
Type	struct
Header File	/Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryDeprecated.h
Include Path	#include "RigVMCore/RigVMMemoryDeprecated.h"

Syntax

USTRUCT ()  
struct FRigVMRegisterOffset

Constructors

Name	Remarks	Include Path	Unreal Specifiers
FRigVMRegisterOffset ()	Default constructor	RigVMCore/RigVMMemoryDeprecated.h
FRigVMRegisterOffset ( UScriptStruct* InScriptStruct, const FString& InSegmentPath, int32 InInitialOffset, uint16 InElementSize, const FName& InCPPType )	Constructs a path given a struct and a segment path	RigVMCore/RigVMMemoryDeprecated.h

Variables

Protected

Name	Type	Remarks	Include Path
ArrayIndex	int32	The index of the element within an array (for example 3 for Transform[3])	RigVMCore/RigVMMemoryDeprecated.h
CachedSegmentPath	FString	The cached path of the segments within this register, for example FTransform.Translation.X.	RigVMCore/RigVMMemoryDeprecated.h
CPPType	FName	The c++ type of the resulting memory (for example float for Transform.Translation.X)	RigVMCore/RigVMMemoryDeprecated.h
ElementSize	uint16	The number of bytes of the resulting memory (for example 4 (float) for Transform.Translation.X)	RigVMCore/RigVMMemoryDeprecated.h
ParentScriptStruct	TObjectPtr< UScriptStruct >	The c++ script struct of the source memory (for example FTransform for Transform.Translation)	RigVMCore/RigVMMemoryDeprecated.h
ScriptStruct	TObjectPtr< UScriptStruct >	The c++ script struct of the resulting memory (for example FVector for Transform.Translation)	RigVMCore/RigVMMemoryDeprecated.h
Segments	TArray< int32 >	Segments represent the memory offset(s) to use when accessing the target memory.	RigVMCore/RigVMMemoryDeprecated.h
Type	ERigVMRegisterType	Type of resulting register (for example Plain for Transform.Translation.X)	RigVMCore/RigVMMemoryDeprecated.h

Functions

Public

Name	Remarks	Include Path
bool ContainsArraySegment ()	Returns true if this register offset contains an array segment.	RigVMCore/RigVMMemoryDeprecated.h
int32 GetArrayIndex()		RigVMCore/RigVMMemoryDeprecated.h
FString GetCachedSegmentPath()		RigVMCore/RigVMMemoryDeprecated.h
FName GetCPPType()		RigVMCore/RigVMMemoryDeprecated.h
uint8 * GetData ( uint8* InContainer ) const	Returns the data pointer within a container	RigVMCore/RigVMMemoryDeprecated.h
uint16 GetElementSize()		RigVMCore/RigVMMemoryDeprecated.h
UScriptStruct * GetScriptStruct()		RigVMCore/RigVMMemoryDeprecated.h
const TArray< int32 > & GetSegments()	Returns the segments of this path	RigVMCore/RigVMMemoryDeprecated.h
ERigVMRegisterType GetType()		RigVMCore/RigVMMemoryDeprecated.h
bool IsValid()		RigVMCore/RigVMMemoryDeprecated.h
void Load ( FArchive& Ar )		RigVMCore/RigVMMemoryDeprecated.h
void Save ( FArchive& Ar )		RigVMCore/RigVMMemoryDeprecated.h
void Serialize ( FArchive& Ar )		RigVMCore/RigVMMemoryDeprecated.h
void SetElementSize ( uint16 InElementSize )		RigVMCore/RigVMMemoryDeprecated.h

Operators

Name	Remarks	Include Path	Unreal Specifiers
bool operator== ( const FRigVMRegisterOffset& InOther ) const		RigVMCore/RigVMMemoryDeprecated.h

Navigation