FPCGSourceDataContainer

A container for data storage on an Execution Source, supporting unique keying and Crc compatibility.

API > API/Plugins > API/Plugins/PCG

A container for data storage on an Execution Source, supporting unique keying and Crc compatibility. NOTE: This container is READ-ONLY at runtime.

   
Name FPCGSourceDataContainer
Type struct
Header File /Engine/Plugins/PCG/Source/PCG/Public/Graph/PCGSourceDataContainer.h
Include Path #include "Graph/PCGSourceDataContainer.h"

Syntax

USTRUCT ()  
struct FPCGSourceDataContainer

Constructors

Name Remarks Include Path Unreal Specifiers
  Graph/PCGSourceDataContainer.h  
Required by USTRUCT NOT THREAD SAFE: These must only be called from a single thread with no concurrent readers/writers. Graph/PCGSourceDataContainer.h  
  Graph/PCGSourceDataContainer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FPCGSourceDataContainer()

   Graph/PCGSourceDataContainer.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAutoDirty TAtomic< bool > Automatically increments the dirty generation to invalidate the Crc node cache. Graph/PCGSourceDataContainer.h  
DataStorage TMap< FPCGSourceDataStorageKey, FPCGSourceDataStorageValue >   Graph/PCGSourceDataContainer.h  
DataStorageLock PCG::FSharedLock   Graph/PCGSourceDataContainer.h  
DirtyGeneration uint32 Mark the source data container dirty by incrementing this, which will invalidate the Crc cache. Graph/PCGSourceDataContainer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddStructReferencedObjects ( FReferenceCollector& Collector
) const

 Report referenced UObjects from all stored shared structs to the GC. Graph/PCGSourceDataContainer.h  

void Empty()

 Empty the contents of the container. Graph/PCGSourceDataContainer.h  
Get a const shared reference to stored data by type. Graph/PCGSourceDataContainer.h  

uint32 GetDirtyGeneration()

 Get the dirty generation value for Crc combination. Graph/PCGSourceDataContainer.h  
Get a mutable shared reference to stored data by type. Graph/PCGSourceDataContainer.h  

bool IsEmpty()

 True if the storage is empty. Graph/PCGSourceDataContainer.h  

void MarkDirty()

 Mark the container dirty to invalidate the Crc cache. Graph/PCGSourceDataContainer.h  

int32 Num()

 Get the number of storage values. Graph/PCGSourceDataContainer.h  

bool Remove ( const FPCGSourceDataStorageKey& DataKey
)

 Remove the data attached to a specific Data Key. Graph/PCGSourceDataContainer.h  

bool Serialize ( FArchive& Ar
)

 Custom serialization for the container. Graph/PCGSourceDataContainer.h  

void SetShouldAutoDirty ( bool bShouldAutoDirty
)

 Set the container to automatically dirty to invalidate the Crc cache. Graph/PCGSourceDataContainer.h  

void Store ( const FPCGSourceDataStorageKey& DataKey,
const T& Data
)

 Store data of type T within the storage container. Graph/PCGSourceDataContainer.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Graph/PCGSourceDataContainer.h  
  Graph/PCGSourceDataContainer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page