aboutsummaryrefslogtreecommitdiff
path: root/src/raw/types.rs
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2020-04-28 15:28:13 +0200
committerDaniel Schadt <kingdread@gmx.de>2020-04-28 15:28:13 +0200
commitdb8e74092776d499ba1590389411735b6276af78 (patch)
tree7765fac923f247f88ec40e96aba2e3f8564c1e2d /src/raw/types.rs
parent7a631f428ce38112157d1c16eaaa2df248c1d46d (diff)
downloadevtclib-db8e74092776d499ba1590389411735b6276af78.tar.gz
evtclib-db8e74092776d499ba1590389411735b6276af78.tar.bz2
evtclib-db8e74092776d499ba1590389411735b6276af78.zip
fix documentation for CbtStatechange
Diffstat (limited to 'src/raw/types.rs')
-rw-r--r--src/raw/types.rs46
1 files changed, 31 insertions, 15 deletions
diff --git a/src/raw/types.rs b/src/raw/types.rs
index abb8a14..3544531 100644
--- a/src/raw/types.rs
+++ b/src/raw/types.rs
@@ -125,36 +125,52 @@ pub enum CbtStateChange {
/// Combat event that will appear once per buff per agent on logging start (zero duration,
/// buff==18)
BuffInitial,
- /// src_agent changed, cast float* p = (float*)&dst_agent, access as x/y/z (float[3])
+ /// `src_agent` changed position.
+ ///
+ /// * `dst_agent` is a 2-element float array (x, y).
+ /// * `value` is a single float (z).
Position,
- /// src_agent changed, cast float* v = (float*)&dst_agent, access as x/y/z (float[3])
+ /// `src_agent` changed velocity.
+ ///
+ /// * `dst_agent` is a 2-element float array (x, y).
+ /// * `value` is a single float (z).
Velocity,
- /// src_agent changed, cast float* f = (float*)&dst_agent, access as x/y (float[2])
+ /// `src_agent` changed the direction that they're facing.
+ ///
+ /// * `dst_agent` is a 2-element float array (x, y).
Facing,
- /// src_agent change, dst_agent new team id
+ /// `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
+ /// `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)
+ /// `dst_agent` is the new target-able state (0 = no, 1 = yes. default yes)
Targetable,
- /// src_agent is map id
+ /// 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
+ /// `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
+ /// `src_agent` is agent with buff, `value` is the duration to reset to (also marks inactive),
+ /// `pad61-` is the stackid
StackReset,
- /// src_agent is agent, dst_agent through buff_dmg is 16 byte guid (client form, needs minor rearrange for api form)
+ /// 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)
+ /// `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)
+ /// `(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)
+ /// `(float*)&time [9]`: recharge range0 range1 tooltiptime (not in realtime)
SkillInfo,
- /// src_agent = action, dst_agent = at millisecond (not in realtime, one per timing)
+ /// `src_agent` = action, `dst_agent` = at millisecond (not in realtime, one per timing)
SkillTiming,
}