Difference between pages "Global Command: shaderSetOptions" and "Global Commands"

From The Official Visionaire Studio: Adventure Game Engine Wiki
(Difference between pages)
(Created page with "Set shader options. {| class="ts" |- | style="width:15%" | Related functions | shaderCompile | Global Command: shaderUniform|shaderUniform...")
 
 
Line 1: Line 1:
−
Set shader options.
+
This is a list of global commands available in Visionaire Studio.
 +
 
 +
== General ==
  
 
{| class="ts"
 
{| class="ts"
 
|-
 
|-
−
| style="width:15%" | Related functions
+
! style="width:20%" | Function Name
−
| [[Global Command: shaderCompile|shaderCompile]] | [[Global Command: shaderUniform|shaderUniform]]
+
! Description
 +
|-
 +
| [[Global Command: createScreenshot|createScreenshot]]
 +
| Create a screenshot to be used for the next savegame or to save into an external folder as a .png file.
 +
|-
 +
| [[Global Command: createSprite|createSprite]]
 +
|
 +
|-
 +
| [[Global Command: getCursorPos|getCursorPos]]
 +
| Get the current position of the mouse cursor.
 +
|-
 +
| [[Global Command: getObject|getObject]]
 +
| Get a Visionaire object.
 +
|-
 +
| [[Global Command: getProperty|getProperty]]
 +
| Get the requested game property.
 +
|-
 +
| [[Global Command: getTime|getTime]]
 +
| Returns the number of milliseconds since the "getTime()" function was first called or since the timer was reset.
 +
|-
 +
| [[Global Command: isPointInsidePolygon|isPointInsidePolygon]]
 +
| Test if a point lies inside a polygon.
 +
|-
 +
| [[Global Command: replaceGame|replaceGame]]
 +
| Replaces the Visionaire game file and starts the game from the beginning.
 +
|-
 +
| [[Global Command: setCursorPos|setCursorPos]]
 +
| Sets the mouse cursor to the {x,y} position provided.
 +
|-
 +
| [[Global Command: setDelay|setDelay]]
 +
| Executes a function with a delay.
 +
|-
 +
| [[Global Command: sha1|sha1]]
 +
| Calculates the 160-bit (20-byte) SHA-1 (Secure Hash Algorithm 1) hash of a string.
 +
|-
 +
| [[Global Command: startAction|startAction]]
 +
| Starts an action.
 +
|-
 +
| [[Global Command: startAnimation|startAnimation]]
 +
| Starts an animation.
 +
|-
 +
| [[Global Command: startDefaultBrowser|startDefaultBrowser]]
 +
| Open a URL in the user's default browser or in the steam overlay (if active).
 +
|-
 +
| [[Global Command: startObjectTween|startObjectTween]]
 +
| Start tween on a Visionaire object field.
 +
|-
 +
| [[Global Command: startTween|startTween]]
 +
| Start tween on a Lua variable.
 +
|-
 +
| [[Global Command: stopAction|stopAction]]
 +
| Stop an active action.
 +
|-
 +
| [[Global Command: stopAnimation|stopAnimation]]
 +
| Stop a running animation.
 
|}
 
|}
  
  
−
== Syntax ==
+
== Sound & Volume ==
−
<syntaxhighlight lang="lua">
+
 
−
shaderSetOptions(value [, id])
+
{| class="ts"
−
</syntaxhighlight>
+
|-
 +
! style="width:20%" | Function Name
 +
! Description
 +
|-
 +
| [[Global Command: getSoundId|getSoundId]]
 +
| Retrieve the id of a currently active audio file.
 +
|-
 +
| [[Global Command: getSoundProperty|getSoundProperty]]
 +
| Retrieve various properties of a sound.
 +
|-
 +
| [[Global Command: getVolume|getVolume]]
 +
| Retrieve general volume levels.
 +
|-
 +
| [[Global Command: setSoundProperty|setSoundProperty]]
 +
| Set properties of a sound.
 +
|-
 +
| [[Global Command: setVolume|setVolume]]
 +
| Set general volume levels.
 +
|-
 +
| [[Global Command: startSound|startSound]]
 +
| Play an audio file.
 +
|-
 +
| [[Global Command: stopSound|stopSound]]
 +
| Stop a playing sound.
 +
|-
 +
| [[Global Command: toggleSoundPause|toggleSoundPause]]
 +
| Toggle an active sound between playing and paused states.
 +
|}
  
  
−
== Parameters ==
+
== Events & Hooks ==
  
 
{| class="ts"
 
{| class="ts"
 
|-
 
|-
−
! style="width:15%" | Parameter
+
! style="width:20%" | Function Name
−
! style="width:15%" | Type
 
 
! Description
 
! Description
 
|-
 
|-
−
| value
+
| [[Global Command: createEvent|createEvent]]
−
| table
+
|  
−
| Table of options.
 
 
|-
 
|-
−
| id
+
| [[Global Command: registerEventHandler|registerEventHandler]]
−
| int
+
| Registering an event handler allows you to run custom functions on specific engine events.
−
| Configuration id.
+
|-
 +
| [[Global Command: registerHookFunction|registerHookFunction]]
 +
| Register a hook function for a specific operation.
 +
|-
 +
| [[Global Command: unregisterEventHandler|unregisterEventHandler]]
 +
| Unregister an event handler for a specific engine event which had been registered before.
 
|}
 
|}
  
  
−
== Return values ==
+
== Window ==
  
−
none
+
{| class="ts"
 +
|-
 +
! style="width:20%" | Function Name
 +
! Description
 +
|-
 +
| [[Global Command: getWindowBrightness|getWindowBrightness]]
 +
| Returns the brightness (gamma) of the window.
 +
|-
 +
| [[Global Command: getWindowMode|getWindowMode]]
 +
| Returns the current window mode, i. e. if the game is running at fullscreen or in a window.
 +
|-
 +
| [[Global Command: setWindowBrightness|setWindowBrightness]]
 +
| Set the global brightness (gamma) of the window.
 +
|-
 +
| [[Global Command: setWindowSize|setWindowSize]]
 +
| Set the size of the game window.
 +
|-
 +
| [[Global Command: setWindowTitle|setWindowTitle]]
 +
| Set a custom title in the game application title bar.
 +
|-
 +
| [[Global Command: toggleWindowMode|toggleWindowMode]]
 +
| Toggle the current window mode form fullscreen to windowed or vice versa.
 +
|}
  
  
−
== Examples ==
+
== Shaders ==
−
'''Example1: '''
+
 
−
<syntaxhighlight lang="lua">
+
{| class="ts"
−
shaderSetOptions({
+
|-
−
  renderbuffers=2,
+
! style="width:20%" | Function Name
−
  { shader = shaders.num(), source=0, target = 1, clear = 0 },
+
! Description
−
  { shader = shaders.num(), source=0, target = 0, clear = 0 },
+
|-
−
  { shader = shaders.bnum(), source=1, target = 0, clear = 0, comp_dst=0 }
+
| [[Global Command: shaderCompile|shaderCompile]]
−
})
+
| Compile a shader.
−
</syntaxhighlight>
+
|-
 +
| [[Global Command: shaderSetOptions|shaderSetOptions]]
 +
| Set shader options.
 +
|-
 +
| [[Global Command: shaderUniform|shaderUniform]]
 +
| Set uniforms for shader.
 +
|}
 +
 
 +
 
 +
== Game clients (Steam, GOG Galaxy) ==
 +
 
 +
{| class="ts"
 +
|-
 +
! style="width:20%" | Function Name
 +
! Description
 +
|-
 +
| [[Global Command: getGameClientAchievement|getGameClientAchievement]]
 +
|
 +
|-
 +
| [[Global Command: getGameClientStat|getGameClientStat]]
 +
|
 +
|-
 +
| [[Global Command: initGameClient|initGameClient]]
 +
|
 +
|-
 +
| [[Global Command: resetGameClientStats|resetGameClientStats]]
 +
|
 +
|-
 +
| [[Global Command: setGameClientAchievement|setGameClientAchievement]]
 +
|
 +
|-
 +
| [[Global Command: setGameClientStat|setGameClientStat]]
 +
|
 +
|}
 +
 
 +
 
 +
== Haptic effects ==
 +
 
 +
{| class="ts"
 +
|-
 +
! style="width:20%" | Function Name
 +
! Description
 +
|-
 +
| [[Global Command: createHapticEffectCondition|createHapticEffectCondition]]
 +
|
 +
|-
 +
| [[Global Command: createHapticEffectConstant|createHapticEffectConstant]]
 +
|
 +
|-
 +
| [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]]
 +
|
 +
|-
 +
| [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]]
 +
|
 +
|-
 +
| [[Global Command: createHapticEffectRamp|createHapticEffectRamp]]
 +
|
 +
|-
 +
| [[Global Command: startHapticEffect|startHapticEffect]]
 +
|
 +
|-
 +
| [[Global Command: startHapticRumble|startHapticRumble]]
 +
|
 +
|-
 +
| [[Global Command: stopHapticEffect|stopHapticEffect]]
 +
|
 +
|-
 +
| [[Global Command: stopHapticRumble|stopHapticRumble]]
 +
|
 +
|}
 +
 
 +
 
 +
== Debug ==
 +
 
 +
{| class="ts"
 +
|-
 +
! style="width:20%" | Function Name
 +
! Description
 +
|-
 +
| '''debugerror'''
 +
| Internal debug function to create a stacktrace
 +
|-
 +
| '''debugfunc'''
 +
| Internal debug function to create a stacktrace
 +
|}
 
{{toc}}
 
{{toc}}

Revision as of 10:37, 19 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 Registering an event handler allows you to run custom functions on specific engine events.
registerHookFunction Register a hook function for a specific operation.
unregisterEventHandler Unregister an event handler for a specific engine event which had been registered before.


Window

Function Name Description
getWindowBrightness Returns the brightness (gamma) of the window.
getWindowMode Returns the current window mode, i. e. if the game is running at fullscreen or in a window.
setWindowBrightness Set the global brightness (gamma) of the window.
setWindowSize Set the size of the game window.
setWindowTitle Set a custom title in the game application title bar.
toggleWindowMode Toggle the current window mode form fullscreen to windowed or vice versa.


Shaders

Function Name Description
shaderCompile Compile a shader.
shaderSetOptions Set shader options.
shaderUniform Set uniforms for shader.


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 Internal debug function to create a stacktrace
debugfunc Internal debug function to create a stacktrace


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