Struct weasel::object::RemoveObject

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

Event to remove an object from the battle.

The position occupied by the object will be freed.

Examples

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

battle_rules! {}

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

let object_id = 1;
let position = ();
CreateObject::trigger(&mut server, object_id, position)
    .fire()
    .unwrap();

RemoveObject::trigger(&mut server, object_id).fire().unwrap();
assert_eq!(server.battle().entities().objects().count(), 0);

Implementations

impl<R: BattleRules> RemoveObject<R>

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

Returns a trigger for this event.

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

Returns the id of the object to be removed.

Trait Implementations

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

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

Formats the value using the given formatter.

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

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

Serialize this value into the given Serde serializer.