|
|
| (23 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| − | <b>History</b>: Available since v3.7
| + | #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.
| |
| − | 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>Arguments</b>
| |
| − | | |
| − | 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.
| |
