WoW:API LoggingCombat: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
mNo edit summary
(Rewrote the page so it isn't a stub.)
Line 1: Line 1:
{{Stub/API}}
{{wowapi}} __NOTOC__
{{wowapi}}


See [[API LoggingChat]]
 
Toggles logging for the combat log and returns the current state.
isLogging = LoggingCombat([newState])
 
 
== Parameters ==
=== Arguments ===
:;newState : Boolean - toggles combat logging
 
=== Returns ===
:;isLogging : Boolean - current state of logging
 
 
== Example ==
if (LoggingCombat()) then
  DEFAULT_CHAT_FRAME:AddMessage("Combat is already being logged";
else
  DEFAULT_CHAT_FRAME:AddMessage("Combat is not being logged - starting it!"); 
  LoggingCombat(1);
end
 
 
== Details ==
: If no parameter is passed in, LoggingCombat turns logging on.

Revision as of 12:40, 25 June 2007

WoW API < LoggingCombat


Toggles logging for the combat log and returns the current state.

isLogging = LoggingCombat([newState])


Parameters

Arguments

newState
Boolean - toggles combat logging

Returns

isLogging
Boolean - current state of logging


Example

if (LoggingCombat()) then
  DEFAULT_CHAT_FRAME:AddMessage("Combat is already being logged";
else
  DEFAULT_CHAT_FRAME:AddMessage("Combat is not being logged - starting it!");  
  LoggingCombat(1);
end


Details

If no parameter is passed in, LoggingCombat turns logging on.