Navigation
API > API/Plugins > API/Plugins/RigVM > API/Plugins/RigVM/RigVMCore
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- URigVMMemoryStorage
References
| Module | RigVM |
| Header | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryStorage.h |
| Include | #include "RigVMCore/RigVMMemoryStorage.h" |
Syntax
UCLASS&40;&41;
class URigVMMemoryStorage : public UObject
Remarks
The URigVMMemoryStorage represents an instance of heterogeneous memory. The memory layout is defined by the URigVMMemoryStorageGeneratorClass.
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | CopyFrom
(
URigVMMemoryStorage* InSourceMemory |
||
| bool | CopyProperty
(
URigVMMemoryStorage* InTargetStorage, |
Copies the content of a source property and memory into the memory of a target property. | |
| bool | CopyProperty
(
const FProperty* InTargetProperty, |
Copies the content of a source property and memory into the memory of a target property. | |
| bool | CopyProperty
(
const FProperty* InTargetProperty, |
Copies the content of a source property and memory into the memory of a target property | |
| bool | CopyProperty
(
FRigVMMemoryHandle& InTargetHandle, |
Copies the content of a source property and memory into the memory of a target property. | |
| FProperty * | FindPropertyByName
(
const FName& InName |
Returns a property given its name (or nullptr if the name wasn't found) | |
| T * | GetData
(
int32 InPropertyIndex, |
Returns the memory for a property given its index and a matching property path. | |
| T * | GetData
(
const FRigVMOperand& InOperand |
Returns the memory for a property (and optionally a property path) given an operand. | |
| T * | GetData
(
int32 InPropertyIndex |
Returns the memory for a property given its index. | |
| FString | GetDataAsString
(
int32 InPropertyIndex, |
Returns the exported text for a given property index. | |
| FString | GetDataAsString
(
const FRigVMOperand& InOperand, |
Returns the exported text for a given operand. | |
| FString | GetDataAsStringByName
(
const FName& InName, |
Returns the exported text for given property name. | |
| FString | GetDataAsStringByNameSafe
(
const FName& InName, |
Returns the exported text for given property name. | |
| FString | GetDataAsStringSafe
(
const FRigVMOperand& InOperand, |
Returns the exported text for a given operand. | |
| FString | GetDataAsStringSafe
(
int32 InPropertyIndex, |
Returns the exported text for a given property index. | |
| T * | GetDataByName
(
const FName& InName, |
Returns the memory for a property given its name and a matching property path (or nullptr) | |
| T * | GetDataByName
(
const FName& InName |
Returns the memory for a property given its name (or nullptr) | |
| FRigVMMemoryHandle | GetHandle
(
int32 InPropertyIndex, |
Returns the handle for a given property by index (and optionally property path) | |
| FRigVMMemoryHandle | GetHandleByName
(
const FName& InName, |
Returns the handle for a given property by name (and optionally property path) | |
| uint32 | Returns a hash of unique to the configuration of the memory. | ||
| ERigVMMemoryType | Memory Access. | ||
| FRigVMOperand | GetOperand
(
int32 InPropertyIndex, |
Creates and returns a new operand for a property (and optionally a property path) | |
| FRigVMOperand | GetOperandByName
(
const FName& InName, |
Creates and returns a new operand for a property (and optionally a property path) | |
| const TArray< const FProperty * > & | Returns the properties provided by this instance. | ||
| const FProperty * | GetProperty
(
int32 InPropertyIndex |
Returns a property given its index. | |
| int32 | GetPropertyIndex
(
const FProperty* InProperty |
Returns the index of a property given the property itself. | |
| int32 | GetPropertyIndexByName
(
const FName& InName |
Returns the index of a property given its name. | |
| const TArray< FRigVMPropertyPath > & | Returns the property paths provided by this instance. | ||
| T & | GetRef
(
const FRigVMOperand& InOperand |
Returns the ref of an element stored for a given operand. | |
| T & | GetRef
(
int32 InPropertyIndex |
Returns the ref of an element stored at a given property index. | |
| T & | GetRef
(
int32 InPropertyIndex, |
Returns the ref of an element stored at a given property index and a property path. | |
| T & | GetRefByName
(
const FName& InName, |
Returns the ref of an element stored at a given property name and a property path (throws if name is invalid) | |
| T & | GetRefByName
(
const FName& InName |
Returns the ref of an element stored at a given property name (throws if name is invalid) | |
| FRigVMMemoryStatistics | Returns the statistics information | ||
| bool | IsArray
(
int32 InPropertyIndex |
Returns true if the property at a given index is a TArray. | |
| bool | IsMap
(
int32 InPropertyIndex |
Returns true if the property at a given index is a TMap. | |
| bool | IsValidIndex
(
int32 InIndex |
Returns true if a provided property index is valid. | |
| int32 | Num () |
Returns the number of properties stored in this instance. | |
| bool | SetDataFromString
(
int32 InPropertyIndex, |
Sets the content of a property by index given an exported string. Returns true if succeeded. | |
| bool | SetDataFromStringByName
(
const FName& InName, |
Sets the content of a property by name given an exported string. Returns true if succeeded. |
Constants
| Name | Description |
|---|---|
| EmptyProperties | |
| EmptyPropertyPaths |