Difference between revisions of "Player Commands"

Revision as of 18:21, 8 March 2013

This is an index list of LUA Commands; exclusively for using with Visionaire Studio!
Inside each page: you will find information, syntax & working examples for each command.

Command	Description
♠ createScreenshot()	Save a screenshot to a folder or use stored screenshot for next save game image (n/f)
♠ getCursorPos()	Check current x,y position of mouse cursor
♠ getProperty()	Check various OS properties such as platform, language etc (n/f)
♠ getSoundId()	Obtain integer value of currently linked sound file (if sound is playing) (n/f)
♠ getSoundProperty() \| Check current property values of linked sound (if playing) such as: volume, balance, offset & loop (n/f)
♠ getSteamAchievement()	Check x steam achievement condition value (n/f)
♠ getSteamStat()	Check x steam statistic for your game (n/f)
♠ getVolume()	Check volume levels for: music, sound, speech, movies & global
♠ registerEventHandler()	Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc (n/f)
♠ registerHookFunction()	Set displayed & action text positions (n/f)
♠ resetSteamStats()	Reset x steam statistic for your game (n/f)
♠ setCursorPos()	Set mouse cursor to whatever x,y position you declare
♠ setSoundProperty()	Set the property values of a linked sound (via id) such as volume, balance, offset & loop (n/f)
♠ setSteamAchievement()	(n/f)
♠ setSteamStat()	(n/f)
♠ setVolume()	Set the volume levels for: music, sound, speech, movies & global
♠ setWindowTitle()	Set a custom title in the application title bar (window mode only)
♠ startAction()	Perform a linked "called by other action"
♠ startAnimation()	Load & play a linked animation
♠ startDefaultBrowser()	Launch your default internet browser / open new tab & load the included url
♠ startSound()	Play a linked sound; includes optional properties: volume, balance, offset & loop (n/f)
♠ stopAction()	Stop a linked "called by other action" - if action is not active, then do nothing
♠ stopAnimation()	Stop a linked animation; if animation is not playing, then do nothing
♠ stopSound()	Stop a linked sound (via id); if sound is not playing, then do nothing (n/f)
♠ toggleSoundPause()	Toggle currently playing sound (via id) (n/f)

日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский

@@ Line 1: / Line 1: @@
 This is an index list of LUA Commands; exclusively for using with Visionaire Studio! <br/>
-Inside each page: you will find information, syntax & examples for each command.
+Inside each page: you will find information, syntax & working examples for each command.
-----
-♠ [[createScreenshot|createScreenshot()]] <br/>
-♠ [[getCursorPos|getCursorPos()]] <br/>
+{| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"
-♠ [[getProperty|getProperty()]] -- finished? (need to test system_language example) <br/>
+|-
-♠ [[getSoundId|getSoundId()]] -- not finished! (needs an example) <br/>
+| style="border-bottom: 1px dashed darkgrey" | <b>Command</b> || style="border-bottom: 1px dashed darkgrey" | <b>Description</b>
-♠ [[getSoundProperty|getSoundProperty()]] -- not finished! (needs an example) <br/>
+|-
-♠ [[getSteamAchievement|getSteamAchievement()]] -- not finished! (needs an example) <br/>
+| ♠ [[createScreenshot|createScreenshot()]] || Save a screenshot to a folder or use stored screenshot for next save game image (n/f)
-♠ [[getSteamStat|getSteamStat()]] -- not finished! (needs an example) <br/>
+|-
-♠ [[getVolume|getVolume()]] <br/>
+| ♠ [[getCursorPos|getCursorPos()]] || Check current x,y position of mouse cursor
-♠ [[registerEventHandler|registerEventHandler()]] -- not finished! (additional event listener examples to add) <br/>
+|-
-♠ [[registerHookFunction|registerHookFunction()]] -- not finished! (event listener/handler examples to add) <br/>
+| ♠ [[getProperty|getProperty()]] || Check various OS properties such as platform, language etc (n/f)
-♠ [[resetSteamStats|resetSteamStats()]] -- not finished! (needs an example) <br/>
+|-
-♠ [[setCursorPos|setCursorPos()]] <br/>
+| ♠ [[getSoundId|getSoundId()]] || Obtain integer value of currently linked sound file (if sound is playing) (n/f)
-♠ [[setSoundProperty|setSoundProperty()]] -- not finished! (needs an example) <br/>
+|-
-♠ [[setSteamAchievement|setSteamAchievement()]] -- not finished! (needs an example) <br/>
+| ♠ [[getSoundProperty|getSoundProperty()]] | Check current property values of linked sound (if playing) such as: volume, balance, offset & loop (n/f)
-♠ [[setSteamStat|setSteamStat()]] -- not finished! (needs an example) <br/>
+|-
-♠ [[setVolume|setVolume()]] -- not finished! (example 2 needs finishing) <br/>
+| ♠ [[getSteamAchievement|getSteamAchievement()]] || Check x steam achievement condition value (n/f)
-♠ [[setWindowTitle|setWindowTitle()]] <br/>
+|-
-♠ [[startAction|startAction()]] <br/>
+| ♠ [[getSteamStat|getSteamStat()]] || Check x steam statistic for your game (n/f)
-♠ [[startAnimation|startAnimation()]] <br/>
+|-
-♠ [[startDefaultBrowser|startDefaultBrowser()]] <br/>
+| ♠ [[getVolume|getVolume()]] || Check volume levels for: music, sound, speech, movies & global
-♠ [[startSound|startSound()]] -- not finished! (needs an example) <br/>
+|-
-♠ [[stopAction|stopAction()]] <br/>
+| ♠ [[registerEventHandler|registerEventHandler()]] || Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc (n/f)
-♠ [[stopAnimation|stopAnimation()]] <br/>
+|-
-♠ [[stopSound|stopSound()]] -- not finished! (needs an example) <br/>
+| ♠ [[registerHookFunction|registerHookFunction()]] || Set displayed & action text positions (n/f)
-♠ [[toggleSoundPause|toggleSoundPause()]] -- not finished! (needs an example) <br/>
+|-
+| ♠ [[resetSteamStats|resetSteamStats()]] || Reset x steam statistic for your game (n/f)
+|-
+| ♠ [[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)
+|-
+| ♠ [[setSteamAchievement|setSteamAchievement()]] || (n/f)
+|-
+| ♠ [[setSteamStat|setSteamStat()]] || (n/f)
+|-
+| ♠ [[setVolume|setVolume()]] || Set the volume levels for: music, sound, speech, movies & global
+|-
+| ♠ [[setWindowTitle|setWindowTitle()]] || Set a custom title in the application title bar (window mode only)
+|-
+| ♠ [[startAction|startAction()]] || Perform a linked "called by other action"
+|-
+| ♠ [[startAnimation|startAnimation()]] || Load & play a linked animation
+|-
+| ♠ [[startDefaultBrowser|startDefaultBrowser()]] || Launch your default internet browser / open new tab & load the included url
+|-
+| ♠ [[startSound|startSound()]] || Play a linked sound; includes optional properties: volume, balance, offset & loop (n/f)
+|-
+| ♠ [[stopAction|stopAction()]] || Stop a linked "called by other action" - if action is not active, then do nothing
+|-
+| ♠ [[stopAnimation|stopAnimation()]] || Stop a linked animation; if animation is not playing, then do nothing
+|-
+| ♠ [[stopSound|stopSound()]] || Stop a linked sound (via id); if sound is not playing, then do nothing (n/f)
+|-
+| ♠ [[toggleSoundPause|toggleSoundPause()]] || Toggle currently playing sound (via id) (n/f)
+|}
 {{i18n|Player_Commands}}