CreateScreenshot - Revision history

EK: Redirected page to Global Command: createScreenshot

2023-05-19T11:23:47Z

Redirected page to Global Command: createScreenshot

Vis apiuser at 20:27, 30 September 2014

2014-09-30T20:27:46Z

Vis apiuser at 13:56, 26 November 2013

2013-11-26T13:56:24Z

Vis apiuser at 13:54, 26 November 2013

2013-11-26T13:54:51Z

David Stoffel at 17:24, 22 November 2013

2013-11-22T17:24:08Z

David Stoffel at 17:23, 22 November 2013

2013-11-22T17:23:40Z

David Stoffel at 16:49, 22 November 2013

2013-11-22T16:49:53Z

David Stoffel at 16:49, 22 November 2013

2013-11-22T16:49:21Z

Vis apiuser at 16:11, 22 November 2013

2013-11-22T16:11:43Z

AFRLme at 15:27, 2 April 2013

2013-04-02T15:27:16Z

← Older revision		Revision as of 11:23, 19 May 2023
Line 1:		Line 1:
−	~~==createScreenshot==~~	+	#REDIRECT [[Global Command: createScreenshot]]
−
−	~~<div class="command-min-version-info">Available since: <span class="command-min-version">v3.7</span></div>~~
−
−	~~<div class="command-doc">Creates a new screenshot which is either used for a savegame or stored to a file.</div>~~
−
−	~~Lua Syntax~~:
−	~~<pre class="command-syntax">~~createScreenshot~~( [saveTo~~]~~, {flags=1,~~
−	~~clear = true\|false})</pre>~~
−	~~===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.~~
−	~~===Examples===~~
−	~~Example 1: basic save screenshot (if a file with the same name exists it will be automatically overwritten)~~
−	~~<syntaxhighlight>~~
−	~~-- save to "screenshots" folder as "filename.png"~~
−	~~createScreenshot("screenshots/filename.png")~~
−
−	~~</syntaxhighlight>~~
−	~~Example 2: save screenshot with both file name + time stamp~~
−	~~<syntaxhighlight>~~
−	~~-- add this as an execute script action inside of a key input; change filename to whatever you like~~
−
−	~~-- save to "screenshots" folder as "filename_(date)_(time).png~~
−	~~local time = os.date("%Y-%m-%d_%Hh-%Mm-%Ss")~~
−	~~createScreenshot("screenshots/filename_" .. time .. ".png")~~
−	~~</syntaxhighlight>~~

← Older revision		Revision as of 20:27, 30 September 2014
Line 32:		Line 32:
	createScreenshot("screenshots/filename_" .. time .. ".png")		createScreenshot("screenshots/filename_" .. time .. ".png")
	</syntaxhighlight>		</syntaxhighlight>
−	~~[[Category:Player Commands]]~~

← Older revision		Revision as of 13:56, 26 November 2013
Line 32:		Line 32:
	createScreenshot("screenshots/filename_" .. time .. ".png")		createScreenshot("screenshots/filename_" .. time .. ".png")
	</syntaxhighlight>		</syntaxhighlight>
		+	[[Category:Player Commands]]

← Older revision		Revision as of 13:54, 26 November 2013
Line 32:		Line 32:
	createScreenshot("screenshots/filename_" .. time .. ".png")		createScreenshot("screenshots/filename_" .. time .. ".png")
	</syntaxhighlight>		</syntaxhighlight>
−
−	~~[[Category:Player Commands]]~~

← Older revision		Revision as of 17:24, 22 November 2013
Line 33:		Line 33:
	</syntaxhighlight>		</syntaxhighlight>

−	[[Category:Player Commands~~\|test~~]]	+	[[Category:Player Commands]]

← Older revision		Revision as of 17:23, 22 November 2013
Line 33:		Line 33:
	</syntaxhighlight>		</syntaxhighlight>

−	[[Category:Player Commands]]	+	[[Category:Player Commands\|test]]

← Older revision		Revision as of 16:49, 22 November 2013
Line 33:		Line 33:
	</syntaxhighlight>		</syntaxhighlight>

−	[[Category:~~Playercommands~~]]	+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
+==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.
+<div class="command-doc">Creates a new screenshot which is either used for a savegame or stored to a file.</div>
-Syntax:
+: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.
 <syntaxhighlight>
-createScreenshot("filename", {flags=1, clear})
+-- save to "screenshots" folder as "filename.png"
-</syntaxhighlight>
+createScreenshot("screenshots/filename.png")
 </syntaxhighlight>
 Example 2: save screenshot with both file name + time stamp
 <syntaxhighlight>
--- add this as an execute script action inside of a key input; change "filename to whatever you like!
+-- add this as an execute script action inside of a key input; change filename to whatever you like
--- save to "screenshots" folder as "filename_(date)_(time).png"!
+-- save to "screenshots" folder as "filename_(date)_(time).png
 local time = os.date("%Y-%m-%d_%Hh-%Mm-%Ss")
 createScreenshot("screenshots/filename_" .. time .. ".png")
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+<div class="toccolours mw-collapsible mw-collapsed tbl-ds">
-<b>Command History</b>
+<span class="bold">Command History</span>
 <div class="mw-collapsible-content">
-<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
+<div class="alt-bg">Available since v3.7</div>
 </div></div>
@@ Line 41: / Line 41: @@
-<b><u>Arguments</u></b>
+<span class="bold underline">Arguments</span>
-<b>filename</b>: "string" <br/>
+<span class="bold">filename</span>: "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.
-<b><u>Flags</u></b>
+<span class="bold underline">Flags</span>
-<b>clr/clear</b>: bool <br/>
+<span class="bold">clr/clear</span>: bool <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.
-<b><u>Return</u></b>
+<span class="bold underline">Return</span>
 none
 {{i18n|CreateScreenshot}}