Global Command: createScreenshot - Revision history

EK at 17:58, 2 May 2023

2023-05-02T17:58:00Z

EK at 13:13, 2 May 2023

2023-05-02T13:13:02Z

EK at 12:06, 2 May 2023

2023-05-02T12:06:07Z

EK at 11:55, 2 May 2023

2023-05-02T11:55:37Z

EK: EK moved page CreateScreenshot (CMS) to Global Command: createScreenshot

2023-05-02T11:14:16Z

EK moved page CreateScreenshot (CMS) to Global Command: createScreenshot

EK at 10:34, 2 May 2023

2023-05-02T10:34:07Z

David Stoffel: Text replacement - "{{toc}}" to ""

2014-11-03T23:50:44Z

Text replacement - "{{toc}}" to ""

AFRLme at 16:35, 24 September 2014

2014-09-24T16:35:52Z

AFRLme at 16:35, 24 September 2014

2014-09-24T16:35:20Z

AFRLme at 16:33, 24 September 2014

2014-09-24T16:33:58Z

@@ Line 26: / Line 26: @@
 |-
 | clear (bool)
-| If true the screenshot will be cleared. Default value is false. If the screenshot is cleared, savegame screenshots 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. If the screenshot is cleared, savegame screenshots will be generated automatically by the engine again (everytime the scene is changed from a playable scene to a menu). If the "flags" parameter is omitted, this defaults to false.
 |}

@@ Line 36: / Line 36: @@
 == Examples ==
-'''Example 1:''' Save a screenshot to a folder (if a file with the same name exists, it will be overwritten)
 <syntaxhighlight lang="lua">
--- save to "screenshots" folder as "filename.png"
+createScreenshot()
-createScreenshot("screenshots/filename.png")
+</syntaxhighlight>
--- save to "screenshots" folder with current timestamp as "filename_(date)_(time).png"
+'''Example 2:''' Clear the previously saved savegame screenshot.
-local time = os.date("%Y-%m-%d_%Hh-%Mm-%Ss")
+<syntaxhighlight lang="lua">
-createScreenshot("screenshots/filename_" .. time .. ".png")
+createScreenshot("", {flags=1, clear = true})
 </syntaxhighlight>
-'''Example 2:''' Save a screenshot to use for the next savegame
+'''Example 3:''' Save a screenshot to a folder. If a file with the same name already exists, it will be overwritten. Be aware that the default save location is the game directory, which may be write-protected.
 <syntaxhighlight lang="lua">
-createScreenshot()
+createScreenshot("screenshots/my_screenshot.png")
 </syntaxhighlight>
-'''Example 3:''' Clear the previously saved savegame screenshot
+'''Example 4:''' This expanded example uses the "lfs" file system library to check for a "screenshots" folder inside the user directory and creates it if it doesn't exist.
 <syntaxhighlight lang="lua">
-createScreenshot("", {flags=1, clear = true})
+-- Define a screenshot folder inside the user directory
 </syntaxhighlight>
 {{toc}}

@@ Line 4: / Line 4: @@
 == Syntax ==
 <syntaxhighlight lang="lua">
-createScreenshot(filename, {flags=1, clear})
+createScreenshot(filename, flags)
 </syntaxhighlight>

← Older revision		Revision as of 11:55, 2 May 2023
Line 1:		Line 1:
−	~~{\| class="toccolours mw-collapsible mw-collapsed ts"~~
−	\|-
−	~~! Function History~~
−	\|-
−	~~\| Available since v3.7~~
−	\|}
−
−
	Create a screenshot to be used for the next savegame or to save into an external folder as a .png file.		Create a screenshot to be used for the next savegame or to save into an external folder as a .png file.

@@ Line 7: / Line 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.
+Create a screenshot to be used for the next savegame or to save into an external folder as a .png file.
-Syntax:
+== Syntax ==
-<syntaxhighlight>
+<syntaxhighlight lang="lua">
-createScreenshot("filename", {flags=1, clear})
+createScreenshot(filename, {flags=1, clear})
 </syntaxhighlight>
-Example 1: basic save screenshot to x folder (if a file with the same name exists: it will be automatically overwritten)
+== Parameters ==
-Example 2: save screenshot to x folder with both file name + time stamp
+{| class="ts"
-<syntaxhighlight>
+|-
--- add this as an execute script action inside of a key input; change "filename to whatever you like
+! style="width:15%" | Parameter
-Example 3: save screenshot to x folder with time stamp only
+== Return values ==
--- save to "screenshots" folder as "(date)_(time).png"
+none
-<span class="bold underline">Arguments</span>
+-- save to "screenshots" folder with current timestamp as "filename_(date)_(time).png"
-<span class="bold">clr/clear</span>: bool <br/>
+'''Example 3:''' Clear the previously saved savegame screenshot
-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, every time the scene is changed from a playable scene to a menu.
+<syntaxhighlight lang="lua">
+createScreenshot("", {flags=1, clear = true})
+</syntaxhighlight>
-<span class="bold underline">Return</span>
+{{toc}}

← Older revision	Revision as of 11:14, 2 May 2023
(No difference)

← Older revision		Revision as of 23:50, 3 November 2014
Line 57:		Line 57:

	none		none
−	~~{{toc}}~~

@@ Line 1: / Line 1: @@
 {| class="toccolours mw-collapsible mw-collapsed ts"
 |-
-|! Function History
+! Function History
 |-
 | Available since v3.7

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+{| class="toccolours mw-collapsible mw-collapsed tbl-ds"
-<span class="bold">Command History</span>
+|-
-<div class="mw-collapsible-content">
+|! Function History
-<div class="alt-bg">Available since v3.7</div>
+|-
-</div></div>
+| Available since v3.7
@@ Line 56: / Line 57: @@
 none