Global Commands
From The Official Visionaire Studio: Adventure Game Engine Wiki
This is a list of global commands available in Visionaire Studio.
General
| Function Name | Description |
|---|---|
| createScreenshot | Create a screenshot to be used for the next savegame or to save into an external folder as a .png file. |
| createSprite | tbd |
| getCursorPos | Get the current position of the mouse cursor. |
| getObject | Get a Visionaire object. |
| getProperty | Get the requested game property. |
| getTime | Returns the number of milliseconds since the "getTime()" function was first called or since the timer was reset. |
| isPointInsidePolygon | Test if a point lies inside a polygon. |
| replaceGame | Replaces the Visionaire game file and starts the game from the beginning. |
| setCursorPos | Sets the mouse cursor to the {x,y} position provided. |
| setDelay | Executes a function with a delay. |
| sha1 | Calculates the 160-bit (20-byte) SHA-1 (Secure Hash Algorithm 1) hash of a string. |
| startAction | Starts an action. |
| startAnimation | Starts an animation. |
| startDefaultBrowser | Open a URL in the user's default browser or in the steam overlay (if active). |
| startObjectTween | Start tween on a Visionaire object field. |
| startTween | Start tween on a Lua variable. |
| stopAction | Stop an active action. |
| stopAnimation | Stop a running animation. |
Sound & Volume
| Function Name | Description |
|---|---|
| getSoundId | tbd |
| getSoundProperty | tbd |
| getVolume | tbd |
| setSoundProperty | tbd |
| setVolume | tbd |
| startSound | tbd |
| stopSound | tbd |
| toggleSoundPause | tbd |
Events & Hooks
| Function Name | Description |
|---|---|
| createEvent | tbd |
| registerEventHandler | tbd |
| registerHookFunction | tbd |
| unregisterEventHandler | tbd |
Window
| Function Name | Description |
|---|---|
| getWindowBrightness | tbd |
| getWindowMode | tbd |
| setWindowBrightness | tbd |
| setWindowSize | tbd |
| setWindowTitle | tbd |
| toggleWindowMode | tbd |
Shaders
| Function Name | Description |
|---|---|
| shaderCompile | tbd |
| shaderSetOptions | tbd |
| shaderUniform | tbd |
Game clients (Steam, GOG Galaxy)
| Function Name | Description |
|---|---|
| getGameClientAchievement | tbd |
| getGameClientStat | tbd |
| initGameClient | tbd |
| resetGameClientStats | tbd |
| setGameClientAchievement | tbd |
| setGameClientStat | tbd |
Haptic effects
| Function Name | Description |
|---|---|
| createHapticEffectCondition | tbd |
| createHapticEffectConstant | tbd |
| createHapticEffectLeftRight | tbd |
| createHapticEffectPeriodic | tbd |
| createHapticEffectRamp | tbd |
| startHapticEffect | tbd |
| startHapticRumble | tbd |
| stopHapticEffect | tbd |
| stopHapticRumble | tbd |
Debug
| Function Name | Description |
|---|---|
| debugerror | tbd |
| debugfunc | tbd |