Wiley-World.of.Warcraft.Programming.A.Guide.and.Reference.for.Creating.WoW.Addons

618 Part IV ■ ReferenceCombatLogClearEntriesRemoves all entries from the combat log.CombatLogGetCurrentEntryReturns the combat log event information for the current entry and advancesto the next entry.timestamp, event, srcGUID, srcName, srcFlags, destGUID, destName, idestFlags, ... = CombatLogGetCurrentEntry([ignoreFilter])See COMBAT_LOG_EVENT for details of the event information.The combat log maintains a ‘‘cursor’’ in the list of entries; this function returnsinformation about the event at the cursor position and advances the cursor tothe next entry. Since this function is used by the default UI’s combat logdisplay, the cursor position is usually at the end of the log; calling it thusreturns nothing. The function CombatLogSetCurrentEntry() can be used to‘‘rewind’’ the combat log cursor, enabling retrieval of information about earlierevents.Arguments:ignoreFilter (optional)—True to use the entire saved combat log history;false or omitted to use only events matching the current filter (boolean)Returns:timestamp—Time at which the event occurred (same format astime() and date(), but with millisecond precision) (number)event—Type of combat log event (string)srcGUID—GUID of the unit that initiated the event (string, guid)srcName—Name of the unit that initiated the event (string)srcFlags—Flags indicating the nature of the source unit (number, bitfield)destGUID—GUID of the unit that was the target of the event (string,guid)destName—Name of the unit that was the target of the event (string)destFlags—Flags indicating the nature of the target unit (number, bitfield)...—Additional arguments specific to the event type (list)CombatLogGetNumEntriesReturns the number of available combat log events.CombatLogGetNumEntries(ignoreFilter)Arguments:ignoreFilter—True to use the entire saved combat log history; falseor omitted to use only events matching the current filter (boolean)CombatLogGetRetentionTimeReturns the amount of time combat log entries are stored.seconds = CombatLogGetRetentionTime()Returns:seconds—Amount of time entries remain available (number)