C_EncounterTimeline

namespaceavailable in: camelot

Status in wowlua

34 functions: 21 implemented, 0 recorded, 13 guessed. 11 events, 4 of them fired by the emulator on its own.

Functions

function	what it does	status
`AddEditModeEvents`	Adds a predefined set of events to the timeline for display in Edit Mode. `(): Seconds`	guessed
`AddScriptEvent`	Adds a custom event to the timeline. `(eventInfo: EncounterTimelineScriptEventRequest): EncounterTimelineEventID`	implemented
`CancelAllScriptEvents`	Cancels all custom timeline events, removing them from the timeline. `()`	implemented
`CancelEditModeEvents`	Removes all Edit Mode events from the timeline. `()`	guessed
`CancelScriptEvent`	Cancels a custom timeline event, removing it from the timeline. `(eventID: EncounterTimelineEventID)`	implemented
`FinishScriptEvent`	Finishes a custom timeline event, removing it from the timeline. `(eventID: EncounterTimelineEventID)`	implemented
`GetCurrentTime`	Returns the current timestamp used for rendering the timeline display. `(): Seconds`	guessed
`GetEventColor`	Returns the current color used to render timeline event. `(eventID: EncounterTimelineEventID, overrideTrigger: EncounterEventColorTrigger?): ColorMixin`	implemented
`GetEventCountBySource`	Returns the number of present events in the timeline by their source type. `(source: EncounterTimelineEventSource): number`	implemented
`GetEventHighlightTime`	Returns the duration at which timeline events will be highlighted for imminency. `(): Seconds`	guessed
`GetEventInfo`	Returns information about a timeline event. This data is generally expected to be static for the lifetime of an event. `(eventID: EncounterTimelineEventID): EncounterTimelineEventInfo`	implemented
`GetEventList`	Returns an unsorted list of event IDs present in the timeline. `(): EncounterTimelineEventID[]`	implemented
`GetEventState`	Returns the current state of a timeline event. `(eventID: EncounterTimelineEventID): EncounterTimelineEventState`	implemented
`GetEventTimeElapsed`	Returns the elapsed duration of a timeline event. `(eventID: EncounterTimelineEventID): Seconds`	implemented
`GetEventTimeRemaining`	Returns the remaining duration of a timeline event. `(eventID: EncounterTimelineEventID): Seconds`	implemented
`GetEventTimer`	Returns a Duration object that tracks the elapsed duration of a timeline event. This object tracks the range [0, duration] of the event and automatically pauses its progression based on event state. `(eventID: EncounterTimelineEventID): LuaDurationObject?`	guessed
`GetEventTrack`	Returns information about the position of an event on the timeline. `(eventID: EncounterTimelineEventID): (EncounterTimelineTrack, number?)`	implemented
`GetSortedEventList`	Returns a sorted list of event IDs present in the timeline from shortest to longest remaining durations, meeting the requirements of the specified filters. `(maxEventCount: number?, maxEventDuration: Seconds?, excludeTerminalStates: boolean, excludeHiddenEvents: boolean): EncounterTimelineEventID[]`	implemented
`GetTrackInfo`	Returns information for a single timeline track. `(track: EncounterTimelineTrack): EncounterTimelineTrackInfo`	guessed
`GetTrackList`	Returns information about all timeline tracks. `(): EncounterTimelineTrackInfo[]`	guessed
`GetTrackMaxEventDuration`	Returns the maximum permitted event duration on a single timeline track. `(track: EncounterTimelineTrack): Seconds`	guessed
`GetTrackType`	Returns the type of a single timeline track. `(track: EncounterTimelineTrack): EncounterTimelineTrackType`	guessed
`GetViewType`	Returns the current view type of the timeline. `(): EncounterTimelineViewType`	guessed
`HasActiveEvents`	Returns true if the timeline contains any events in the active state. `(): boolean`	implemented
`HasAnyEvents`	Returns true if the timeline contains any events in any state. `(): boolean`	implemented
`HasPausedEvents`	Returns true if the timeline contains any events in the paused state. `(): boolean`	implemented
`HasVisibleEvents`	Returns true if the timeline contains any events that are on visible tracks. `(): boolean`	implemented
`IsEventBlocked`	Returns true if the event is in a 'blocked' state, where the cast for this event may not occur due to encounter conditions not being met. `(eventID: EncounterTimelineEventID): boolean`	implemented
`IsFeatureAvailable`	Returns true if the encounter timeline feature is available on this client. `(): boolean`	guessed
`IsFeatureEnabled`	Returns true if the encounter timeline feature has been enabled by the player. This function will always return false if the feature is not available. `(): boolean`	guessed
`PauseScriptEvent`	Pauses a custom timeline event, hiding it from the timeline. A paused event can later be resumed to show it again, or canceled. `(eventID: EncounterTimelineEventID)`	implemented
`ResumeScriptEvent`	Resumes a custom timeline event, showing it on the timeline again if it is currently paused. `(eventID: EncounterTimelineEventID)`	implemented
`SetEventIconTextures`	Updates a given vector of texture objects to reference art assets for icons associated with an event. `(eventID: EncounterTimelineEventID, includeIcons: EncounterEventIconmask, textures: Texture[])`	implemented
`SetViewType`	Changes the view type for the timeline. This adjusts track layouts to be more appropriate for a specific mode and optimizes event processing. `(viewType: EncounterTimelineViewType)`	guessed

Events

event	payload	fired by the emulator
`ENCOUNTER_TIMELINE_EVENT_ADDED`	`eventInfo: EncounterTimelineEventInfo`	implemented
`ENCOUNTER_TIMELINE_EVENT_BLOCK_STATE_CHANGED`	`eventID: EncounterTimelineEventID`	not implemented
`ENCOUNTER_TIMELINE_EVENT_COLOR_CHANGED`	`eventID: EncounterTimelineEventID`	not implemented
`ENCOUNTER_TIMELINE_EVENT_HIGHLIGHT`	`eventID: EncounterTimelineEventID`	not implemented
`ENCOUNTER_TIMELINE_EVENT_REMOVED`	`eventID: EncounterTimelineEventID`	implemented
`ENCOUNTER_TIMELINE_EVENT_STATE_CHANGED`	`eventID: EncounterTimelineEventID`	implemented
`ENCOUNTER_TIMELINE_EVENT_TRACK_CHANGED`	`eventID: EncounterTimelineEventID`	not implemented
`ENCOUNTER_TIMELINE_LAYOUT_UPDATED`	`no payload`	implemented
`ENCOUNTER_TIMELINE_STATE_UPDATED`	`no payload`	not implemented
`ENCOUNTER_TIMELINE_VIEW_ACTIVATED`	`viewType: EncounterTimelineViewType`	not implemented
`ENCOUNTER_TIMELINE_VIEW_DEACTIVATED`	`viewType: EncounterTimelineViewType`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("ENCOUNTER_TIMELINE_EVENT_BLOCK_STATE_CHANGED").

Structures

EncounterTimelineEventFilter · maxEventCount?, maxEventDuration?, excludeTerminalStates, excludeHiddenEvents
EncounterTimelineEventInfo · id, source, spellName, spellID, iconFileID, duration, maxQueueDuration, icons, severity, isApproximate
EncounterTimelineScriptEventRequest · spellID, iconFileID, duration, maxQueueDuration, overrideName, icons?, severity, paused
EncounterTimelineTrackInfo · id, type, minimumDuration?, maximumDuration?, minimumEventIntroDuration?, minimumEventGapDuration?, maximumEventCount?, sortDirection?

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (EncounterTimeline system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗.