Interface Fight

Every report contains zero or more fights. Fights can be encounters or trash. An entire dungeon is considered one Fight as well, but you can access individual dungeon pulls within the Fight if needed. The Fight interface provides information such as the encounter id, the fight length, and the fight difficulty. Events that occurred during the fight are accessible from the events property, as well as other accessors that enable the fetching of specific categories of events.

interface Fight {
    allCombatantInfoEvents: CombatantInfoEvent[];
    allEnemyDeathEvents: DeathEvent[];
    allEvents: AnyEvent[];
    allFriendlyPlayerDeathEvents: DeathEvent[];
    combatantInfoEvents: CombatantInfoEvent[];
    combatTime: number;
    difficulty: number;
    downtimeTransitions: null | Band[];
    dungeonPulls: DungeonPull[];
    encounterId: number;
    endTime: number;
    enemyDeathEvents: DeathEvent[];
    enemyParticipants: Actor[];
    events: AnyEvent[];
    friendlyParticipants: Actor[];
    friendlyPlayerDeathEvents: DeathEvent[];
    hasEcho: boolean;
    headMarkerOffset: number;
    id: number;
    idInReport: number;
    isKill: boolean;
    isStandardComposition: boolean;
    maps: Map;
    maxX: number;
    maxY: number;
    minX: number;
    minY: number;
    name: string;
    phaseNames: null | string[];
    phaseTransitions: null | Band[][];
    report: Report;
    size: number;
    startTime: number;
    worldMarkers: WorldMarker[];
    zone: null | Zone;
    allEventsByCategoryAndDisposition(
        category: EventCategory,
        disposition: ActorDisposition,
    ): AnyEvent[];
    damageEventsForHealingEvent(event: AnyEvent): null | EventAndAmount[];
    eventsByCategoryAndDisposition(
        category: EventCategory,
        disposition: ActorDisposition,
    ): AnyEvent[];
    eventsForCast(castEvent: CastEvent): Event[];
    eventsPriorToDeath(event: DeathEvent): AnyEvent[];
    healingEventsForDamageEvent(event: AnyEvent): null | EventAndAmount[];
    instanceCountForNpc(actor: Actor): number;
    instanceGroupCountForNpc(actor: Actor): number;
    isEnemyParticipant(actor: Actor): boolean;
    isEventExcludedFromDamageRankings(event: AnyEvent): boolean;
    isFriendlyParticipant(actor: Actor): boolean;
    isUnpairedCalculationEvent(event: Event): boolean;
    itemLevelForPlayer(actor: Actor): number;
    levelForPlayer(actor: Actor): number;
    phaseForEvent(event: AnyEvent): null | number;
    roleForPlayer(actor: Actor): string;
    specForPlayer(actor: Actor): number;
}

Properties

allCombatantInfoEvents allEnemyDeathEvents allEvents allFriendlyPlayerDeathEvents combatantInfoEvents combatTime difficulty downtimeTransitions dungeonPulls encounterId endTime enemyDeathEvents enemyParticipants events friendlyParticipants friendlyPlayerDeathEvents hasEcho headMarkerOffset id idInReport isKill isStandardComposition maps maxX maxY minX minY name phaseNames phaseTransitions report size startTime worldMarkers zone

Methods

allEventsByCategoryAndDisposition damageEventsForHealingEvent eventsByCategoryAndDisposition eventsForCast eventsPriorToDeath healingEventsForDamageEvent instanceCountForNpc instanceGroupCountForNpc isEnemyParticipant isEventExcludedFromDamageRankings isFriendlyParticipant isUnpairedCalculationEvent itemLevelForPlayer levelForPlayer phaseForEvent roleForPlayer specForPlayer

Properties

allCombatantInfoEvents

allCombatantInfoEvents: CombatantInfoEvent[]

All combatant info events. These are cached, so this is faster than trying to find them on your own.

allEnemyDeathEvents

allEnemyDeathEvents: DeathEvent[]

Death events of enemies. These are cached, so this is faster than trying to find them on your own. For PvE content, the deaths are limited to NPCs. For supported PvP content, the deaths are of enemy players.

allEvents

allEvents: AnyEvent[]

All of the events in this fight.

allFriendlyPlayerDeathEvents

allFriendlyPlayerDeathEvents: DeathEvent[]

Death events of all friendly players. These are cached, so this is faster than trying to find them on your own.

combatantInfoEvents

combatantInfoEvents: CombatantInfoEvent[]

Combatant info events respecting the user's filters. These are cached, so this is faster than trying to find them on your own.

combatTime

combatTime: number

The combat time used for speed run rankings and dps rankings. Only set as of 6.4 or later.

difficulty

difficulty: number

The encounter difficulty.

downtimeTransitions

downtimeTransitions: null | Band[]

For fights where downtime is supported and used to shrink the total time over which damage dealt is considered, this will contain an array of the start/end bands for every chunk of downtime.

dungeonPulls

dungeonPulls: DungeonPull[]

For dungeons, individual pulls are stored and can be accessed.

encounterId

encounterId: number

The encounter id of the fight. Trash fights just have an encounter id of 0.

endTime

endTime: number

The end time of the fight. This is an offset relative to the start of the report, not an absolute time. This offset is in milliseconds.

enemyDeathEvents

enemyDeathEvents: DeathEvent[]

Death events of enemies respecting the user's filters. These are cached, so this is faster than trying to find them on your own. For PvE content, the deaths are limited to NPCs. For supported PvP content, the deaths are of enemy players.

enemyParticipants

enemyParticipants: Actor[]

All the enemy participants in the fight.

events

events: AnyEvent[]

The events of the fight respecting the user's filters.

friendlyParticipants

friendlyParticipants: Actor[]

All the friendly participants in the fight.

friendlyPlayerDeathEvents

friendlyPlayerDeathEvents: DeathEvent[]

Death events of friendly players respecting the user's filters. These are cached, so this is faster than trying to find them on your own.

hasEcho

hasEcho: boolean

Whether a player involved in the fight had the Echo buff.

headMarkerOffset

headMarkerOffset: number

If deobfuscation of head markers is supported, this offset will be non-zero and can be added to the marker id of a head marker event to get the true head marker number.

id

id: number

The id of the fight within its containing report group.

idInReport

idInReport: number

The id of the fight within its containing report.

isKill

isKill: boolean

Whether or not a fight with an encounter id was a kill.

isStandardComposition

isStandardComposition: boolean

Whether the party is a standard composition, defined as 2 tanks, 2 healers, and no more than 2 of a specific job.

maps

maps: Map

The maps used by the fight.

maxX

maxX: number

maxY

maxY: number

minX

minX: number

The bounding box for the fight in coordinates.

minY

minY: number

name

name: string

A localized name for the fight. For encounters, it will be the encounter name, and for trash fights, it will be the name of the NPC with the most hit points that was involved in the fight.

phaseNames

phaseNames: null | string[]

The phase names for all possible phases.

phaseTransitions

phaseTransitions: null | Band[][]

The phase transitions. Each entry in the array contains all of the start/end bands for that specific phase.

report

report: Report

The report that the fight belongs to.

size

size: number

The encounter size (number of players).

startTime

startTime: number

The start time of the fight. This is an offset relative to the start of the report, not an absolute time. This offset is in milliseconds.

worldMarkers

worldMarkers: WorldMarker[]

The world markers used by this fight.

zone

zone: null | Zone

The zone used by the fight.

Methods

allEventsByCategoryAndDisposition

  • allEventsByCategoryAndDisposition(
        category: EventCategory,
        disposition: ActorDisposition,
    ): AnyEvent[]

  • This method will obtain a cached subset of events matching the specified category and disposition.

    Parameters

    • category: EventCategory

      The category of events to fetch

    • disposition: ActorDisposition

      The disposition of the actors to check. A value of "neutral" will be treated like "enemy".

    Returns AnyEvent[]

    The cached event set. Use this method to quickly retrieve a subset of events.

damageEventsForHealingEvent

  • damageEventsForHealingEvent(event: AnyEvent): null | EventAndAmount[]

  • Get the set of damage events and amounts that represent the damage healed by this event. The amount are distinct from the events themselves so that you can see when a heal only partially healed some of the damage.

    Parameters

    Returns null | EventAndAmount[]

    • An array of events and the amount of damage healed for each event.

eventsByCategoryAndDisposition

  • eventsByCategoryAndDisposition(
        category: EventCategory,
        disposition: ActorDisposition,
    ): AnyEvent[]

  • This method will obtain a cached subset of events matching the specified category and disposition. The events will be filtered to the user's current event filters (e.g., phase, death cutoff, start/end time).

    Parameters

    • category: EventCategory

      The category of events to fetch

    • disposition: ActorDisposition

      The disposition of the actors to check. A value of "neutral" will be treated like "enemy".

    Returns AnyEvent[]

    The cached event set. Use this method to quickly retrieve a subset of events.

eventsForCast

  • eventsForCast(castEvent: CastEvent): Event[]

  • Obtain all events entrained by a given cast, e.g., all damage, healing, DoTs and HoTs, caused by the cast.

    Parameters

    • castEvent: CastEvent

      The cast to fetch the events for.

    Returns Event[]

    • An array of events

eventsPriorToDeath

  • eventsPriorToDeath(event: DeathEvent): AnyEvent[]

  • Get the set of events that occurred prior to a specified player death.

    Parameters

    Returns AnyEvent[]

    • An array of events going back to the last overheal the player received.

healingEventsForDamageEvent

  • healingEventsForDamageEvent(event: AnyEvent): null | EventAndAmount[]

  • Get the set of healing events and amounts that represent the heals that were done for this damage. The amount are distinct from the events themselves so that you can see when a heal only partially healed some of the damage.

    Parameters

    Returns null | EventAndAmount[]

    • An array of events and the amount of damage healed for each event.

instanceCountForNpc

  • instanceCountForNpc(actor: Actor): number

  • The instance count for a given actor.

    Parameters

    • actor: Actor

      The actor to fetch the group count for.

    Returns number

    • The instance count of the actor

instanceGroupCountForNpc

  • instanceGroupCountForNpc(actor: Actor): number

  • The instance group count for a given actor.

    Parameters

    • actor: Actor

      The actor to fetch the group count for.

    Returns number

    • The group count of the actor

isEnemyParticipant

  • isEnemyParticipant(actor: Actor): boolean

  • Whether or not an actor is an enemy participant.

    Parameters

    • actor: Actor

      The actor to check.

    Returns boolean

    Whether or not the actor is an enemy participant

isEventExcludedFromDamageRankings

  • isEventExcludedFromDamageRankings(event: AnyEvent): boolean

  • Whether or not this event should be excluded from damage rankings.

    Parameters

    Returns boolean

    Whether or not the event counts as part of damage done ranks.

isFriendlyParticipant

  • isFriendlyParticipant(actor: Actor): boolean

  • Whether or not an actor is a friendly participant.

    Parameters

    • actor: Actor

      The actor to check.

    Returns boolean

    Whether or not the actor is a friendly participant

isUnpairedCalculationEvent

  • isUnpairedCalculationEvent(event: Event): boolean

  • Returns whether or not a calculated damage or healing event is a ghost action, i.e., it has no corresponding direct damage or healing event.

    Parameters

    • event: Event

      The event to check.

    Returns boolean

    Whether or not the event is a ghost action.

itemLevelForPlayer

  • itemLevelForPlayer(actor: Actor): number

  • The item level for a given actor.

    Parameters

    • actor: Actor

      The player to fetch the item level for.

    Returns number

    • The item level of the actor

levelForPlayer

  • levelForPlayer(actor: Actor): number

  • The level for a given actor.

    Parameters

    • actor: Actor

      The player to fetch the level for.

    Returns number

    • The level of the actor

phaseForEvent

  • phaseForEvent(event: AnyEvent): null | number

  • Helper function to obtain the phase an event occurs in.

    Parameters

    • event: AnyEvent

      The event whose timestamp will be checked against the phase transitions.

    Returns null | number

    The phase the event occurs in, or null if the fight has no phases.

roleForPlayer

  • roleForPlayer(actor: Actor): string

  • The role that an actor played in a specific fight.

    Parameters

    Returns string

    The role of the actor, or their subType if unknown.

specForPlayer

  • specForPlayer(actor: Actor): number

  • The spec for a given actor.

    Parameters

    • actor: Actor

      The player to fetch the spec for.

    Returns number

    • The spec of the actor

Settings

Member Visibility

On This Page

Properties
Methods