Player Commands: Difference between revisions
From The Official Visionaire Studio: Adventure Game Engine Wiki
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
This is an index list of LUA Commands; exclusively for using with Visionaire Studio! <br/> | 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()]] | |||
♠ [[getCursorPos|getCursorPos()]] | {| style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%" | ||
♠ [[getProperty|getProperty()]] | |- | ||
♠ [[getSoundId|getSoundId()]] | | style="border-bottom: 1px dashed darkgrey" | <b>Command</b> || style="border-bottom: 1px dashed darkgrey" | <b>Description</b> | ||
♠ [[getSoundProperty|getSoundProperty()]] | |- | ||
♠ [[getSteamAchievement|getSteamAchievement()]] | | ♠ [[createScreenshot|createScreenshot()]] || Save a screenshot to a folder or use stored screenshot for next save game image (n/f) | ||
♠ [[getSteamStat|getSteamStat()]] | |- | ||
♠ [[getVolume|getVolume()]] | | ♠ [[getCursorPos|getCursorPos()]] || Check current x,y position of mouse cursor | ||
♠ [[registerEventHandler|registerEventHandler()]] | |- | ||
♠ [[registerHookFunction|registerHookFunction()]] | | ♠ [[getProperty|getProperty()]] || Check various OS properties such as platform, language etc (n/f) | ||
♠ [[resetSteamStats|resetSteamStats()]] | |- | ||
♠ [[setCursorPos|setCursorPos()]] | | ♠ [[getSoundId|getSoundId()]] || Obtain integer value of currently linked sound file (if sound is playing) (n/f) | ||
♠ [[setSoundProperty|setSoundProperty()]] | |- | ||
♠ [[setSteamAchievement|setSteamAchievement()]] | | ♠ [[getSoundProperty|getSoundProperty()]] | Check current property values of linked sound (if playing) such as: volume, balance, offset & loop (n/f) | ||
♠ [[setSteamStat|setSteamStat()]] | |- | ||
♠ [[setVolume|setVolume()]] - | | ♠ [[getSteamAchievement|getSteamAchievement()]] || Check x steam achievement condition value (n/f) | ||
♠ [[setWindowTitle|setWindowTitle()]] | |- | ||
♠ [[startAction|startAction()]] | | ♠ [[getSteamStat|getSteamStat()]] || Check x steam statistic for your game (n/f) | ||
♠ [[startAnimation|startAnimation()]] | |- | ||
♠ [[startDefaultBrowser|startDefaultBrowser()]] | | ♠ [[getVolume|getVolume()]] || Check volume levels for: music, sound, speech, movies & global | ||
♠ [[startSound|startSound()]] | |- | ||
♠ [[stopAction|stopAction()]] | | ♠ [[registerEventHandler|registerEventHandler()]] || Create loops, listen out for various events; such as mouse actions, action/text started/stopped etc (n/f) | ||
♠ [[stopAnimation|stopAnimation()]] | |- | ||
♠ [[stopSound|stopSound()]] | | ♠ [[registerHookFunction|registerHookFunction()]] || Set displayed & action text positions (n/f) | ||
♠ [[toggleSoundPause|toggleSoundPause()]] | |- | ||
| ♠ [[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}} | {{i18n|Player_Commands}} | ||
Revision as of 17: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) |