Struct GroupFormation 

pub struct GroupFormation { /* private fields */ }

A single formation definition specifying how units should be arranged.

Each formation includes AI usage criteria, unit requirements, and a set of formation blocks that define where different unit types should be positioned.

Implementations

impl GroupFormation

pub fn name(&self) -> &String

Name identifier for this formation.

pub fn ai_priority(&self) -> &f32

AI priority value for selecting this formation (higher = more preferred).

pub fn ai_purpose(&self) -> &AIPurpose

Bitflags indicating when this formation should be used (attack, defend, naval, etc.).

pub fn uk_2(&self) -> &u32

Unknown field, present in Three Kingdoms.

pub fn min_unit_category_percentage(&self) -> &Vec<MinUnitCategoryPercentage>

Minimum percentage requirements for unit categories in this formation.

pub fn ai_supported_subcultures(&self) -> &Vec<String>

List of supported subcultures (introduced in Rome 2).

If non-empty, this formation is only available to armies from these subcultures.

pub fn ai_supported_factions(&self) -> &Vec<String>

List of supported factions (introduced in Rome 2).

If non-empty, this formation is only available to armies from these factions.

pub fn group_formation_blocks(&self) -> &Vec<GroupFormationBlock>

Formation blocks defining unit positions and arrangements.

impl GroupFormation

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

Name identifier for this formation.

pub fn ai_priority_mut(&mut self) -> &mut f32

AI priority value for selecting this formation (higher = more preferred).

pub fn ai_purpose_mut(&mut self) -> &mut AIPurpose

Bitflags indicating when this formation should be used (attack, defend, naval, etc.).

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

Unknown field, present in Three Kingdoms.

pub fn min_unit_category_percentage_mut( &mut self, ) -> &mut Vec<MinUnitCategoryPercentage>

Minimum percentage requirements for unit categories in this formation.

pub fn ai_supported_subcultures_mut(&mut self) -> &mut Vec<String>

List of supported subcultures (introduced in Rome 2).

If non-empty, this formation is only available to armies from these subcultures.

pub fn ai_supported_factions_mut(&mut self) -> &mut Vec<String>

List of supported factions (introduced in Rome 2).

If non-empty, this formation is only available to armies from these factions.

pub fn group_formation_blocks_mut(&mut self) -> &mut Vec<GroupFormationBlock>

Formation blocks defining unit positions and arrangements.

impl GroupFormation

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

Name identifier for this formation.

pub fn set_ai_priority(&mut self, val: f32) -> &mut Self

AI priority value for selecting this formation (higher = more preferred).

pub fn set_ai_purpose(&mut self, val: AIPurpose) -> &mut Self

Bitflags indicating when this formation should be used (attack, defend, naval, etc.).

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

Unknown field, present in Three Kingdoms.

pub fn set_min_unit_category_percentage( &mut self, val: Vec<MinUnitCategoryPercentage>, ) -> &mut Self

Minimum percentage requirements for unit categories in this formation.

pub fn set_ai_supported_subcultures(&mut self, val: Vec<String>) -> &mut Self

List of supported subcultures (introduced in Rome 2).

If non-empty, this formation is only available to armies from these subcultures.

pub fn set_ai_supported_factions(&mut self, val: Vec<String>) -> &mut Self

List of supported factions (introduced in Rome 2).

If non-empty, this formation is only available to armies from these factions.

pub fn set_group_formation_blocks( &mut self, val: Vec<GroupFormationBlock>, ) -> &mut Self

Formation blocks defining unit positions and arrangements.

Trait Implementations

impl Clone for GroupFormation

fn clone(&self) -> GroupFormation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupFormation

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

Formats the value using the given formatter.

impl Default for GroupFormation

fn default() -> GroupFormation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GroupFormation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GroupFormation

fn eq(&self, other: &GroupFormation) -> 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 GroupFormation

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 GroupFormation