Difference between revisions of "CreateScreenshot"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Redirected page to Global Command: createScreenshot)
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<b>History</b>: Available since <span style="color:green">v3.7</span>
+
#REDIRECT [[Global Command: createScreenshot]]
 
 
A user can create a screenshot to be used for the next save game or to save into an external folder as a .png file. <br/>
 
For a more advanced example of how to use createScreenshot() LUA command: click [[Variable_createScreenshot_Example|here]]!
 
 
 
Syntax:
 
<syntaxhighlight>
 
createScreenshot(saveTo, {flags=1, clear = true|false})
 
</syntaxhighlight>
 
 
 
Example:
 
<syntaxhighlight>
 
-- save to "screenshots" folder as "filename.png"!
 
createScreenshot("screenshots/filename.png")
 
</syntaxhighlight>
 
 
 
 
 
<b><u>Arguments</u></b>
 
 
 
saveTo: "string" <br/>
 
If specified the screenshot will be saved to the given path. Otherwise the screenshot will be used for the next savegame(s), as long as a new screenshot is created or the current screenshot is cleared. If a screenshot for a savegame was created before it will be overwritten by the new screenshot.
 
 
 
Flags: clr/clear <br/>
 
If true the screenshot will be cleared. Default value is false. If the screenshot is cleared it will be generated automatically by the engine again, everytime the scene is changed from a playable scene to a menu.
 
 
 
Return Values: None
 

Latest revision as of 13:23, 19 May 2023