Navigation
API > API/Plugins > API/Plugins/RigVM
The property description is used to provide all required information to create a property for the memory storage class.
| Name | FRigVMPropertyDescription |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/RigVM/Source/RigVM/Public/RigVMCore/RigVMMemoryStorage.h |
| Include Path | #include "RigVMCore/RigVMMemoryStorage.h" |
Syntax
struct FRigVMPropertyDescription
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Default constructor. | RigVMCore/RigVMMemoryStorage.h | ||
FRigVMPropertyDescription
(
const FProperty* InProperty, |
Constructor from an existing property. | RigVMCore/RigVMMemoryStorage.h | |
FRigVMPropertyDescription
(
const FName& InName, |
Constructor from complete data. | RigVMCore/RigVMMemoryStorage.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ArrayPrefix | const TCHAR * | RigVMCore/RigVMMemoryStorage.h | |
| ContainerSuffix | const TCHAR * | RigVMCore/RigVMMemoryStorage.h | |
| MapPrefix | const TCHAR * | RigVMCore/RigVMMemoryStorage.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Containers | TArray< EPinContainerType > | A list of containers to use for this property, for example [Array, Array]. | RigVMCore/RigVMMemoryStorage.h | |
| CPPType | FString | The complete CPP type to base a new property off of (for ex: 'TArray |
RigVMCore/RigVMMemoryStorage.h | |
| CPPTypeObject | UObject * | The tail CPP Type object, for example the UScriptStruct for a struct. | RigVMCore/RigVMMemoryStorage.h | |
| DefaultValue | FString | The default value to use for this property (for example: '(((X=1.000000, Y=2.000000, Z=3.000000)))') | RigVMCore/RigVMMemoryStorage.h | |
| Name | FName | The name of the property to create. | RigVMCore/RigVMMemoryStorage.h | |
| Property | const FProperty * | The property to base a new property off of. | RigVMCore/RigVMMemoryStorage.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetTailCPPType() |
Returns the CPP type of the tail property, for ex: '[2].Translation' it is 'FVector'. | RigVMCore/RigVMMemoryStorage.h | |
bool IsValid() |
Returns true if this property description is valid. | RigVMCore/RigVMMemoryStorage.h | |
void SanitizeName () |
Sanitize the name of this description in line. | RigVMCore/RigVMMemoryStorage.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName SanitizeName
(
const FName& InName |
Returns a sanitized, valid name to use for a new property. | RigVMCore/RigVMMemoryStorage.h | |
static void SanitizeName
(
FString& InString |
Sanitizes a name using a string ref, creating a valid name to use for a new property. | RigVMCore/RigVMMemoryStorage.h |