Struct AnimFragmentBattle 

pub struct AnimFragmentBattle { /* private fields */ }

Represents a battle animation fragment file.

Contains animation entries and metadata for a specific skeleton type. The structure varies by game version, with newer games supporting more features.

Version Differences

• Version 2 (Warhammer 2/Troy/Pharaoh): Basic structure with min/max IDs
• Version 2 (Three Kingdoms): Adds mount tables and locomotion graph support
• Version 4 (Warhammer 3): Enhanced with subversion and cavalry tech flags

Implementations

impl AnimFragmentBattle

pub fn version(&self) -> &u32

File format version (2 or 4).

pub fn entries(&self) -> &Vec<Entry>

List of animation entries in this fragment.

pub fn skeleton_name(&self) -> &String

Name of the skeleton this animation fragment applies to.

pub fn subversion(&self) -> &u32

Format subversion (version 4 only).

pub fn table_name(&self) -> &String

Name of the animation table.

pub fn mount_table_name(&self) -> &String

Name of the mount animation table.

pub fn unmount_table_name(&self) -> &String

Name of the unmount animation table.

pub fn locomotion_graph(&self) -> &String

Locomotion graph identifier.

pub fn is_simple_flight(&self) -> &bool

Whether this uses simple flight mechanics.

pub fn is_new_cavalry_tech(&self) -> &bool

Whether this uses new cavalry technology.

pub fn min_id(&self) -> &u32

Minimum animation ID in this fragment (version 2 only).

pub fn max_id(&self) -> &u32

Maximum animation ID in this fragment (version 2 only).

impl AnimFragmentBattle

pub fn version_mut(&mut self) -> &mut u32

File format version (2 or 4).

pub fn entries_mut(&mut self) -> &mut Vec<Entry>

List of animation entries in this fragment.

pub fn skeleton_name_mut(&mut self) -> &mut String

Name of the skeleton this animation fragment applies to.

pub fn subversion_mut(&mut self) -> &mut u32

Format subversion (version 4 only).

pub fn table_name_mut(&mut self) -> &mut String

Name of the animation table.

pub fn mount_table_name_mut(&mut self) -> &mut String

Name of the mount animation table.

pub fn unmount_table_name_mut(&mut self) -> &mut String

Name of the unmount animation table.

pub fn locomotion_graph_mut(&mut self) -> &mut String

Locomotion graph identifier.

pub fn is_simple_flight_mut(&mut self) -> &mut bool

Whether this uses simple flight mechanics.

pub fn is_new_cavalry_tech_mut(&mut self) -> &mut bool

Whether this uses new cavalry technology.

pub fn min_id_mut(&mut self) -> &mut u32

Minimum animation ID in this fragment (version 2 only).

pub fn max_id_mut(&mut self) -> &mut u32

Maximum animation ID in this fragment (version 2 only).

impl AnimFragmentBattle

pub fn set_version(&mut self, val: u32) -> &mut Self

File format version (2 or 4).

pub fn set_entries(&mut self, val: Vec<Entry>) -> &mut Self

List of animation entries in this fragment.

pub fn set_skeleton_name(&mut self, val: String) -> &mut Self

Name of the skeleton this animation fragment applies to.

pub fn set_subversion(&mut self, val: u32) -> &mut Self

Format subversion (version 4 only).

pub fn set_table_name(&mut self, val: String) -> &mut Self

Name of the animation table.

pub fn set_mount_table_name(&mut self, val: String) -> &mut Self

Name of the mount animation table.

pub fn set_unmount_table_name(&mut self, val: String) -> &mut Self

Name of the unmount animation table.

pub fn set_locomotion_graph(&mut self, val: String) -> &mut Self

Locomotion graph identifier.

pub fn set_is_simple_flight(&mut self, val: bool) -> &mut Self

Whether this uses simple flight mechanics.

pub fn set_is_new_cavalry_tech(&mut self, val: bool) -> &mut Self

Whether this uses new cavalry technology.

pub fn set_min_id(&mut self, val: u32) -> &mut Self

Minimum animation ID in this fragment (version 2 only).

pub fn set_max_id(&mut self, val: u32) -> &mut Self

Maximum animation ID in this fragment (version 2 only).

impl AnimFragmentBattle

pub fn definitions() -> (Definition, Definition)

Returns table schema definitions for animation fragments.

Provides two Definitions:

1. Main entry definition with all animation entry fields
2. Animation reference sub-definition (for version 4 anim_refs field)

These definitions are used when converting animation fragments to/from TableInMemory for TSV export/import.

Returns

A tuple of (entry_definition, anim_ref_definition).

pub fn from_table(table: &TableInMemory) -> Result<Vec<Entry>>

Converts a table to a list of animation entries.

Parses a TableInMemory (typically loaded from TSV) and extracts animation entry data.

Parameters

• table: The table containing animation entry data

Returns

A vector of Entry structs parsed from the table rows.

Errors

Returns an error if the table structure doesn’t match the expected schema or if data conversion fails.

pub fn to_table(&self) -> Result<TableInMemory>

Converts this animation fragment to a table.

Creates a TableInMemory from the animation entries, which can then be exported as TSV for editing.

Returns

A table containing all animation entries with the appropriate schema.

Errors

Returns an error if table construction or data conversion fails.

Trait Implementations

impl Clone for AnimFragmentBattle

fn clone(&self) -> AnimFragmentBattle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnimFragmentBattle

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

Formats the value using the given formatter.

impl Decodeable for AnimFragmentBattle

fn decode<R: ReadBytes>( data: &mut R, extra_data: &Option<DecodeableExtraData<'_>>, ) -> Result<Self>

Decodes binary data into the implementing type.

impl Default for AnimFragmentBattle

fn default() -> AnimFragmentBattle

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AnimFragmentBattle

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodeable for AnimFragmentBattle

fn encode<W: WriteBytes>( &mut self, buffer: &mut W, extra_data: &Option<EncodeableExtraData<'_>>, ) -> Result<()>

Encodes the implementing type into binary data.

impl PartialEq for AnimFragmentBattle

fn eq(&self, other: &AnimFragmentBattle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AnimFragmentBattle

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AnimFragmentBattle