Struct evtclib::event::Event

pub struct Event { /* private fields */ }

A higher-level representation of a combat event.

Events can be many things, from damage events to general status messages (e.g. there’s EventKind::MapId to give information about the current map). The main way to use events is to match on the EventKind stored in .kind and then decide how to proceed. Note that all Events have certain fields that are always present, but they might not always be useful or contain sensible information. This is just an artifact of how arcdps saves the events.

The main way to deal with events is to iterate/use the .events() provided by a parsed Log. However, if you end up working with raw events (CbtEvent), then you can convert them to a “high-level” event using the standard TryFrom/TryInto mechanisms:

use std::convert::TryInto;
let raw_event: raw::CbtEvent = panic!();
let event: Event = raw_event.try_into().unwrap();

Note that if you plan on re-using the raw event afterwards, you should use the implementation that works on a reference instead: Event::try_from(&raw_event).

Implementations

impl Event

pub fn time(&self) -> u64

The time when the event happened.

This are the milliseconds since Windows has been started (timeGetTime()).

pub fn is_ninety(&self) -> bool

Whether the agent had more than 90% of its health.

This is the scholar threshold.

pub fn is_fifty(&self) -> bool

Whether the target health was below 50%.

This is the threshold for many runes and trait damage modifiers (e.g. Bolt to the Heart).

pub fn is_moving(&self) -> bool

Whether the source agent was moving.

pub fn is_flanking(&self) -> bool

Whether the source agent was flanking the target.

pub fn is_shields(&self) -> bool

Whether some (or all) damage was mitigated by shields.

impl Event

pub fn kind(&self) -> &EventKind

The kind of the event.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Event

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

Formats the value using the given formatter.

impl PartialEq<Event> for Event

fn eq(&self, other: &Event) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Event) -> bool

This method tests for !=.

impl TryFrom<&'_ CbtEvent> for Event

fn try_from(raw_event: &CbtEvent) -> Result<Self, Self::Error>

Transform a raw event to a “high-level” event.

If the event is not known, or some other error occured, None is returned.

• raw_event - the raw event to transform.

type Error = FromRawEventError

The type returned in the event of a conversion error.

impl TryFrom<CbtEvent> for Event

fn try_from(raw_event: CbtEvent) -> Result<Self, Self::Error>

Convenience method to avoid manual borrowing.

Note that this conversion will consume the event, so if you plan on re-using it, use the TryFrom<&raw::CbtEvent> implementation that works with a reference.

type Error = FromRawEventError

The type returned in the event of a conversion error.

impl StructuralPartialEq for Event