~/forever/addon-api/function/C_EncounterTimeline.GetSortedEventList
C_EncounterTimeline.GetSortedEventList
documented function · EncounterTimeline
C_EncounterTimeline.GetSortedEventList(maxEventCount?, maxEventDuration?, excludeTerminalStates, excludeHiddenEvents) : eventsReturns a sorted list of event IDs present in the timeline from shortest to longest remaining durations, meeting the requirements of the specified filters.
──ARGUMENTS
- maxEventCount
- number, optional (Maximum number of sorted events to return.)
- maxEventDuration
- Seconds, optional (Maximum duration of sorted events to return.)
- excludeTerminalStates
- bool, default true (If false, include events that are terminal states such as Canceled or Finished.)
- excludeHiddenEvents
- bool, default true (If false, include events that should be hidden by user configuration, such as events on long tracks when the user has opted to not show long countdowns.)
──RETURNS
- events
- table<EncounterTimelineEventID>
──DETAILS
- Secret Arguments
- NotAllowed
──VERSION HISTORY
Present since at least 1.60.1.70707, the first build we track.