Enum GroupFormationsFormat

Source

pub enum GroupFormationsFormat {
    Shogun2,
    Rome2,
    Troy,
    Warhammer3,
}

Expand description

Binary layout of a Group Formations file, which depends on the game it belongs to.

Variants§

§

Shogun2

Shogun 2.

§

Rome2

Rome 2, Attila and Thrones of Britannia.

§

Troy

Troy and Pharaoh.

§

Warhammer3

Three Kingdoms and Warhammer 3.

Implementations§

Source §

impl GroupFormationsFormat

Source

pub fn from_game(game_info: &GameInfo) -> Result<Self>

Returns the format used by the provided game.

§Arguments

game_info - The game the file belongs to.

§Returns

The format of the game’s Group Formations file.

§Errors

Returns an error if the game doesn’t support Group Formations files.

Source

pub fn has_ai_supported_factions(&self) -> bool

Returns if formations in this format have a list of supported factions.

Source

pub fn has_ai_supported_subcultures(&self) -> bool

Returns if formations in this format have a list of supported subcultures.

Source

pub fn has_formation_uk_2(&self) -> bool

Returns if formations in this format have the uk_2 field.

Source

pub fn has_entity_weight(&self) -> bool

Returns if entity preferences in this format have an entity weight.

Source

pub fn has_entity_class(&self) -> bool

Returns if entity preferences in this format have the uk_1 and entity_class fields.

Source

pub fn default_ai_purpose(&self) -> AIPurpose

Returns an empty set of AI purpose flags of the version used by this format.

Source

pub fn entities(&self) -> Vec<Entity>

Returns all the entity types of the version used by this format.

Source

pub fn default_entity(&self) -> Entity

Returns the default entity type of the version used by this format.

Trait Implementations§

Source §

impl Clone for GroupFormationsFormat

Source §

fn clone(&self) -> GroupFormationsFormat

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Copy for GroupFormationsFormat

Source §

impl Debug for GroupFormationsFormat

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Eq for GroupFormationsFormat

Source §

impl PartialEq for GroupFormationsFormat

Source §

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Source §

impl StructuralPartialEq for GroupFormationsFormat

Auto Trait Implementations§

§

impl UnwindSafe for GroupFormationsFormat

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§