Player Commands - Revision history

EK: Redirected page to Global Commands

2023-05-19T11:38:19Z

Redirected page to Global Commands

Vis apiuser at 20:41, 30 April 2015

2015-04-30T20:41:52Z

Vis apiuser at 20:28, 30 September 2014

2014-09-30T20:28:22Z

Vis apiuser at 13:55, 26 November 2013

2013-11-26T13:55:39Z

AFRLme at 12:18, 4 April 2013

2013-04-04T12:18:24Z

AFRLme at 21:26, 30 March 2013

2013-03-30T21:26:15Z

AFRLme at 18:41, 16 March 2013

2013-03-16T18:41:49Z

AFRLme at 14:02, 15 March 2013

2013-03-15T14:02:16Z

AFRLme at 13:26, 12 March 2013

2013-03-12T13:26:05Z

AFRLme at 19:09, 11 March 2013

2013-03-11T19:09:56Z

← Older revision		Revision as of 11:38, 19 May 2023
Line 1:		Line 1:
−	*[[~~createScreenshot]]~~	+	#REDIRECT [[Global Commands]]
−	*[[getCursorPos]]
−	*[[getGameClientAchievement]]
−	*[[getGameClientStat]]
−	*[[getProperty]]
−	*[[getSoundId]]
−	*[[getSoundProperty]]
−	*[[getVolume]]
−	*[[getWindowBrightness]]
−	*[[getWindowMode]]
−	*[[initGameClient]]
−	*[[isPointInsidePolygon]]
−	*[[registerEventHandler]]
−	*[[registerHookFunction]]
−	*[[replaceGame]]
−	*[[resetGameClientStats]]
−	*[[setCursorPos]]
−	*[[setGameClientAchievement]]
−	*[[setGameClientStat]]
−	*[[setSoundProperty]]
−	*[[setVolume]]
−	*[[setWindowBrightness]]
−	*[[setWindowSize]]
−	*[[setWindowTitle]]
−	*[[shaderCompile]]
−	*[[shaderSetOptions]]
−	*[[shaderUniform]]
−	*[[startAction]]
−	*[[startAnimation]]
−	*[[startDefaultBrowser]]
−	*[[startObjectTween]]
−	*[[startSound]]
−	*[[startTween]]
−	*[[stopAction]]
−	*[[stopAnimation]]
−	*[[stopSound]]
−	*[[toggleSoundPause]]
−	*[[toggleWindowMode]]
−	*[[unregisterEventHandler]]

@@ Line 1: / Line 1: @@
 *[[createScreenshot]]
 *[[getCursorPos]]
 *[[getProperty]]
 *[[getSoundId]]
 *[[getSoundProperty]]
 *[[getVolume]]
 *[[getWindowBrightness]]
 *[[registerEventHandler]]
 *[[registerHookFunction]]
 *[[replaceGame]]
-*[[resetSteamStats]]
+*[[resetGameClientStats]]
 *[[setCursorPos]]
 *[[setSoundProperty]]
 *[[setVolume]]
 *[[setWindowBrightness]]
 *[[setWindowTitle]]
 *[[shaderCompile]]
@@ Line 32: / Line 36: @@
 *[[stopSound]]
 *[[toggleSoundPause]]
 *[[unregisterEventHandler]]

@@ Line 10: / Line 10: @@
 *[[registerEventHandler]]
 *[[registerHookFunction]]
 *[[resetSteamStats]]
 *[[setCursorPos]]
@@ Line 18: / Line 19: @@
 *[[setWindowBrightness]]
 *[[setWindowTitle]]
 *[[startAction]]
 *[[startAnimation]]
 *[[startDefaultBrowser]]
 *[[startSound]]
 *[[stopAction]]
 *[[stopAnimation]]

@@ Line 1: / Line 1: @@
-This is an index list of LUA Commands; exclusively for using with Visionaire Studio! <br/>
+*[[createScreenshot]]
-Inside each page: you will find information, syntax & working examples for each command.
+*[[getCursorPos]]
+*[[getProperty]]
+*[[getSoundId]]
-{| class="tbl-ds"
+*[[getSoundProperty]]
-|-
+*[[getSteamAchievement]]
-| style="border-bottom: 1px dashed darkgrey" | <b>Command</b> || style="border-bottom: 1px dashed darkgrey" | <b>Description</b>
+*[[getSteamStat]]
-|-
+*[[getVolume]]
-| ♠ [[createScreenshot|createScreenshot()]] || Save a screenshot to a folder or use stored screenshot for next save game image
+*[[getWindowBrightness]]
-|-
+*[[registerEventHandler]]
-| ♠ [[getCursorPos|getCursorPos()]] || Check current x,y position of mouse cursor
+*[[registerHookFunction]]
-|-
+*[[resetSteamStats]]
-| ♠ [[getProperty|getProperty()]] || Check various OS properties such as platform, language etc
+*[[setCursorPos]]
-|-
+*[[setSoundProperty]]
-| ♠ [[getSoundId|getSoundId()]] || Obtain integer value of currently linked sound file (if sound is playing)
+*[[setSteamAchievement]]
-|-
+*[[setSteamStat]]
-| ♠ [[getSoundProperty|getSoundProperty()]] || Check current property values of linked sound (if playing) such as: volume, balance, offset & loop
+*[[setVolume]]
-|-
+*[[setWindowBrightness]]
-| ♠ [[getSteamAchievement|getSteamAchievement()]] || Check x steam achievement condition value (n/f)
+*[[setWindowTitle]]
-|-
+*[[startAction]]
-| ♠ [[getSteamStat|getSteamStat()]] || Check x steam statistic for your game (n/f)
+*[[startAnimation]]
-|-
+*[[startDefaultBrowser]]
-| ♠ [[getTime|getTime()]] || Developer command for checking time between 2 points; can be re-purposed into a crude delay or loop function
+*[[startSound]]
-|-
+*[[stopAction]]
-| ♠ [[getVolume|getVolume()]] || Check volume levels for: music, sound, speech, movies & global
+*[[stopAnimation]]
-|-
+*[[stopSound]]
-| ♠ [[registerEventHandler|registerEventHandler()]] || Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc
+*[[toggleSoundPause]]
-|-
+*[[unregisterEventHandler]]

@@ Line 11: / Line 11: @@
 | ♠ [[getCursorPos|getCursorPos()]] || Check current x,y position of mouse cursor
 |-
-| ♠ [[getProperty|getProperty()]] || Check various OS properties such as platform, language etc (n/f)
+| ♠ [[getProperty|getProperty()]] || Check various OS properties such as platform, language etc
 |-
 | ♠ [[getSoundId|getSoundId()]] || Obtain integer value of currently linked sound file (if sound is playing)
 |-
-| ♠ [[getSoundProperty|getSoundProperty()]] || Check current property values of linked sound (if playing) such as: volume, balance, offset & loop (n/f)
+| ♠ [[getSoundProperty|getSoundProperty()]] || Check current property values of linked sound (if playing) such as: volume, balance, offset & loop
 |-
 | ♠ [[getSteamAchievement|getSteamAchievement()]] || Check x steam achievement condition value (n/f)
@@ Line 25: / Line 25: @@
 | ♠ [[getVolume|getVolume()]] || Check volume levels for: music, sound, speech, movies & global
 |-
-| ♠ [[registerEventHandler|registerEventHandler()]] || Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc (n/f)
+| ♠ [[registerEventHandler|registerEventHandler()]] || Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc
 |-
 | ♠ [[registerHookFunction|registerHookFunction()]] || Set displayed & action text positions (n/f)
@@ Line 33: / Line 33: @@
 | ♠ [[setCursorPos|setCursorPos()]] || Set mouse cursor to whatever x,y position you declare
 |-
-| ♠ [[setSoundProperty|setSoundProperty()]] || Set the property values of a linked sound (via id) such as volume, balance, offset & loop (n/f)
+| ♠ [[setSoundProperty|setSoundProperty()]] || Set the property values of a linked sound (via id) such as volume, balance, offset & loop
 |-
 | ♠ [[setSteamAchievement|setSteamAchievement()]] || Set condition value of x steam achievement (n/f)

@@ Line 3: / Line 3: @@
-{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
+{| style="background: #f5f5f5; border: 1px dashed darkgrey" width="100%"
 |-
 | style="border-bottom: 1px dashed darkgrey" | <b>Command</b> || style="border-bottom: 1px dashed darkgrey" | <b>Description</b>

@@ Line 13: / Line 13: @@
 | ♠ [[getProperty|getProperty()]] || Check various OS properties such as platform, language etc (n/f)
 |-
-| ♠ [[getSoundId|getSoundId()]] || Obtain integer value of currently linked sound file (if sound is playing) (n/f)
+| ♠ [[getSoundId|getSoundId()]] || Obtain integer value of currently linked sound file (if sound is playing)
 |-
 | ♠ [[getSoundProperty|getSoundProperty()]] || Check current property values of linked sound (if playing) such as: volume, balance, offset & loop (n/f)
@@ Line 57: / Line 57: @@
 | ♠ [[stopSound|stopSound()]] || Stop a linked sound (via id); if sound is not playing, then do nothing
 |-
-| ♠ [[toggleSoundPause|toggleSoundPause()]] || Toggle currently playing sound (via id) (n/f)
+| ♠ [[toggleSoundPause|toggleSoundPause()]] || Toggle currently playing sound (via id)
 |}
 {{i18n|Player_Commands}}