Difference between revisions of "Player Commands"
From The Official Visionaire Studio: Adventure Game Engine Wiki
| Line 11: | Line 11: | ||
| ♠ [[getCursorPos|getCursorPos()]] || Check current x,y position of mouse cursor | | ♠ [[getCursorPos|getCursorPos()]] || Check current x,y position of mouse cursor | ||
|- | |- | ||
| − | | ♠ [[getProperty|getProperty()]] || Check various OS properties such as platform, language etc | + | | ♠ [[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) | | ♠ [[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 | + | | ♠ [[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) | | ♠ [[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 | | ♠ [[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 | + | | ♠ [[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) | | ♠ [[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 | | ♠ [[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 | + | | ♠ [[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) | | ♠ [[setSteamAchievement|setSteamAchievement()]] || Set condition value of x steam achievement (n/f) | ||
Revision as of 14:18, 4 April 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 |
| ♠ getCursorPos() | Check current x,y position of mouse cursor |
| ♠ getProperty() | Check various OS properties such as platform, language etc |
| ♠ getSoundId() | Obtain integer value of currently linked sound file (if sound is playing) |
| ♠ getSoundProperty() | Check current property values of linked sound (if playing) such as: volume, balance, offset & loop |
| ♠ getSteamAchievement() | Check x steam achievement condition value (n/f) |
| ♠ getSteamStat() | Check x steam statistic for your game (n/f) |
| ♠ getTime() | Developer command for checking time between 2 points; can be re-purposed into a crude delay or loop function |
| ♠ 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 |
| ♠ 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 |
| ♠ setSteamAchievement() | Set condition value of x steam achievement (n/f) |
| ♠ setSteamStat() | Set value of x steam statistic (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 |
| ♠ 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 |
| ♠ toggleSoundPause() | Toggle currently playing sound (via id) |
