Difference between revisions of "Player Commands"

From The Official Visionaire Studio: Adventure Game Engine Wiki
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]]
| ♠ [[registerHookFunction|registerHookFunction()]] || Set displayed & action text positions (n/f)
 
|-
 
| ♠ [[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
 
|-
 
| ♠ [[setSteamAchievement|setSteamAchievement()]] || Set condition value of x steam achievement (n/f)
 
|-
 
| ♠ [[setSteamStat|setSteamStat()]] || Set value of x steam statistic (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
 
|-
 
| ♠ [[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
 
|-
 
| ♠ [[toggleSoundPause|toggleSoundPause()]] || Toggle currently playing sound (via id)
 
|}
 
{{i18n|Player_Commands}}
 

Revision as of 14:55, 26 November 2013