Struct weasel::creature::RemoveCreature

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

Event to remove a creature from the battle.

If the creature is the current actor, its turn will be terminated.
The creature will be removed from the corresponding team and its position will be freed.

Examples

use weasel::{
    battle_rules, rules::empty::*, Battle, BattleController, BattleRules, CreateCreature,
    CreateTeam, EventTrigger, RemoveCreature, Server,
};

battle_rules! {}

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

let team_id = 1;
CreateTeam::trigger(&mut server, team_id).fire().unwrap();
let creature_id = 1;
let position = ();
CreateCreature::trigger(&mut server, creature_id, team_id, position)
    .fire()
    .unwrap();

RemoveCreature::trigger(&mut server, creature_id).fire().unwrap();
assert_eq!(server.battle().entities().creatures().count(), 0);

Implementations

impl<R: BattleRules> RemoveCreature<R>

pub fn trigger<P: EventProcessor<R>>(
    processor: &mut P,
    id: CreatureId<R>
) -> RemoveCreatureTrigger<'_, R, P>

Returns a trigger for this event.

pub fn id(&self) -> &CreatureId<R>

Returns the id of the creature to be removed.

Trait Implementations

impl<R: BattleRules> Clone for RemoveCreature<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 RemoveCreature<R>

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

Formats the value using the given formatter.

impl<'de, R: BattleRules> Deserialize<'de> for RemoveCreature<R> where
    CreatureId<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 RemoveCreature<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 RemoveCreature<R> where
    CreatureId<R>: Serialize, 

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

Serialize this value into the given Serde serializer.