Struct EntityPreference 

pub struct EntityPreference { /* private fields */ }

Defines a preference for a specific type of unit to occupy a formation block.

Multiple preferences can be defined in priority order, so the AI will try to place the highest priority matching units first.

Implementations

impl EntityPreference

pub fn priority(&self) -> &f32

Priority for this entity type (higher = more preferred).

pub fn entity(&self) -> &Entity

The type of unit entity (infantry, cavalry, artillery, etc.).

Note: This is called EntityClass in Rome 2 and EntityDescription in Shogun 2, but represents the same concept.

pub fn entity_weight(&self) -> &EntityWeight

Weight class of the unit (light, medium, heavy, etc.). Introduced in Rome 2.

pub fn uk_1(&self) -> &u32

Unknown fields present in Three Kingdoms.

pub fn uk_2(&self) -> &u32

Unknown field present in Three Kingdoms.

pub fn uk_3(&self) -> &u32

Unknown field present in Three Kingdoms.

pub fn entity_class(&self) -> &String

Entity class string identifier (used in Three Kingdoms).

impl EntityPreference

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

Priority for this entity type (higher = more preferred).

pub fn entity_mut(&mut self) -> &mut Entity

The type of unit entity (infantry, cavalry, artillery, etc.).

Note: This is called EntityClass in Rome 2 and EntityDescription in Shogun 2, but represents the same concept.

pub fn entity_weight_mut(&mut self) -> &mut EntityWeight

Weight class of the unit (light, medium, heavy, etc.). Introduced in Rome 2.

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

Unknown fields present in Three Kingdoms.

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

Unknown field present in Three Kingdoms.

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

Unknown field present in Three Kingdoms.

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

Entity class string identifier (used in Three Kingdoms).

impl EntityPreference

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

Priority for this entity type (higher = more preferred).

pub fn set_entity(&mut self, val: Entity) -> &mut Self

The type of unit entity (infantry, cavalry, artillery, etc.).

Note: This is called EntityClass in Rome 2 and EntityDescription in Shogun 2, but represents the same concept.

pub fn set_entity_weight(&mut self, val: EntityWeight) -> &mut Self

Weight class of the unit (light, medium, heavy, etc.). Introduced in Rome 2.

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

Unknown fields present in Three Kingdoms.

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

Unknown field present in Three Kingdoms.

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

Unknown field present in Three Kingdoms.

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

Entity class string identifier (used in Three Kingdoms).

Trait Implementations

impl Clone for EntityPreference

fn clone(&self) -> EntityPreference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityPreference

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

Formats the value using the given formatter.

impl Default for EntityPreference

fn default() -> EntityPreference

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EntityPreference

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for EntityPreference

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

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 EntityPreference