WoW:API TakeScreenshot: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (catfix, Replaced: {{framexml → <br>{{framexml)
Line 1: Line 1:
{{framexmlfunc|FrameXML/WorldFrame.lua}} __NOTOC__
<br>{{framexmlfunc|FrameXML/WorldFrame.lua}} __NOTOC__





Revision as of 00:42, 15 July 2008


WoW API < TakeScreenshot

"I" iconThis function is implemented in Lua here FrameXML/WorldFrame.lua.


TakeScreenshot();

Takes a screenshot.


Parameters

Arguments

none

Returns

nil


Example

TakeScreenshot();


Details

Takes a screenshot. The format of the file saved can be controlled via /console commands or config.wtf settings. See the article on changing the screenshot format.
TakeScreenshot() is a blocking call. Once called the remainder of your Lua script is not executed. If you have script that you need to execute post screenshot you will need to use a state machine and subscribe to the OnUpdate event, or you will need to subscribe to the following events:
  • SCREENSHOT_FAILED Called when a screenshot fails.
  • SCREENSHOT_SUCCEEDED Called when a screenshot is successfully taken.