Difference between revisions of "Global Commands"

From The Official Visionaire Studio: Adventure Game Engine Wiki
Line 12: Line 12:
 
|-
 
|-
 
| [[Global Command: createSprite|createSprite]]
 
| [[Global Command: createSprite|createSprite]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: getCursorPos|getCursorPos]]
 
| [[Global Command: getCursorPos|getCursorPos]]
Line 72: Line 72:
 
|-
 
|-
 
| [[Global Command: getSoundId|getSoundId]]
 
| [[Global Command: getSoundId|getSoundId]]
−
| tbd
+
| Retrieve the id of a currently active audio file.
 
|-
 
|-
 
| [[Global Command: getSoundProperty|getSoundProperty]]
 
| [[Global Command: getSoundProperty|getSoundProperty]]
−
| tbd
+
| Retrieve various properties of a sound.
 
|-
 
|-
 
| [[Global Command: getVolume|getVolume]]
 
| [[Global Command: getVolume|getVolume]]
−
| tbd
+
| Retrieve general volume levels.
 
|-
 
|-
 
| [[Global Command: setSoundProperty|setSoundProperty]]
 
| [[Global Command: setSoundProperty|setSoundProperty]]
−
| tbd
+
| Set properties of a sound.
 
|-
 
|-
 
| [[Global Command: setVolume|setVolume]]
 
| [[Global Command: setVolume|setVolume]]
−
| tbd
+
| Set general volume levels.
 
|-
 
|-
 
| [[Global Command: startSound|startSound]]
 
| [[Global Command: startSound|startSound]]
−
| tbd
+
| Play an audio file.
 
|-
 
|-
 
| [[Global Command: stopSound|stopSound]]
 
| [[Global Command: stopSound|stopSound]]
−
| tbd
+
| Stop a playing sound.
 
|-
 
|-
 
| [[Global Command: toggleSoundPause|toggleSoundPause]]
 
| [[Global Command: toggleSoundPause|toggleSoundPause]]
−
| tbd
+
| Toggle an active sound between playing and paused states.
 
|}
 
|}
  
Line 105: Line 105:
 
|-
 
|-
 
| [[Global Command: createEvent|createEvent]]
 
| [[Global Command: createEvent|createEvent]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: registerEventHandler|registerEventHandler]]
 
| [[Global Command: registerEventHandler|registerEventHandler]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: registerHookFunction|registerHookFunction]]
 
| [[Global Command: registerHookFunction|registerHookFunction]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: unregisterEventHandler|unregisterEventHandler]]
 
| [[Global Command: unregisterEventHandler|unregisterEventHandler]]
−
| tbd
+
|  
 
|}
 
|}
  
Line 126: Line 126:
 
|-
 
|-
 
| [[Global Command: getWindowBrightness|getWindowBrightness]]
 
| [[Global Command: getWindowBrightness|getWindowBrightness]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: getWindowMode|getWindowMode]]
 
| [[Global Command: getWindowMode|getWindowMode]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: setWindowBrightness|setWindowBrightness]]
 
| [[Global Command: setWindowBrightness|setWindowBrightness]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: setWindowSize|setWindowSize]]
 
| [[Global Command: setWindowSize|setWindowSize]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: setWindowTitle|setWindowTitle]]
 
| [[Global Command: setWindowTitle|setWindowTitle]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: toggleWindowMode|toggleWindowMode]]
 
| [[Global Command: toggleWindowMode|toggleWindowMode]]
−
| tbd
+
|  
 
|}
 
|}
  
Line 153: Line 153:
 
|-
 
|-
 
| [[Global Command: shaderCompile|shaderCompile]]
 
| [[Global Command: shaderCompile|shaderCompile]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: shaderSetOptions|shaderSetOptions]]
 
| [[Global Command: shaderSetOptions|shaderSetOptions]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: shaderUniform|shaderUniform]]
 
| [[Global Command: shaderUniform|shaderUniform]]
−
| tbd
+
|  
 
|}
 
|}
  
Line 171: Line 171:
 
|-
 
|-
 
| [[Global Command: getGameClientAchievement|getGameClientAchievement]]
 
| [[Global Command: getGameClientAchievement|getGameClientAchievement]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: getGameClientStat|getGameClientStat]]
 
| [[Global Command: getGameClientStat|getGameClientStat]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: initGameClient|initGameClient]]
 
| [[Global Command: initGameClient|initGameClient]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: resetGameClientStats|resetGameClientStats]]
 
| [[Global Command: resetGameClientStats|resetGameClientStats]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: setGameClientAchievement|setGameClientAchievement]]
 
| [[Global Command: setGameClientAchievement|setGameClientAchievement]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: setGameClientStat|setGameClientStat]]
 
| [[Global Command: setGameClientStat|setGameClientStat]]
−
| tbd
+
|  
 
|}
 
|}
  
Line 198: Line 198:
 
|-
 
|-
 
| [[Global Command: createHapticEffectCondition|createHapticEffectCondition]]
 
| [[Global Command: createHapticEffectCondition|createHapticEffectCondition]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: createHapticEffectConstant|createHapticEffectConstant]]
 
| [[Global Command: createHapticEffectConstant|createHapticEffectConstant]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]]
 
| [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]]
 
| [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: createHapticEffectRamp|createHapticEffectRamp]]
 
| [[Global Command: createHapticEffectRamp|createHapticEffectRamp]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: startHapticEffect|startHapticEffect]]
 
| [[Global Command: startHapticEffect|startHapticEffect]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: startHapticRumble|startHapticRumble]]
 
| [[Global Command: startHapticRumble|startHapticRumble]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: stopHapticEffect|stopHapticEffect]]
 
| [[Global Command: stopHapticEffect|stopHapticEffect]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: stopHapticRumble|stopHapticRumble]]
 
| [[Global Command: stopHapticRumble|stopHapticRumble]]
−
| tbd
+
|  
 
|}
 
|}
  
Line 234: Line 234:
 
|-
 
|-
 
| [[Global Command: debugerror|debugerror]]
 
| [[Global Command: debugerror|debugerror]]
−
| tbd
+
|  
 
|-
 
|-
 
| [[Global Command: debugfunc|debugfunc]]
 
| [[Global Command: debugfunc|debugfunc]]
−
| tbd
+
|  
 
|}
 
|}
 
{{toc}}
 
{{toc}}

Revision as of 22:41, 4 May 2023

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
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 Retrieve the id of a currently active audio file.
getSoundProperty Retrieve various properties of a sound.
getVolume Retrieve general volume levels.
setSoundProperty Set properties of a sound.
setVolume Set general volume levels.
startSound Play an audio file.
stopSound Stop a playing sound.
toggleSoundPause Toggle an active sound between playing and paused states.


Events & Hooks

Function Name Description
createEvent
registerEventHandler
registerHookFunction
unregisterEventHandler


Window

Function Name Description
getWindowBrightness
getWindowMode
setWindowBrightness
setWindowSize
setWindowTitle
toggleWindowMode


Shaders

Function Name Description
shaderCompile
shaderSetOptions
shaderUniform


Game clients (Steam, GOG Galaxy)

Function Name Description
getGameClientAchievement
getGameClientStat
initGameClient
resetGameClientStats
setGameClientAchievement
setGameClientStat


Haptic effects

Function Name Description
createHapticEffectCondition
createHapticEffectConstant
createHapticEffectLeftRight
createHapticEffectPeriodic
createHapticEffectRamp
startHapticEffect
startHapticRumble
stopHapticEffect
stopHapticRumble


Debug

Function Name Description
debugerror
debugfunc


Retrieved from "https://wiki.visionaire-tracker.net/index.php?title=Global_Commands&oldid=11900"
  • Powered by MediaWiki