|
|
| (3 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| − | This is an index list of LUA Commands; exclusively for using with Visionaire Studio! <br/>
| + | #REDIRECT [[Global Commands]] |
| − | Inside each page: you will find information, syntax & working examples for each command.
| |
| − | | |
| − | | |
| − | {| class="tbl-ds"
| |
| − | |-
| |
| − | | style="border-bottom: 1px dashed darkgrey" | <b>Command</b> || style="border-bottom: 1px dashed darkgrey" | <b>Description</b>
| |
| − | |-
| |
| − | | ♠ [[createScreenshot|createScreenshot()]] || Save a screenshot to a folder or use stored screenshot for next save game image
| |
| − | |-
| |
| − | | ♠ [[getCursorPos|getCursorPos()]] || Check current x,y position of mouse cursor
| |
| − | |-
| |
| − | | ♠ [[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
| |
| − | |-
| |
| − | | ♠ [[getSteamAchievement|getSteamAchievement()]] || Check x steam achievement condition value (n/f)
| |
| − | |-
| |
| − | | ♠ [[getSteamStat|getSteamStat()]] || Check x steam statistic for your game (n/f)
| |
| − | |-
| |
| − | | ♠ [[getTime|getTime()]] || Developer command for checking time between 2 points; can be re-purposed into a crude delay or loop function
| |
| − | |-
| |
| − | | ♠ [[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
| |
| − | |-
| |
| − | | ♠ [[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}}
| |
