Skip to main content

EffectHost

Enum EffectHost 

Source
pub enum EffectHost {
    Battler(BattlerRef),
    Side(u8),
    Field,
}
Expand description

Where an effect is hosted (design §3.1, the broadened addressing). A cross-gen battle hosts effects not only on a battler (volatiles, ability, item) but on a side (screens, hazards, Wish) or the field (weather, terrain, Trick Room). EffectHost is the 3-way scope the engine routes by.

§Non-breaking note (design §3.1, §7)

The design’s §3.1 sketch proposed widening the EffectState.host field from BattlerRef to EffectHost “via From<BattlerRef> so existing constructors compile unchanged.” In Rust that does not hold for struct-literal field initialization (EffectState { host: who, .. } and the field-shorthand host,): field init requires the exact field type and never invokes From/Into. Widening the field would therefore force an edit to all 40+ Gen-1 slice construction sites — a NO-GO on the design’s own “Non-breaking” axis (§6.2). See the returned findings for the documented NO-GO.

So EffectHost ships as an additive type: EffectState.host stays BattlerRef (battler-hosted effects, the only kind the engine fires today — every slice compiles verbatim), and EffectState::host_scope projects it to EffectHost::Battler. Side- and field-hosted state is addressed through the EffectHost::Side/Field cases and the defaulted side_effects/ field_effects resolvers (the game owns that mutable state). From and PartialEq cross-impls let routing code treat a BattlerRef and an EffectHost::Battler interchangeably.

Variants§

§

Battler(BattlerRef)

Hosted on one battler (volatile, ability, item).

§

Side(u8)

Hosted on a side (screens, hazards, Wish). 0 = player, 1 = opponent.

§

Field

Hosted on the field (weather, terrain, Trick Room).

Trait Implementations§

Source§

impl Clone for EffectHost

Source§

fn clone(&self) -> EffectHost

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 EffectHost

Source§

impl Debug for EffectHost

Source§

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

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

impl Eq for EffectHost

Source§

impl From<BattlerRef> for EffectHost

Source§

fn from(r: BattlerRef) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for EffectHost

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 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 EffectHost

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.