aboutsummaryrefslogtreecommitdiff
path: root/src/analyzers/raids/mod.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/analyzers/raids/mod.rs')
-rw-r--r--src/analyzers/raids/mod.rs11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/analyzers/raids/mod.rs b/src/analyzers/raids/mod.rs
index 33d54ce..39fb823 100644
--- a/src/analyzers/raids/mod.rs
+++ b/src/analyzers/raids/mod.rs
@@ -1,3 +1,9 @@
+//! Analyzers for raid logs.
+//!
+//! Most of the fights can use the [`GenericRaid`][GenericRaid] analyzer. The exception to this are
+//! fights which have a Challenge Mote (Wing 4, Wing 5, Wing 6, Wing 7), and fights which need to
+//! use a different method to determine their outcome (Xera, Deimos, Soulless Horror, Conjured
+//! Amalgamate, Qadim).
use crate::{
analyzers::{helpers, Analyzer, Outcome},
Log,
@@ -19,6 +25,11 @@ mod w7;
pub use w7::{CardinalAdina, CardinalSabir, QadimThePeerless};
/// A generic raid analyzer that works for bosses without special interactions.
+///
+/// This analyzer always returns `false` for the Challenge Mote calculation.
+///
+/// The outcome of the fight is determined by whether the boss agent has a death event - which
+/// works for a lot of fights, but not all of them.
#[derive(Debug, Clone, Copy)]
pub struct GenericRaid<'log> {
log: &'log Log,