unreal.DataTableFunctionLibrary

class unreal.DataTableFunctionLibrary(outer: Object | None = None, name: Name | str = 'None')

Bases: BlueprintFunctionLibrary

Data Table Function Library

C++ Source:

  • Module: Engine

  • File: DataTableFunctionLibrary.h

classmethod add_curve_table_key(curve_table, row_name, time, value) → bool

Adds a key to a row in a CurveTable

Parameters:

  • curve_table (CurveTable) – The Curve Table to modify.

  • row_name (Name) – The name of the row to modify.

  • time (float) – The time of the new key.

  • value (float) – The value of the new key.

Returns:

True if the operation was successful.

Return type:

bool

classmethod add_simple_curve_to_table(curve_table, row_name) → bool

Adds a simple curve to a curve table.

Parameters:

  • curve_table (CurveTable) – The Curve Table to modify

  • row_name (Name) – The name of the new row

Returns:

True if the operation was successful.

Return type:

bool

classmethod curve_table_to_json(curve_table) → str

Convert a curve table to JSON.

Parameters:

curve_table (CurveTable) – The Curve Table to export.

Returns:

The CurveTable contents encoded as a string.

Return type:

str

classmethod does_data_table_row_exist(table, row_name) → bool

Returns whether or not Table contains a row named RowName

Parameters:
Return type:

bool

classmethod evaluate_curve_table_row(curve_table, row_name, xy, context_string) -> (out_result=EvaluateCurveTableResult, out_xy=float)

Evaluate Curve Table Row

Parameters:
Returns:

out_result (EvaluateCurveTableResult):

out_xy (float):

Return type:

tuple

classmethod export_data_table_to_csv_file(data_table, csv_file_path) → bool

Export a Data Table to CSV file.

Parameters:

  • data_table (DataTable)

  • csv_file_path (str) – The file path of the CSV file to write (output file is UTF-8).

Returns:

True if the operation succeeds, check the log for errors if it didn’t succeed.

Return type:

bool

classmethod export_data_table_to_csv_string(data_table) → str or None

Export a Data Table to CSV string.

Parameters:

data_table (DataTable)

Returns:

True if the operation succeeds, check the log for errors if it didn’t succeed.

out_csv_string (str): Output representing the contents of a CSV file.

Return type:

str or None

classmethod export_data_table_to_json_file(data_table, json_file_path) → bool

Export a Data Table to JSON file.

Parameters:

  • data_table (DataTable)

  • json_file_path (str) – The file path of the JSON file to write (output file is UTF-8).

Returns:

True if the operation succeeds, check the log for errors if it didn’t succeed.

Return type:

bool

classmethod export_data_table_to_json_string(data_table) → str or None

Export a Data Table to JSON string.

Parameters:

data_table (DataTable)

Returns:

True if the operation succeeds, check the log for errors if it didn’t succeed.

out_json_string (str): Output representing the contents of a JSON file.

Return type:

str or None

classmethod fill_data_table_from_csv_file(data_table, csv_file_path, import_row_struct=None) → bool

Empty and fill a Data Table from CSV file.

Parameters:

  • data_table (DataTable)

  • csv_file_path (str) – The file path of the CSV file.

  • import_row_struct (ScriptStruct) – Optional row struct to apply on import. If set will also force the import to run automated (no questions or dialogs).

Returns:

True if the operation succeeds, check the log for errors if it didn’t succeed.

Return type:

bool

classmethod fill_data_table_from_csv_string(data_table, csv_string, import_row_struct=None) → bool

Empty and fill a Data Table from CSV string.

Parameters:

  • data_table (DataTable)

  • csv_string (str) – The Data that representing the contents of a CSV file.

  • import_row_struct (ScriptStruct) – Optional row struct to apply on import. If set will also force the import to run automated (no questions or dialogs).

Returns:

True if the operation succeeds, check the log for errors if it didn’t succeed.

Return type:

bool

classmethod fill_data_table_from_json_file(data_table, json_file_path, import_row_struct=None) → bool

Empty and fill a Data Table from JSON file.

Parameters:

  • data_table (DataTable)

  • json_file_path (str) – The file path of the JSON file.

  • import_row_struct (ScriptStruct) – Optional row struct to apply on import. If set will also force the import to run automated (no questions or dialogs).

Returns:

True if the operation succeeds, check the log for errors if it didn’t succeed.

Return type:

bool

classmethod fill_data_table_from_json_string(data_table, json_string, import_row_struct=None) → bool

Empty and fill a Data Table from JSON string.

Parameters:

  • data_table (DataTable)

  • json_string (str) – The Data that representing the contents of a JSON file.

  • import_row_struct (ScriptStruct) – Optional row struct to apply on import. If set will also force the import to run automated (no questions or dialogs).

Returns:

True if the operation succeeds, check the log for errors if it didn’t succeed.

Return type:

bool

classmethod get_curve_table_keys(curve_table, row_name) → Array[SimpleCurveKey]

Returns a list of keys in a row of a SimpleCurve table.

Parameters:

  • curve_table (CurveTable) – The Curve Table to query.

  • row_name (Name) – The name of the row to query.

Returns:

The list of keys in the curve, or empty if the curve doesn’t exist.

Return type:

Array[SimpleCurveKey]

classmethod get_curve_table_row_names(curve_table) → Array[Name]

Returns the names of the rows in the curve table.

Parameters:

curve_table (CurveTable) – The Curve Table to query

Returns:

A list of names of rows.

Return type:

Array[Name]

classmethod get_data_table_column_as_string(data_table, property_name) → Array[str]

Export from the DataTable all the row for one column. Export it as string. The row name is not included. see: GetDataTableColumnNames. see: GetDataTableColumnNameFromExportName.

Parameters:
Return type:

Array[str]

classmethod get_data_table_column_export_names(table) → Array[str]

Get the friendly export name of each column in this Data Table. see: GetDataTableColumnNameFromExportName.

Parameters:

table (DataTable)

Returns:

out_export_column_names (Array[str]):

Return type:

Array[str]

classmethod get_data_table_column_name_from_export_name(table, column_export_name) → Name or None

Get the raw property name of a data table column from its friendly export name.

Parameters:
Returns:

True if a column was found for the friendly name, false otherwise.

out_column_name (Name):

Return type:

Name or None

classmethod get_data_table_column_names(table) → Array[Name]

Get the name of each column in this Data Table. note: These are always the raw property names ( see: GetDataTableColumnAsString) rather than the friendly export name that would be used in a CSV/JSON export ( see: GetDataTableColumnNameFromExportName).

Parameters:

table (DataTable)

Returns:

out_column_names (Array[Name]):

Return type:

Array[Name]

classmethod get_data_table_row_names(table) → Array[Name]

Get Data Table Row Names

Parameters:

table (DataTable)

Returns:

out_row_names (Array[Name]):

Return type:

Array[Name]

classmethod get_data_table_row_struct(table) → ScriptStruct

Get the row struct used by the given Data Table, if any

Parameters:

table (DataTable)

Return type:

ScriptStruct

classmethod json_to_curve_table(curve_table, string) → Array[str]

Convert a curve table to JSON.

Parameters:
Return type:

Array[str]

classmethod remove_curve_table_row(curve_table, row_name) → bool

Removes a curve from a curve table.

Parameters:

  • curve_table (CurveTable) – The Curve Table to modify

  • row_name (Name) – The name of the row to remove

Returns:

True if the operation was successful.

Return type:

bool

classmethod remove_data_table_row(data_table, row_name) → None

Removes the row with the provided name from a Data Table.

Parameters:
classmethod rename_curve_table_row(curve_table, row_name, new_row_name) → bool

Renames a curve table row.

Parameters:

  • curve_table (CurveTable) – The Curve Table to modify

  • row_name (Name) – The name of the row to rename

  • new_row_name (Name) – The new name of the row

Returns:

True if the operation was successful.

Return type:

bool

classmethod set_curve_table_row_default(curve_table, row_name, default_value) → bool

Adds a simple curve to a curve table.

Parameters:

  • curve_table (CurveTable) – The Curve Table to modify

  • row_name (Name) – The name of the row to modify

  • default_value (float) – The default value of the row.

Returns:

True if the operation was successful.

Return type:

bool