1. Epic GamesDeveloper
  3. UDataTable

UDataTable

Imported spreadsheet table.

Unreal Engine C++ API Reference > Runtime > Engine > Engine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Engine/DataTable.h
Include #include "Engine/DataTable.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, AutoExpandCategories="DataTable,ImportOptions",  
       Meta=(LoadBehavior="LazyOnDemand"))  
class UDataTable : public UObject

Remarks

Imported spreadsheet table.

Variables

  Type Name Description
Public variable UProperty Category instanced, visibleanywhere TObjectPtr< class UAssetImportData > AssetImportData The file this data table was imported from, may be empty
Public variable UProperty Category, EditAnywhere uint8: 1 bIgnoreExtraFields Set to true to ignore extra fields in the import data, if false it will warn about them
Public variable UProperty Category, EditAnywhere uint8: 1 bIgnoreMissingFields Set to true to ignore any fields that are expected but missing, if false it will warn about them
Public variable UProperty Category, EditAnywhere uint8: 1 bPreserveExistingValues Set to true to preserve existing values for any fields that are expected but missing in the CSV file.
Public variable UProperty Category, EditAnywhere uint8: 1 bStripFromClientBuilds Set to true to not cook this data table into client builds.
Public variable friend FDataTableEditorUtils  
Public variable friend FDataTableImporterCSV  
Public variable friend FDataTableImporterJSON  
Public variable UProperty Category, EditAnywhere FString ImportKeyField Explicit field in import data to use as key.
Protected variable TMap< FName, uint8 * > RowMap Map of name of row to row data structure.
Protected variable UProperty Transient TArray< uint8 > RowsSerializedWithTags When RowStruct is being modified, row data is stored serialized with tags
Public variable UProperty Category, Meta visibleanywhere TObjectPtr< UScriptStruct > RowStruct Structure to use for each row of the table, must inherit from FTableRowBase
Public variable UProperty FTopLevelAssetPath RowStructPathName The name of the RowStruct we were using when we were last saved
Protected variable UProperty Transient TSet< TObjectPtr< UObject > > TemporarilyReferencedObjects  
Public variable friend UGameplayTagTableManager  

Constructors

  Type Name Description
Public function  

UDataTable ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static void  
Public function Virtual void

AddRow ( FName RowName,
const uint8* RowData,
const UScriptStruct* RowType
)

  
Public function Virtual void

AddRow ( FName RowName,
const FTableRowBase& RowData
)

 Copies RowData into table.
Protected function Virtual void

AddRowInternal ( FName RowName,
uint8* RowDataPtr
)

 Called to add rows to the data table
Public function Virtual Const bool Returns true if it is valid to import multiple table rows with the same name; returns false otherwise
Public function Virtual void  
Public function bool

CopyImportOptions ( UDataTable* SourceTable
)

 Copies all the import options from another table, this does not copy row dawta
Public function TArray< FString >

CreateTableFromCSVString ( const FString& InString
)

 Create table from CSV style comma-separated string.
Public function TArray< FString >

CreateTableFromJSONString ( const FString& InString
)

 Create table from JSON style string. RowStruct must be defined before calling this function.
Public function TArray< FString > Create table from another Data Table
Public function TArray< FString >

CreateTableFromRawData ( TMap< FName, const uint8* >& DataMap,
UScriptStruct* InRowStruct
)

 Create table from a raw data map with a given script struct
Public function Virtual void Empty the table info (will not clear RowStruct)
Public function Const T *

FindRow ( FName RowName,
const FString& ContextString,
bool bWarnIfRowMissing
)

  
Public function Const T *

FindRow ( FName RowName,
const TCHAR* ContextString,
bool bWarnIfRowMissing
)

 Function to find the row of a table given its name.
Public function Const uint8 *

FindRowUnchecked ( FName RowName
)

 High performance version with no type safety
Public function Const FProperty *

FindTableProperty ( const FName& PropertyName
)

 Returns the column property where PropertyName matches the name of the column property.
Public function Const void

ForeachRow ( const FString& ContextString,
TFunctionRef< void(const FName&Key, const T&Value)> Predicate
)

  
Public function Const void

ForeachRow ( const TCHAR* ContextString,
TFunctionRef< void(const FName&Key, const T&Value)> Predicate
)

 Perform some operation for every row.
Public function Const void

GetAllRows ( const FString& ContextString,
OUTTArray< T* >& OutRowArray
)

  
Public function Const void

GetAllRows ( const TCHAR* ContextString,
OUTTArray< T* >& OutRowArray
)

 Get all of the rows in the table, regardless of name
Public function Const TArray< FString > Get an array of all the column titles, using the friendly display name from the property
Protected function Const UScriptStruct &  
Protected function Virtual TMap< FName, uint8 * > & TODO: remove this, it is temporarily here to allow DataTableEditorUtils to compile until I get around to updating functions like RemoveRow and RenameRow.
Public function Virtual Const const TMap< FName, uint8 * > &  
Public function Virtual const TMap< FName, uint8 * > &  
Public function Const TArray< FName >  
Public function Const const UScriptStruct *  
Public function Const FName  
Public function Const FTopLevelAssetPath  
Public function Const FString

GetTableAsCSV ( const EDataTableExportFlags InDTExportFlags
)

 Output entire contents of table as CSV
Public function Const FString

GetTableAsJSON ( const EDataTableExportFlags InDTExportFlags
)

 Output entire contents of table as JSON
Public function Const FString

GetTableAsString ( const EDataTableExportFlags InDTExportFlags
)

 Output entire contents of table as a string
Public function Const TArray< TArray< FString > >

GetTableData ( const EDataTableExportFlags InDTExportFlags
)

 Get array for each row in the table. The first row is the titles
Public function TArray< FProperty * >

GetTablePropertyArray ( const TArray< const TCHAR* >& Cells,
UStruct* RowStruct,
TArray< FString >& OutProblems,
int32 KeyColumn
)

 Get array of UProperties that corresponds to columns in the table
Public function Const TArray< FString > Get an array of all the column titles, using the unique name from the property
Public function void

HandleDataTableChanged ( FName ChangedRowName
)

 Call whenever the data of a table has changed, this calls the OnDataTableChanged() delegate and per-row callbacks.
Protected function void  
Public function FOnDataTableChanged & Gets a multicast delegate that is called any time the data table changes.
Protected function void

OnPostDataImported ( OUTTArray< FString >& OutCollectedImportProblems
)

 Called whenever new data is imported into the data table via CreateTableFrom*; Alerts each imported row and gives the row struct a chance to operate on the imported data
Public function Virtual void

RemoveRow ( FName RowName
)

 Removes a single row from the DataTable by name. Just returns if row is not found.
Protected function Virtual void

RemoveRowInternal ( FName RowName
)

 Deletes the row memory
Public function Virtual void  
Protected function void  
Public function Const bool

WriteRowAsJSON ( const TSharedRef< TJsonWriter< CharType, TPrettyJsonPrintPolicy< CharType > > >& JsonWriter,
const void* RowData,
const EDataTableExportFlags InDTExportFlags
)

 Output the fields from a particular row (use RowMap to get RowData) to an existing JsonWriter
Public function Const bool

WriteTableAsJSON ( const TSharedRef< TJsonWriter< CharType, TPrettyJsonPrintPolicy< CharType > > >& JsonWriter,
const EDataTableExportFlags InDTExportFlags
)

 Output entire contents of table as JSON
Public function Const bool

WriteTableAsJSONObject ( const TSharedRef< TJsonWriter< CharType, TPrettyJsonPrintPolicy< CharType > > >& JsonWriter,
const EDataTableExportFlags InDTExportFlags
)

 Output entire contents of table as a JSON Object

Overridden from UObject

  Type Name Description
Public function Virtual void Called to finish destroying the object.
Public function Virtual Const void

GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTags
)

  
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Public function Virtual void Called during cooking.
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
Public function Virtual Const EDataValidationResult Generic function to validate objects during changelist validations, etc.
Public function Virtual Const bool Called during saving to determine the load flags to save with the object.
Public function Virtual Const bool Called during saving to include this object in client/servers running in editor builds, even if they wouldn't normally be.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void  
Protected function Virtual Const void

ThreadedPostLoadAssetRegistryTagsOverride ( FPostLoadAssetRegistryTagsContext& Context
)

 Performs fixup on loaded asset registry data.

Classes

  Type Name Description
Protected struct FScopedDataTableChange Used to trigger the data table changed delegate.  

Typedefs

Name Description
FOnDataTableChanged  
FOnDataTableImport  

Deprecated Variables

  Type Name Description
Public variable UProperty FString ImportPath_DEPRECATED The filename imported to create this object.
Public variable UProperty FName RowStructName_DEPRECATED The name of the RowStruct we were using when we were last saved

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page