Skip to main content

BattlerRef

Struct BattlerRef 

Source
pub struct BattlerRef {
    pub side: u8,
    pub slot: u8,
}
Expand description

A reference to one battler position on the battlefield.

In a 1v1 Gen-1-style battle slot is always 0; the field is present so the same type serves multi-slot formats. side is 0 for the player and 1 for the opponent, matching BattleState::player_battlers / opponent_battlers.

Fields§

§side: u8

0 = player side, 1 = opponent side.

§slot: u8

Slot within the side (0-based). 0 for 1v1.

Implementations§

Source§

impl BattlerRef

Source

pub const PLAYER: Self

The player’s lead battler (side 0, slot 0).

Source

pub const OPPONENT: Self

The opponent’s lead battler (side 1, slot 0).

Source

pub const fn new(side: u8, slot: u8) -> Self

Construct a battler reference.

Trait Implementations§

Source§

impl Clone for BattlerRef

Source§

fn clone(&self) -> BattlerRef

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 BattlerRef

Source§

impl Debug for BattlerRef

Source§

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

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

impl Eq for BattlerRef

Source§

impl From<BattlerRef> for EffectHost

Source§

fn from(r: BattlerRef) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for BattlerRef

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl PartialEq<BattlerRef> for EffectHost

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl PartialEq<EffectHost> for BattlerRef

Source§

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

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.