Difference between revisions of "Global Commands"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Created page with "This is a list of global commands available in Visionaire Studio. == General commands == * createScreenshot * Global Command: createSp...")
 
Line 1: Line 1:
 
This is a list of global commands available in Visionaire Studio.
 
This is a list of global commands available in Visionaire Studio.
  
−
== General commands ==
+
== General ==
  
−
* [[Global Command: createScreenshot|createScreenshot]]
+
{| class="ts"
−
* [[Global Command: createSprite|createSprite]]
+
|-
−
* [[Global Command: getCursorPos|getCursorPos]]
+
! style="width:20%" | Function Name
−
* [[Global Command: getObject|getObject]]
+
! Description
−
* [[Global Command: getProperty|getProperty]]
+
|-
−
* [[Global Command: getTime|getTime]]
+
| [[Global Command: createScreenshot|createScreenshot]]
−
* [[Global Command: isPointInsidePolygon|isPointInsidePolygon]]
+
| tbd
−
* [[Global Command: replaceGame|replaceGame]]
+
|-
−
* [[Global Command: setCursorPos|setCursorPos]]
+
| [[Global Command: createSprite|createSprite]]
−
* [[Global Command: setDelay|setDelay]]
+
| tbd
−
* [[Global Command: sha1|sha1]]
+
|-
−
* [[Global Command: startAction|startAction]]
+
| [[Global Command: getCursorPos|getCursorPos]]
−
* [[Global Command: startAnimation|startAnimation]]
+
| tbd
−
* [[Global Command: startDefaultBrowser|startDefaultBrowser]]
+
|-
−
* [[Global Command: startObjectTween|startObjectTween]]
+
| [[Global Command: getObject|getObject]]
−
* [[Global Command: startTween|startTween]]
+
| tbd
−
* [[Global Command: stopAction|stopAction]]
+
|-
−
* [[Global Command: stopAnimation|stopAnimation]]
+
| [[Global Command: getProperty|getProperty]]
 +
| tbd
 +
|-
 +
| [[Global Command: getTime|getTime]]
 +
| tbd
 +
|-
 +
| [[Global Command: isPointInsidePolygon|isPointInsidePolygon]]
 +
| tbd
 +
|-
 +
| [[Global Command: replaceGame|replaceGame]]
 +
| tbd
 +
|-
 +
| [[Global Command: setCursorPos|setCursorPos]]
 +
| tbd
 +
|-
 +
| [[Global Command: setDelay|setDelay]]
 +
| tbd
 +
|-
 +
| [[Global Command: sha1|sha1]]
 +
| tbd
 +
|-
 +
| [[Global Command: startAction|startAction]]
 +
| tbd
 +
|-
 +
| [[Global Command: startAnimation|startAnimation]]
 +
| tbd
 +
|-
 +
| [[Global Command: startDefaultBrowser|startDefaultBrowser]]
 +
| tbd
 +
|-
 +
| [[Global Command: startObjectTween|startObjectTween]]
 +
| tbd
 +
|-
 +
| [[Global Command: startTween|startTween]]
 +
| tbd
 +
|-
 +
| [[Global Command: stopAction|stopAction]]
 +
| tbd
 +
|-
 +
| [[Global Command: stopAnimation|stopAnimation]]
 +
| tbd
 +
|}
  
  
−
== Window ==
+
== Sound & Volume ==
  
−
* [[Global Command: getWindowBrightness|getWindowBrightness]]
+
{| class="ts"
−
* [[Global Command: getWindowMode|getWindowMode]]
+
|-
−
* [[Global Command: setWindowBrightness|setWindowBrightness]]
+
! style="width:20%" | Function Name
−
* [[Global Command: setWindowSize|setWindowSize]]
+
! Description
−
* [[Global Command: setWindowTitle|setWindowTitle]]
+
|-
−
* [[Global Command: toggleWindowMode|toggleWindowMode]]
+
| [[Global Command: getSoundId|getSoundId]]
 +
| tbd
 +
|-
 +
| [[Global Command: getSoundProperty|getSoundProperty]]
 +
| tbd
 +
|-
 +
| [[Global Command: getVolume|getVolume]]
 +
| tbd
 +
|-
 +
| [[Global Command: setSoundProperty|setSoundProperty]]
 +
| tbd
 +
|-
 +
| [[Global Command: setVolume|setVolume]]
 +
| tbd
 +
|-
 +
| [[Global Command: startSound|startSound]]
 +
| tbd
 +
|-
 +
| [[Global Command: stopSound|stopSound]]
 +
| tbd
 +
|-
 +
| [[Global Command: toggleSoundPause|toggleSoundPause]]
 +
| tbd
 +
|}
  
  
−
== Sound & Volume ==
+
== Events & Hooks ==
  
−
* [[Global Command: getSoundId|getSoundId]]
+
{| class="ts"
−
* [[Global Command: getSoundProperty|getSoundProperty]]
+
|-
−
* [[Global Command: getVolume|getVolume]]
+
! style="width:20%" | Function Name
−
* [[Global Command: setSoundProperty|setSoundProperty]]
+
! Description
−
* [[Global Command: setVolume|setVolume]]
+
|-
−
* [[Global Command: startSound|startSound]]
+
| [[Global Command: createEvent|createEvent]]
−
* [[Global Command: stopSound|stopSound]]
+
| tbd
−
* [[Global Command: toggleSoundPause|toggleSoundPause]]
+
|-
 +
| [[Global Command: registerEventHandler|registerEventHandler]]
 +
| tbd
 +
|-
 +
| [[Global Command: registerHookFunction|registerHookFunction]]
 +
| tbd
 +
|-
 +
| [[Global Command: unregisterEventHandler|unregisterEventHandler]]
 +
| tbd
 +
|}
  
  
−
== Events & Hooks ==
+
== Window ==
  
−
* [[Global Command: createEvent|createEvent]]
+
{| class="ts"
−
* [[Global Command: registerEventHandler|registerEventHandler]]
+
|-
−
* [[Global Command: registerHookFunction|registerHookFunction]]
+
! style="width:20%" | Function Name
−
* [[Global Command: unregisterEventHandler|unregisterEventHandler]]
+
! Description
 +
|-
 +
| [[Global Command: getWindowBrightness|getWindowBrightness]]
 +
| tbd
 +
|-
 +
| [[Global Command: getWindowMode|getWindowMode]]
 +
| tbd
 +
|-
 +
| [[Global Command: setWindowBrightness|setWindowBrightness]]
 +
| tbd
 +
|-
 +
| [[Global Command: setWindowSize|setWindowSize]]
 +
| tbd
 +
|-
 +
| [[Global Command: setWindowTitle|setWindowTitle]]
 +
| tbd
 +
|-
 +
| [[Global Command: toggleWindowMode|toggleWindowMode]]
 +
| tbd
 +
|}
  
  
 
== Shaders ==
 
== Shaders ==
  
−
* [[Global Command: shaderCompile|shaderCompile]]
+
{| class="ts"
−
* [[Global Command: shaderSetOptions|shaderSetOptions]]
+
|-
−
* [[Global Command: shaderUniform|shaderUniform]]
+
! style="width:20%" | Function Name
 +
! Description
 +
|-
 +
| [[Global Command: shaderCompile|shaderCompile]]
 +
| tbd
 +
|-
 +
| [[Global Command: shaderSetOptions|shaderSetOptions]]
 +
| tbd
 +
|-
 +
| [[Global Command: shaderUniform|shaderUniform]]
 +
| tbd
 +
|}
  
  
 
== Game clients (Steam, GOG Galaxy) ==
 
== Game clients (Steam, GOG Galaxy) ==
  
−
* [[Global Command: getGameClientAchievement|getGameClientAchievement]]
+
{| class="ts"
−
* [[Global Command: getGameClientStat|getGameClientStat]]
+
|-
−
* [[Global Command: initGameClient|initGameClient]]
+
! style="width:20%" | Function Name
−
* [[Global Command: resetGameClientStats|resetGameClientStats]]
+
! Description
−
* [[Global Command: setGameClientAchievement|setGameClientAchievement]]
+
|-
−
* [[Global Command: setGameClientStat|setGameClientStat]]
+
| [[Global Command: getGameClientAchievement|getGameClientAchievement]]
 +
| tbd
 +
|-
 +
| [[Global Command: getGameClientStat|getGameClientStat]]
 +
| tbd
 +
|-
 +
| [[Global Command: initGameClient|initGameClient]]
 +
| tbd
 +
|-
 +
| [[Global Command: resetGameClientStats|resetGameClientStats]]
 +
| tbd
 +
|-
 +
| [[Global Command: setGameClientAchievement|setGameClientAchievement]]
 +
| tbd
 +
|-
 +
| [[Global Command: setGameClientStat|setGameClientStat]]
 +
| tbd
 +
|}
  
  
−
== Haptic Effects ==
+
== Haptic effects ==
  
−
* [[Global Command: createHapticEffectCondition|createHapticEffectCondition]]
+
{| class="ts"
−
* [[Global Command: createHapticEffectConstant|createHapticEffectConstant]]
+
|-
−
* [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]]
+
! style="width:20%" | Function Name
−
* [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]]
+
! Description
−
* [[Global Command: createHapticEffectRamp|createHapticEffectRamp]]
+
|-
−
* [[Global Command: startHapticEffect|startHapticEffect]]
+
| [[Global Command: createHapticEffectCondition|createHapticEffectCondition]]
−
* [[Global Command: startHapticRumble|startHapticRumble]]
+
| tbd
−
* [[Global Command: stopHapticEffect|stopHapticEffect]]
+
|-
−
* [[Global Command: stopHapticRumble|stopHapticRumble]]
+
| [[Global Command: createHapticEffectConstant|createHapticEffectConstant]]
 +
| tbd
 +
|-
 +
| [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]]
 +
| tbd
 +
|-
 +
| [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]]
 +
| tbd
 +
|-
 +
| [[Global Command: createHapticEffectRamp|createHapticEffectRamp]]
 +
| tbd
 +
|-
 +
| [[Global Command: startHapticEffect|startHapticEffect]]
 +
| tbd
 +
|-
 +
| [[Global Command: startHapticRumble|startHapticRumble]]
 +
| tbd
 +
|-
 +
| [[Global Command: stopHapticEffect|stopHapticEffect]]
 +
| tbd
 +
|-
 +
| [[Global Command: stopHapticRumble|stopHapticRumble]]
 +
| tbd
 +
|}
  
  
 
== Debug ==
 
== Debug ==
  
−
* [[Global Command: debugerror|debugerror]]
+
{| class="ts"
−
* [[Global Command: debugfunc|debugfunc]]
+
|-
 +
! style="width:20%" | Function Name
 +
! Description
 +
|-
 +
| [[Global Command: debugerror|debugerror]]
 +
| tbd
 +
|-
 +
| [[Global Command: debugfunc|debugfunc]]
 +
| tbd
 +
|}
 
{{toc}}
 
{{toc}}

Revision as of 15:57, 2 May 2023

This is a list of global commands available in Visionaire Studio.

General

Function Name Description
createScreenshot tbd
createSprite tbd
getCursorPos tbd
getObject tbd
getProperty tbd
getTime tbd
isPointInsidePolygon tbd
replaceGame tbd
setCursorPos tbd
setDelay tbd
sha1 tbd
startAction tbd
startAnimation tbd
startDefaultBrowser tbd
startObjectTween tbd
startTween tbd
stopAction tbd
stopAnimation tbd


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


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