Difference between revisions of "CreateScreenshot"
| Line 1: | Line 1: | ||
| − | <b>History</b>: Available since <span style="color: | + | <div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"> |
| + | <b>Command History</b> | ||
| + | <div class="mw-collapsible-content"> | ||
| + | <div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div> | ||
| + | </div></div> | ||
| + | |||
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/> | 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]]! | For a more advanced example of how to use createScreenshot() LUA command: click [[Variable_createScreenshot_Example|here]]! | ||
| + | |||
Syntax: | Syntax: | ||
| Line 8: | Line 14: | ||
createScreenshot(saveTo, {flags=1, clear = true|false}) | createScreenshot(saveTo, {flags=1, clear = true|false}) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| + | |||
Example: | Example: | ||
| Line 14: | Line 21: | ||
createScreenshot("screenshots/filename.png") | createScreenshot("screenshots/filename.png") | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| + | |||
Revision as of 19:19, 7 March 2013
Command History
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: None
