Struct weasel::ability::ActivateAbility

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

Event to make an actor activate an ability.

Examples

use weasel::{
    battle_rules, rules::empty::*, ActivateAbility, Battle, BattleRules, CreateCreature,
    CreateTeam, EntityId, EventTrigger, Server, StartRound,
};

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();
StartRound::trigger(&mut server, EntityId::Creature(creature_id))
    .fire()
    .unwrap();

let ability_id = 99;
let result =
    ActivateAbility::trigger(&mut server, EntityId::Creature(creature_id), ability_id)
        .fire();
// We get an error because the creature doesn't know this ability.
// The set of abilities known by creatures must defined in 'ActorRules'.
assert!(result.is_err());

Implementations

impl<R: BattleRules> ActivateAbility<R>

pub fn trigger<P: EventProcessor<R>>(
    processor: &mut P,
    entity_id: EntityId<R>,
    ability_id: AbilityId<R>
) -> ActivateAbilityTrigger<R, P>

Returns a trigger for this event.

pub fn entity_id(&self) -> &EntityId<R>

Returns the id of the actor who is activating the ability.

pub fn ability_id(&self) -> &AbilityId<R>

Returns the id of the ability to be activated.

pub fn activation(&self) -> &Option<Activation<R>>

Returns the activation profile for the ability.

Trait Implementations

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

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

Formats the value using the given formatter.

impl<'de, R: BattleRules> Deserialize<'de> for ActivateAbility<R> where
    EntityId<R>: Deserialize<'de>,
    AbilityId<R>: Deserialize<'de>,
    Option<Activation<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 ActivateAbility<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 ActivateAbility<R> where
    EntityId<R>: Serialize,
    AbilityId<R>: Serialize,
    Option<Activation<R>>: Serialize, 

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

Serialize this value into the given Serde serializer.