Skip to main content

Party

Struct Party 

Source
pub struct Party<P: MonsterProvider> { /* private fields */ }
Expand description

An ordered party of monsters with a provider/param-defined capacity.

Implementations§

Source§

impl<P: MonsterProvider> Party<P>

Source

pub fn new(capacity: usize) -> Self

Create an empty party with the given capacity (supplied by the game, not hardcoded).

Source

pub fn capacity(&self) -> usize

The capacity this party was created with.

Source

pub fn len(&self) -> usize

Number of monsters currently in the party.

Source

pub fn is_empty(&self) -> bool

Whether the party has no members.

Source

pub fn is_full(&self) -> bool

Whether the party is at capacity.

Source

pub fn add(&mut self, m: MonsterInstance<P>) -> Result<(), PartyFull<P>>

Append a monster. Returns PartyFull (carrying the monster back) if the party is already full.

Source

pub fn remove(&mut self, index: usize) -> Option<MonsterInstance<P>>

Remove and return the monster at index, shifting later members down.

Source

pub fn swap(&mut self, a: usize, b: usize)

Swap the monsters at indices a and b. Out-of-range indices are ignored.

Source

pub fn get(&self, index: usize) -> Option<&MonsterInstance<P>>

Borrow the monster at index.

Source

pub fn get_mut(&mut self, index: usize) -> Option<&mut MonsterInstance<P>>

Mutably borrow the monster at index.

Source

pub fn first_able(&self) -> Option<usize>

Index of the first non-fainted member (lead selection), if any.

Source

pub fn all_fainted(&self) -> bool

Whether every member has fainted (battle loss / whiteout). A party with no members counts as all-fainted.

Source

pub fn iter(&self) -> impl Iterator<Item = &MonsterInstance<P>>

Iterate over the party members in order.

Source

pub fn iter_mut(&mut self) -> impl Iterator<Item = &mut MonsterInstance<P>>

Mutably iterate over the party members in order.

Trait Implementations§

Source§

impl<P: Clone + MonsterProvider> Clone for Party<P>

Source§

fn clone(&self) -> Party<P>

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<P: Debug + MonsterProvider> Debug for Party<P>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<P: Eq + MonsterProvider> Eq for Party<P>

Source§

impl<P: PartialEq + MonsterProvider> PartialEq for Party<P>

Source§

fn eq(&self, other: &Party<P>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<P: PartialEq + MonsterProvider> StructuralPartialEq for Party<P>

Auto Trait Implementations§

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
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<U> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.