FRigVMPropertyBag

API > API/Plugins > API/Plugins/RigVM

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

Syntax

USTRUCT ()  
struct FRigVMPropertyBag : public FInstancedPropertyBag

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FRigVMPropertyBag()

   RigVMCore/RigVMPropertyBag.h  

Constants

Name Type Remarks Include Path
EmptyProperties const TArray< const FProperty * >   RigVMCore/RigVMPropertyBag.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddProperties ( const TArray< FRigVMPropertyDescription >& InPropertyDescriptions
)

 Adds properties to the storage. RigVMCore/RigVMPropertyBag.h  

void AddStructReferencedObjects ( FReferenceCollector& Collector
)

   RigVMCore/RigVMPropertyBag.h  

FProperty * FindPropertyByName ( const FName& InName
) const

 Returns a property given its name (or nullptr if the name wasn't found) RigVMCore/RigVMPropertyBag.h  

void * GetContainerPtr()

 Returns the raw memory storage pointer. RigVMCore/RigVMPropertyBag.h  

T * GetData ( const FProperty* Property
)

 Returns the mutable memory for a given property (or nullptr if does not belong to this storage) RigVMCore/RigVMPropertyBag.h  

const T * GetData ( const FProperty* Property
) const

   RigVMCore/RigVMPropertyBag.h  

T * GetData ( int32 InPropertyIndex,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the memory for a property given its index and a matching property path. RigVMCore/RigVMPropertyBag.h  

const T * GetData ( int32 InPropertyIndex
) const

   RigVMCore/RigVMPropertyBag.h  

T * GetData ( int32 InPropertyIndex
)

 Returns the memory for a property given its index. RigVMCore/RigVMPropertyBag.h  

FString GetDataAsString ( int32 InPropertyIndex,
int32 PortFlags
) const

 Returns the exported text for a given property index. RigVMCore/RigVMPropertyBag.h  

FString GetDataAsStringByName ( const FName& InName,
int32 PortFlags
) const

 Returns the exported text for given property name. RigVMCore/RigVMPropertyBag.h  

FString GetDataAsStringByNameSafe ( const FName& InName,
int32 PortFlags
) const

 Returns the exported text for given property name. RigVMCore/RigVMPropertyBag.h  

FString GetDataAsStringSafe ( int32 InPropertyIndex,
int32 PortFlags
) const

 Returns the exported text for a given property index. RigVMCore/RigVMPropertyBag.h  

T * GetDataByName ( const FName& InName,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the memory for a property given its name and a matching property path (or nullptr) RigVMCore/RigVMPropertyBag.h  

T * GetDataByName ( const FName& InName
)

 Returns the memory for a property given its name (or nullptr) RigVMCore/RigVMPropertyBag.h  

const TArray< const FProperty * > & GetProperties()

 Returns the properties provided by this instance. RigVMCore/RigVMPropertyBag.h  

const FProperty * GetProperty ( int32 InPropertyIndex
) const

 Returns a property given its index. RigVMCore/RigVMPropertyBag.h  

int32 GetPropertyIndex ( const FProperty* InProperty
) const

 Returns the index of a property given the property itself. RigVMCore/RigVMPropertyBag.h  

int32 GetPropertyIndexByName ( const FName& InName
) const

 Returns the index of a property given its name. RigVMCore/RigVMPropertyBag.h  

T & GetRef ( int32 InPropertyIndex,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the ref of an element stored at a given property index and a property path. RigVMCore/RigVMPropertyBag.h  

T & GetRef ( int32 InPropertyIndex
)

 Returns the ref of an element stored at a given property index. RigVMCore/RigVMPropertyBag.h  

T & GetRefByName ( const FName& InName,
const FRigVMPropertyPath& InPropertyPath
)

 Returns the ref of an element stored at a given property name and a property path (throws if name is invalid) RigVMCore/RigVMPropertyBag.h  

T & GetRefByName ( const FName& InName
)

 Returns the ref of an element stored at a given property name (throws if name is invalid) RigVMCore/RigVMPropertyBag.h  

void GetRequiredPlugins ( TArray< FString >& OutPlugins
) const

   RigVMCore/RigVMPropertyBag.h  

void GetUserDefinedDependencies ( TArray< const UObject* >& OutDependencies
) const

   RigVMCore/RigVMPropertyBag.h  

bool IsArray ( int32 InPropertyIndex
) const

 Returns true if the property at a given index is a TArray. RigVMCore/RigVMPropertyBag.h  

bool IsMap ( int32 InPropertyIndex
) const

 Returns true if the property at a given index is a TMap. RigVMCore/RigVMPropertyBag.h  

bool IsValidIndex ( int32 InIndex
) const

 Returns true if a provided property index is valid. RigVMCore/RigVMPropertyBag.h  

int32 Num()

 Returns the number of properties stored in this instance. RigVMCore/RigVMPropertyBag.h  

void Refresh()

   RigVMCore/RigVMPropertyBag.h  

EPropertyBagAlterationResult RemovePropertyByName ( const FName& InPropertyName
)

 Remove property from the storage. RigVMCore/RigVMPropertyBag.h  

bool Serialize ( FArchive& Ar
)

   RigVMCore/RigVMPropertyBag.h  

bool SetDataFromString ( int32 InPropertyIndex,
const FString& InValue
)

 Sets the content of a property by index given an exported string. Returns true if succeeded. RigVMCore/RigVMPropertyBag.h  

bool SetDataFromStringByName ( const FName& InName,
const FString& InValue
)

 Sets the content of a property by name given an exported string. Returns true if succeeded. RigVMCore/RigVMPropertyBag.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ForEachObjectDependency ( const TFunction< void(const UObject*)>& InCallBack
) const

   RigVMCore/RigVMPropertyBag.h  

void RefreshLinkedProperties()

   RigVMCore/RigVMPropertyBag.h  

void SetDefaultValues ( const TArray< FRigVMPropertyDescription >& InPropertyDescriptions
)

   RigVMCore/RigVMPropertyBag.h  

void SetDefaultValuesOnTailProperties ( const TArray< FRigVMPropertyDescription >& InPropertyDescriptions
)

 Set default values on the last properties added. RigVMCore/RigVMPropertyBag.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CopyProperty ( const FProperty* InTargetProperty,
uint8* InTargetPtr,
const FProperty* InSourceProperty,
const uint8* InSourcePtr
)

 Copies the content of a source property and memory into the memory of a target property RigVMCore/RigVMPropertyBag.h  

static FPropertyBagPropertyDesc GeneratePropertyBagDescriptor ( const FRigVMPropertyDescription& RigVMDescriptor,
bool bComputeId
)

 Helper function to generate a property bag desc from a FRigVMPropertyDescription. RigVMCore/RigVMPropertyBag.h  

static bool GetPropertyTypeDataFromVMDescriptor ( const FRigVMPropertyDescription& RigVMDescriptor,
EPropertyBagPropertyType& OutBagPropertyType,
FPropertyBagContainerTypes& OutBagContainerTypes
)

   RigVMCore/RigVMPropertyBag.h  

static bool IsClassOf ( const FRigVMPropertyBag* InElement
)

   RigVMCore/RigVMPropertyBag.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page