Difference between revisions of "CreateScreenshot"
(Created page with "<b>History</b>: Available since v3.7 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. For a more advanced e...") |
|||
| Line 14: | Line 14: | ||
createScreenshot("screenshots/filename.png") | createScreenshot("screenshots/filename.png") | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| + | |||
<b>Arguments</b> | <b>Arguments</b> | ||
| − | saveTo: "string" | + | 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. | 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 | + | 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. | 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 | + | Return Values: None |
| − | None | ||
Revision as of 17:06, 5 March 2013
History: Available since v3.7
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. For a more advanced example of how to use createScreenshot() LUA command: click here!
Syntax:
createScreenshot(saveTo, {flags=1, clear = true|false})Example:
-- save to "screenshots" folder as "filename.png"!
createScreenshot("screenshots/filename.png")
Arguments
saveTo: "string"
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
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
