Struct weasel::space::AlterSpace

pub struct AlterSpace<R: BattleRules> { /* fields omitted */ }

Event to alter the space model.

Alterations to the space model might have consequences on entities or on other aspects of the battle, as defined in alter_space.

Examples

use weasel::{
    battle_rules, rules::empty::*, AlterSpace, Battle, BattleController, BattleRules,
    EventKind, EventTrigger, Server,
};

battle_rules! {}

let battle = Battle::builder(CustomRules::new()).build();
let mut server = Server::builder(battle).build();

let alteration = ();
AlterSpace::trigger(&mut server, alteration).fire().unwrap();
assert_eq!(
    server.battle().history().events()[0].kind(),
    EventKind::AlterSpace
);

Implementations

impl<R: BattleRules> AlterSpace<R>

pub fn trigger<P: EventProcessor<R>>(
    processor: &mut P,
    alteration: SpaceAlteration<R>
) -> AlterSpaceTrigger<'_, R, P>

Returns a trigger for this event.

pub fn alteration(&self) -> &SpaceAlteration<R>

Returns the alteration to be applied to the space model.

Trait Implementations

impl<R: BattleRules> Clone for AlterSpace<R>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: BattleRules> Debug for AlterSpace<R>

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

Formats the value using the given formatter.

impl<'de, R: BattleRules> Deserialize<'de> for AlterSpace<R> where
    SpaceAlteration<R>: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<R: BattleRules + 'static> Event<R> for AlterSpace<R>

fn verify(&self, _battle: &Battle<R>) -> WeaselResult<(), R>

Verifies if this event can be applied to the world.

fn apply(&self, battle: &mut Battle<R>, event_queue: &mut Option<EventQueue<R>>)

Applies this event to the world. This method is called only if verify succeeded.

fn kind(&self) -> EventKind

Returns the kind of this event.

fn box_clone(&self) -> Box<dyn Event<R> + Send>

Clones this event as a trait object.

fn as_any(&self) -> &dyn Any

Returns an Any reference this event.

fn rights<'a>(&'a self, _battle: &'a Battle<R>) -> EventRights<'a, R>

Returns the access rights required by this event.

impl<R: BattleRules> Serialize for AlterSpace<R> where
    SpaceAlteration<R>: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.