Function Name | Description | |
---|---|---|
get_data_table_struct_path | Get the row struct's path of the given DataTable. | |
get_data_table_struct | Get the row struct of the given DataTable. | |
get_table_as_json | Get the datatable content as JSON | |
get_row_names | Get the Row names of the given datatable. | |
get_column_names | Get the Column names of the given datatable. | |
get_shape | Get the Shape of the given datatable. The title and the row names are not included. | |
remove_row | Remove the specified row of the given datatable | |
add_row | Add a row in the given datatable | |
duplicate_row | Duplicate a row in the given datatable | |
rename_row | Rename the specified row in the given datatable | |
reset_row | Reset the specified row in the given datatable to default values. | |
move_row | Reset the specified row in the given datatable to default values. | |
get_row_name | Gets the Row name of the specified row in datatable | |
get_column_name | Gets the Column name of the specified column in datatable | |
get_flatten_data_table | Get the content of datatable as a 1D string List. | |
get_property_as_string | Get the specified cell's value as string in datatable | |
get_property_as_string_at | Get the specified cell's value as string in datatable | |
set_property_by_string | Set the specified cell's property in datatable | |
set_property_by_string_at | Set the specified cell's property in datatable |
get_data_table_struct_path¶
Get the row struct's path of the given DataTable.
unreal.PythonDataTableLib.get_data_table_struct_path(data_table) -> str
Get the row struct's path of the given DataTable.
Args:
data_table (DataTable): The DataTable for query.
Returns:
str: The package path of struct, empty string if failed.
get_data_table_struct¶
Get the row struct of the given DataTable.
unreal.PythonDataTableLib.get_data_table_struct(data_table) -> ScriptStruct
Get the row struct of the given DataTable.
Args:
data_table (DataTable): The DataTable for query.
Returns:
ScriptStruct: The row struct of the datatable.
get_table_as_json¶
Get the datatable content as JSON
unreal.PythonDataTableLib.get_table_as_json(data_table) -> str
Get the datatable content as JSON
Args:
data_table (DataTable): The DataTable you want to query.
Returns:
str: The datatable content as JSON
get_row_names¶
Get the Row names of the given datatable.
unreal.PythonDataTableLib.get_row_names(data_table) -> Array[Name]
Get the Row names of the given datatable.
Args:
data_table (DataTable): The DataTable you want to query.
Returns:
Array[Name]: The row names list.
get_column_names¶
Get the Column names of the given datatable.
unreal.PythonDataTableLib.get_column_names(data_table, friendly_name=True, include_name=False) -> Array[Name]
Get the Column names of the given datatable.
Args:
data_table (DataTable): The DataTable you want to query.
friendly_name (bool): Get the Friendly Name or Raw Name.
include_name (bool): Include the Row Name Column or not.
Returns:
Array[Name]: The Column names list.
get_shape¶
Get the Shape of the given datatable. The title and the row names are not included.
unreal.PythonDataTableLib.get_shape(data_table) -> Array[int32]
Get the Shape of the given datatable. The title and the row names are not included.
Args:
data_table (DataTable): The DataTable you want to query.
Returns:
Array[int32]: return the row number and column number of the datatable: [RowNumber, ColumnNumber]
remove_row¶
Remove the specified row of the given datatable
unreal.PythonDataTableLib.remove_row(data_table, row_name) -> bool
Remove the specified row of the given datatable
Args:
data_table (DataTable): The DataTable you want to modify.
row_name (Name): The Row Name
Returns:
bool: True if the row has been removed
add_row¶
Add a row in the given datatable
unreal.PythonDataTableLib.add_row(data_table, row_name) -> bool
Add a row in the given datatable
Args:
data_table (DataTable): The DataTable you want to modify.
row_name (Name): The Row Name of new line
Returns:
bool: True if the row has been added
duplicate_row¶
Duplicate a row in the given datatable
unreal.PythonDataTableLib.duplicate_row(data_table, source_row_name, row_name) -> bool
Duplicate a row in the given datatable
Args:
data_table (DataTable): The DataTable you want to modify.
source_row_name (Name): The Row Name of the source Row
row_name (Name): The Row Name of new line
Returns:
bool: True if the row has been duplicated
rename_row¶
Rename the specified row in the given datatable
unreal.PythonDataTableLib.rename_row(data_table, old_name, new_name) -> bool
Rename the specified row in the given datatable
Args:
data_table (DataTable): The DataTable you want to modify.
old_name (Name): The old Row Name
new_name (Name): The new Row Name
Returns:
bool: True if the row has been renamed
reset_row¶
Reset the specified row in the given datatable to default values.
unreal.PythonDataTableLib.reset_row(data_table, row_name) -> bool
Reset the specified row in the given datatable to default values.
Args:
data_table (DataTable): The DataTable you want to modify.
row_name (Name): The Row Name
Returns:
bool: True if the row has been reset
move_row¶
Reset the specified row in the given datatable to default values.
unreal.PythonDataTableLib.move_row(data_table, row_name, up, num_rows_to_move_by=1) -> bool
Reset the specified row in the given datatable to default values.
Args:
data_table (DataTable): The DataTable you want to modify.
row_name (Name): The Row Name of the 'source row'
up (bool): Move up or not
num_rows_to_move_by (int32): Number of rows to move by.
Returns:
bool: True if the row has been moved
get_row_name¶
Gets the Row name of the specified row in datatable
unreal.PythonDataTableLib.get_row_name(data_table, row_id) -> Name
Gets the Row name of the specified row in datatable
Args:
data_table (DataTable): The DataTable you want to modify.
row_id (int32): The index of the row
Returns:
Name: The Row name
get_column_name¶
Gets the Column name of the specified column in datatable
unreal.PythonDataTableLib.get_column_name(data_table, column_id, friendly_name=True) -> Name
Gets the Column name of the specified column in datatable
Args:
data_table (DataTable): The DataTable you want to modify
column_id (int32): The index of the column
friendly_name (bool): Whether get the friendly name or raw name or not
Returns:
Name: The Row name
get_flatten_data_table¶
Get the content of datatable as a 1D string List.
unreal.PythonDataTableLib.get_flatten_data_table(data_table, include_header=False) -> Array[str]
Get the content of datatable as a 1D string List.
note: The length of return value will equal RowNumber * ColumnNumber, when bIncludeHeader set to false
Args:
data_table (DataTable): The DataTable you want to modify
include_header (bool): Whether include the title and row name column.
Returns:
Array[str]: The content in 1D string List
get_property_as_string¶
Get the specified cell's value as string in datatable
unreal.PythonDataTableLib.get_property_as_string(data_table, row_name, column_name) -> str
Get the specified cell's value as string in datatable
Args:
data_table (DataTable): The DataTable you want to query.
row_name (Name): The Row name of the cell.
column_name (Name): The Column name of the cell.
Returns:
str: The property of the cell as string.
get_property_as_string_at¶
Get the specified cell's value as string in datatable
unreal.PythonDataTableLib.get_property_as_string_at(data_table, row_id, column_id) -> str
Get the specified cell's value as string in datatable
Args:
data_table (DataTable): The DataTable you want to query.
row_id (int32): The Row index of the cell. The title is not include
column_id (int32): The Column index of the cell. The title is not include
Returns:
str: The property of the cell as string.
set_property_by_string¶
Set the specified cell's property in datatable
unreal.PythonDataTableLib.set_property_by_string(data_table, row_name, column_name, value_as_string) -> bool
Set the specified cell's property in datatable
Args:
data_table (DataTable): The DataTable you want to query.
row_name (Name): The Row name of the cell.
column_name (Name): The Column name of the cell.
value_as_string (str): The new property in string format.
Returns:
bool: True if the new property has been set
set_property_by_string_at¶
Set the specified cell's property in datatable
unreal.PythonDataTableLib.set_property_by_string_at(data_table, row_index, column_index, value_as_string) -> bool
Set the specified cell's property in datatable
Args:
data_table (DataTable): The DataTable you want to query.
row_index (int32): The Row index of the cell. The title is not include
column_index (int32): The Column index of the cell. The title is not include
value_as_string (str): The new property in string format.
Returns:
bool: True if the new property has been set
Other Editor Python Libs: