WoW:API LoggingChat: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Move page script moved page API LoggingChat to API LoggingChat without leaving a redirect) |
||
| (5 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{ | {{wowapi}} __NOTOC__ | ||
<!-- Describe the purpose of the function, exhausting detail can be saved for a later section --> | |||
Toggles the chat logging and returns the current state. | |||
<!-- List return values and arguments as well as function name, follow Blizzard usage convention for args --> | |||
isLogging = LoggingChat([newState]) | |||
== Parameters == | |||
=== Arguments === | |||
<!-- List each argument, together with its type --> | |||
:;newState : Boolean - toggles chat logging | |||
=== Returns === | |||
<!-- List each return value, together with its type --> | |||
:;isLogging : Boolean - current state of logging | |||
== Example == | |||
<!-- If it helps, include an example here, though it's not required if the usage is self-explanatory --> | |||
if (LoggingChat()) then | |||
DEFAULT_CHAT_FRAME:AddMessage("Chat is already being logged"); | |||
else | |||
DEFAULT_CHAT_FRAME:AddMessage("Chat is not being logged - starting it!"); | |||
LoggingChat(1); | |||
DEFAULT_CHAT_FRAME:AddMessage("Chat is now being logged to Logs\\WOWChatLog.txt"); | |||
end | |||
Latest revision as of 04:46, 15 August 2023
← WoW API < LoggingChat
Toggles the chat logging and returns the current state.
isLogging = LoggingChat([newState])
Parameters[edit]
Arguments[edit]
- newState
- Boolean - toggles chat logging
Returns[edit]
- isLogging
- Boolean - current state of logging
Example[edit]
if (LoggingChat()) then
DEFAULT_CHAT_FRAME:AddMessage("Chat is already being logged");
else
DEFAULT_CHAT_FRAME:AddMessage("Chat is not being logged - starting it!");
LoggingChat(1);
DEFAULT_CHAT_FRAME:AddMessage("Chat is now being logged to Logs\\WOWChatLog.txt");
end