Struct RawDefinition 

pub struct RawDefinition {
    pub name: Option<String>,
    pub fields: Vec<RawField>,
}

Raw table definition parsed from Assembly Kit schema files.

This is the raw equivalent to RPFM’s Definition struct. In Assembly Kit files, this corresponds to a TWaD_*.xml file (versions 1-2) or .xsd file (version 0).

Fields

• name - Table name with .xml extension (e.g., "units_tables.xml")
• fields - All field definitions for this table

Example Structure

A TWaD_units_tables.xml file contains field definitions like:

<root>
  <field primary_key="1" name="key" field_type="text" required="1"/>
  <field primary_key="0" name="category" field_type="text" required="0"
         column_source_table="unit_categories_tables"
         column_source_column="key"/>
</root>

Fields

name: Option<String>

Table name with .xml extension (e.g., "units_tables.xml") and without the ‘TWaD_’ prefix.

fields: Vec<RawField>

All the field definitions within this table definition.

Implementations

impl RawDefinition

Implementation of RawDefinition.

pub fn read_all( raw_definitions_folder: &Path, version: i16, tables_to_skip: &[&str], ) -> Result<Vec<Self>>

Reads all table definitions from an Assembly Kit directory.

This function scans the provided directory for Assembly Kit definition files and parses them into RawDefinition structs. The parsing logic varies significantly by version.

Version-Specific Behavior

Version 1 & 2 (Shogun 2, Rome 2+)

• Reads TWaD_*.xml files directly
• Each file is a complete, self-contained definition

Version 0 (Empire, Napoleon)

• Reads .xsd XML Schema files
• Uses two-pass processing:
  1. Parse all XSD files and extract field info + primary keys
  2. Analyze index definitions to derive foreign key relationships
• This is necessary because Version 0 uses database-style indexes rather than explicit foreign key declarations

Arguments

• raw_definitions_folder - Directory containing Assembly Kit definition files
• version - Assembly Kit version (0 = Empire/Napoleon, 1 = Shogun 2, 2 = Rome 2+)
• tables_to_skip - Table names (without extension) to exclude from parsing

Returns

Returns a vector of successfully parsed table definitions. Tables in the blacklist or skip list are excluded.

Errors

Returns an error if:

• The version is unsupported (not 0, 1, or 2)
• The directory cannot be read
• Any definition file has malformed XML

pub fn read(raw_definition_path: &Path, version: i16) -> Result<Self>

Parses a single Assembly Kit definition file.

Reads and parses one table definition file from the Assembly Kit.

Arguments

• raw_definition_path - Path to the definition file (e.g., TWaD_units_tables.xml)
• version - Assembly Kit version (1 = Shogun 2, 2 = Rome 2+)

Returns

Returns the parsed RawDefinition with the table name set to the filename without the TWaD_ prefix (e.g., "units_tables.xml").

Errors

Returns an error if:

• The version is not 1 or 2 (use RawDefinitionV0::read() for version 0)
• The file cannot be opened (returns RLibError::AssemblyKitNotFound)
• The XML is malformed

Note

For Version 0 (Empire/Napoleon), use RawDefinitionV0::read() instead as the file format is completely different (.xsd vs .xml).

pub fn get_non_localisable_fields( &self, raw_localisable_fields: &[RawLocalisableField], test_row: &RawTableRow, ) -> Vec<Field>

Filters out localisable fields from the definition.

Returns only the fields that are not marked as localisable (translatable) and are present in the test row data. This is used when processing Assembly Kit table data to separate regular fields from translation fields.

Arguments

• raw_localisable_fields - List of all localisable fields from TExc_LocalisableFields.xml
• test_row - Sample row data used to verify field presence

Returns

Returns a vector of Field instances for non-localisable fields that exist in the test data.

Note

Fields are excluded if:

• They’re listed in raw_localisable_fields for this table
• They don’t appear in the test row
• They have a “state” attribute (marked as modified/deprecated)

Trait Implementations

impl Clone for RawDefinition

fn clone(&self) -> RawDefinition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RawDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RawDefinition

fn default() -> RawDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RawDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&RawDefinition> for Definition

fn from(raw_definition: &RawDefinition) -> Self

Converts to this type from the input type.

impl From<&RawDefinitionV0> for RawDefinition

Old games don’t use references, but rather indexes like a database. This means we’re unable to find the referenced column without having the reference definition. So ref data needs to be calculated after this.

fn from(value: &RawDefinitionV0) -> Self

Converts to this type from the input type.