1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
//! Raw evtc structs.
//!
//! This module contains the translated definitions from arcdps's C structs.
use num_derive::FromPrimitive;
use std::hash::Hash;
/// The "friend or foe" enum.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum IFF {
/// Green vs green, red vs red.
Friend,
/// Green vs red.
Foe,
/// Something very wrong happened.
Unknown,
/// Field is not used in this kind of event.
None,
}
impl Default for IFF {
fn default() -> Self {
IFF::None
}
}
/// Combat result (physical)
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum CbtResult {
/// Good physical hit
Normal,
/// Physical hit was a critical hit
Crit,
/// Physical hit was a glance
Glance,
/// Physical hit was blocked (e.g. Shelter)
Block,
/// Physical hit was evaded (e.g. dodge)
Evade,
/// Physical hit interrupted something
Interrupt,
/// Physical hit was absorbed (e.g. invulnerability)
Absorb,
/// Physical hit missed
Blind,
/// Physical hit was the killing blow
KillingBlow,
/// Hit was downing hit.
Downed,
/// Hit was breakbar damage.
Breakbar,
/// Field is not used in this kind of event.
None,
}
impl Default for CbtResult {
fn default() -> Self {
CbtResult::None
}
}
/// Combat activation
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum CbtActivation {
/// Field is not used in this kind of event.
None,
/// Activation without quickness
Normal,
/// Activation with quickness
Quickness,
/// Cancel with reaching channel time
CancelFire,
/// Cancel without reaching channel time
CancelCancel,
/// Animation completed fully
Reset,
}
impl Default for CbtActivation {
fn default() -> Self {
CbtActivation::None
}
}
/// Combat state change
///
/// The referenced fields are of the [`CbtEvent`](struct.CbtEvent.html)
/// struct.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum CbtStateChange {
/// Field is not used in this kind of event.
None,
/// `src_agent` entered combat.
///
/// * `dst_agent` specifies the agent's subgroup.
EnterCombat,
/// `src_agent` left combat.
ExitCombat,
/// `src_agent` is now alive.
ChangeUp,
/// `src_agent` is now dead.
ChangeDead,
/// `src_agent` is now downed.
ChangeDown,
/// `src_agent` is now in game tracking range.
Spawn,
/// `src_agent` is no longer being tracked.
Despawn,
/// `src_agent` has reached a health marker.
///
/// * `dst_agent` will be set to the new health percentage, multiplied by
/// 10000.
HealthUpdate,
/// Log start.
///
/// * `value` is the server unix timestamp.
/// * `buff_dmg` is the local unix timestamp.
/// * `src_agent` is set to `0x637261` (arcdps id)
LogStart,
/// Log end.
///
/// * `value` is the server unix timestamp.
/// * `buff_dmg` is the local unix timestamp.
/// * `src_agent` is set to `0x637261` (arcdps id)
LogEnd,
/// `src_agent` swapped the weapon set.
///
/// * `dst_agent` is the current set id (0/1 for water sets, 4/5 for land
/// sets)
WeapSwap,
/// `src_agent` has had it's maximum health changed.
///
/// * `dst_agent` is the new maximum health.
MaxHealthUpdate,
/// `src_agent` is the agent of the recording player.
PointOfView,
/// `src_agent` is the text language.
Language,
/// `src_agent` is the game build.
GwBuild,
/// `src_agent` is the server shard id.
ShardId,
/// Represents the reward (wiggly box)
///
/// * `src_agent` is self
/// * `dst_agent` is reward id.
/// * `value` is reward type.
Reward,
/// Combat event that will appear once per buff per agent on logging start (zero duration,
/// buff==18)
BuffInitial,
/// `src_agent` changed position.
///
/// * `dst_agent` is a 2-element float array (x, y).
/// * `value` is a single float (z).
Position,
/// `src_agent` changed velocity.
///
/// * `dst_agent` is a 2-element float array (x, y).
/// * `value` is a single float (z).
Velocity,
/// `src_agent` changed the direction that they're facing.
///
/// * `dst_agent` is a 2-element float array (x, y).
Facing,
/// `src_agent` changed team.
///
/// * `dst_agent` is the new team id
TeamChange,
/// `src_agent` is an attacktarget, `dst_agent` is the parent agent (gadget type), `value` is the current targetable state
AttackTarget,
/// `dst_agent` is the new target-able state (0 = no, 1 = yes. default yes)
Targetable,
/// Information about the map that the log was done on.
///
/// * `src_agent` is map id
MapId,
/// internal use by arcDPS, won't see anywhere
ReplInfo,
/// `src_agent` is agent with buff, `dst_agent` is the stackid marked active
StackActive,
/// `src_agent` is agent with buff, `value` is the duration to reset to (also marks inactive),
/// `pad61-` is the stackid
StackReset,
/// Information about the guild.
///
/// * `src_agent` is the agent
/// * `dst_agent` through `buff_dmg` is 16 byte guild id (client form, needs minor rearrange
/// for api form)
Guild,
/// `is_flanking` = probably invuln, `is_shields` = probably invert, `is_offcycle` = category, `pad61` = stacking type, `src_master_instid` = max stacks (not in realtime)
BuffInfo,
/// `(float*)&time [9]`: type attr1 attr2 param1 param2 param3 trait_src trait_self, `is_flanking` = !npc, `is_shields` = !player, `is_offcycle` = break (not in realtime, one per formula)
BuffFormula,
/// `(float*)&time [9]`: recharge range0 range1 tooltiptime (not in realtime)
SkillInfo,
/// `src_agent` = action, `dst_agent` = at millisecond (not in realtime, one per timing)
SkillTiming,
/// `src_agent` is agent, `value` is u16 game enum (active, recover, immune, none)
BreakbarState,
/// `src_agent` is agent, `value` is float with percent
BreakbarPercent,
/// `time` is the start of the error string.
Error,
/// `src_agent` is the agent, `value` is the tag id
Tag,
/// `src_agent` is at barrier percent, `dst_agent` is the percentage times 10000 (so 99.5%
/// will be 9950).
BarrierUpdate,
}
impl Default for CbtStateChange {
fn default() -> Self {
CbtStateChange::None
}
}
/// Combat buff remove type
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum CbtBuffRemove {
/// Field is not used in this kind of event.
None,
/// All stacks removed.
All,
/// Single stack removed.
///
/// Disabled on server trigger, will happen for each stack on cleanse.
Single,
/// Autoremoved by OOC or allstack.
///
/// (Ignore for strip/cleanse calc, use for in/out volume)-
Manual,
}
impl Default for CbtBuffRemove {
fn default() -> Self {
CbtBuffRemove::None
}
}
/// Custom skill ids
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum CbtCustomSkill {
/// Not custom but important and unnamed.
Resurrect = 1066,
/// Personal healing only.
Bandage = 1175,
/// Will occur in is_activation==normal event.
Dodge = 65001,
}
/// Language
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum Language {
/// English.
Eng = 0,
/// French.
Fre = 2,
/// German.
Gem = 3,
/// Spanish.
Spa = 4,
}
impl Default for Language {
fn default() -> Self {
Language::Eng
}
}
/// Buff formula attributes.
///
/// Variants prefixed with `Custom` are not native to the game client but rather variants added by
/// arcdps.
///
/// The suffix `Inc` indicates an increase, whereas the suffix `Rec` stands for received.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum Attribute {
None,
Power,
Precision,
Toughness,
Vitality,
Ferocity,
Healing,
Condition,
Concentration,
Expertise,
CustomArmor,
CustomAgony,
CustomStatInc,
CustomFlatInc,
CustomPhysInc,
CustomCondInc,
CustomPhysRec,
CustomCondRec,
CustomAttackSpeed,
}
/// Categories for [`BuffInfo`][CbtStateChange::BuffInfo] events.
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, FromPrimitive)]
pub enum BuffCategory {
Boon = 0,
Any = 1,
Condition = 2,
Food = 4,
Upgrade = 6,
Boost = 8,
Trait = 11,
Enhancement = 13,
Stance = 16,
}
/// A combat event.
///
/// This event combines both the old structure and the new structure. Fields not
/// present in the source are zeroed. When dealing with events, always make sure
/// to check the header.revision tag.
///
/// For conflicting data types, the bigger one is chosen (e.g. u32 over u16).
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[derive(Clone, Debug, PartialEq, Eq, Hash, Default)]
pub struct CbtEvent {
/// System time since Windows was started, in milliseconds.
pub time: u64,
/// Unique identifier of the source agent.
pub src_agent: u64,
/// Unique identifier of the destination agent.
pub dst_agent: u64,
/// Event-specific value.
pub value: i32,
/// Estimated buff damage. Zero on application event.
pub buff_dmg: i32,
/// Estimated overwritten stack duration for buff application.
pub overstack_value: u32,
/// Skill id.
pub skillid: u32,
/// Agent map instance id.
pub src_instid: u16,
/// Agent map instance id.
pub dst_instid: u16,
/// Master source agent map instance id if source is a minion/pet.
pub src_master_instid: u16,
/// Master destination agent map instance id if destination is a minion/pet.
pub dst_master_instid: u16,
pub iff: IFF,
/// Buff application, removal or damage event.
pub buff: u8,
pub result: CbtResult,
pub is_activation: CbtActivation,
pub is_buffremove: CbtBuffRemove,
/// Source agent health was over 90%.
pub is_ninety: bool,
/// Target agent health was under 90%.
pub is_fifty: bool,
/// Source agent was moving.
pub is_moving: bool,
pub is_statechange: CbtStateChange,
/// Target agent was not facing source.
pub is_flanking: bool,
/// All or part damage was vs. barrier/shield.
pub is_shields: bool,
/// False if buff dmg happened during tick, true otherwise.
pub is_offcycle: bool,
/// Padding for some events.
pub padding_end: u32,
}
/// An agent.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct Agent {
/// Agent id.
pub addr: u64,
/// Agent profession id.
pub prof: u32,
/// Agent elite specialization.
pub is_elite: u32,
/// Toughnes.
pub toughness: i16,
/// Concentration.
pub concentration: i16,
/// Healing.
pub healing: i16,
/// Condition
pub condition: i16,
/// Name/Account combo field.
pub name: [u8; 64],
}
impl Agent {
/// Checks whether this agent is a gadget.
///
/// Gadgets are entities spawned by some skills, like the "Binding Roots"
/// spawned by Entangle.
pub fn is_gadget(&self) -> bool {
self.is_elite == std::u32::MAX && (self.prof & 0xffff_0000) == 0xffff_0000
}
/// Checks whether this agent is a character.
///
/// Characters are entities like clones, pets, minions, spirits, but also
/// minis.
pub fn is_character(&self) -> bool {
self.is_elite == std::u32::MAX && (self.prof & 0xffff_0000) != 0xffff_0000
}
/// Checks whether this agent is a player.
pub fn is_player(&self) -> bool {
self.is_elite != std::u32::MAX
}
}
// We need to implement this manually, as our array is bigger than 32.
impl Default for Agent {
fn default() -> Self {
Self {
addr: Default::default(),
prof: Default::default(),
is_elite: Default::default(),
toughness: Default::default(),
concentration: Default::default(),
healing: Default::default(),
condition: Default::default(),
name: [0; 64],
}
}
}
/// A skill.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct Skill {
/// Skill id.
pub id: i32,
/// Skill name.
pub name: [u8; 64],
}
impl Skill {
/// Return the name of the skill as a `String`.
///
/// Returns `None` if the name is not valid UTF-8.
pub fn name_string(&self) -> Option<String> {
let bytes = self
.name
.iter()
.cloned()
.take_while(|b| *b != 0)
.collect::<Vec<_>>();
String::from_utf8(bytes).ok()
}
}
impl Default for Skill {
fn default() -> Self {
Self {
id: Default::default(),
name: [0; 64],
}
}
}