Global Commands - Revision history

EK at 10:54, 10 August 2023

2023-08-10T10:54:22Z

2023-08-05T13:15:34Z

2023-08-05T11:49:13Z

2023-08-05T11:35:47Z

2023-08-05T10:44:46Z

2023-05-19T11:10:57Z

2023-05-19T09:37:27Z

2023-05-18T12:21:35Z

2023-05-15T22:58:26Z

2023-05-15T22:39:32Z

@@ Line 272: / Line 272: @@
 | '''localResourcesDir'''
 | String
-| The directory of the Visionaire project file.
+| The directory of the Visionaire project or data file, respectively (.ved/.vis).
 |-
 | ''Visionaire data table''

@@ Line 246: / Line 246: @@
 |-
 ! style="width:20%" | Field Name
-! Type
+! style="width:10%" | Type
 ! Description
 |-

@@ Line 273: / Line 273: @@
 | String
 | The directory of the Visionaire project file.
 |}
 {{toc}}

@@ Line 1: / Line 1: @@
-This is a list of global commands available in Visionaire Studio.
+This is a list of global methods and fields available in Visionaire Studio.
-== General ==
+== Methods ==
 {| class="ts"
@@ Line 64: / Line 65: @@
-== Sound & Volume ==
+=== Sound & Volume ===
 {| class="ts"
@@ Line 97: / Line 98: @@
-== Events & Hooks ==
+=== Events & Hooks ===
 {| class="ts"
@@ Line 118: / Line 119: @@
-== Window ==
+=== Window ===
 {| class="ts"
@@ Line 145: / Line 146: @@
-== Shaders ==
+=== Shaders ===
 {| class="ts"
@@ Line 163: / Line 164: @@
-== Game clients (Steam, GOG Galaxy) ==
+=== Game clients (Steam, GOG Galaxy) ===
 {| class="ts"
@@ Line 190: / Line 191: @@
-== Haptic effects ==
+=== Haptic effects ===
 {| class="ts"
@@ Line 226: / Line 227: @@
-== Debug ==
+=== Debug ===
 {| class="ts"
@@ Line 238: / Line 239: @@
 | '''debugfunc'''
 | Internal debug function to create a stacktrace
 |}
 {{toc}}

@@ Line 198: / Line 198: @@
 |-
 | [[Global Command: createHapticEffectCondition|createHapticEffectCondition]]
+| Create a haptic effect for devices which support haptic effects.
 |-
 | [[Global Command: createHapticEffectConstant|createHapticEffectConstant]]
+| Create a constant haptic effect for devices which support haptic effects.
 |-
 | [[Global Command: createHapticEffectLeftRight|createHapticEffectLeftRight]]
+| Create a haptic left/right effect for devices which support haptic effects.
 |-
 | [[Global Command: createHapticEffectPeriodic|createHapticEffectPeriodic]]
+| Create a periodic haptic effect for devices which support haptic effects.
 |-
 | [[Global Command: createHapticEffectRamp|createHapticEffectRamp]]
+| Create a haptic ramp effect for devices which support haptic effects.
 |-
 | [[Global Command: startHapticEffect|startHapticEffect]]
+| Start a previously created haptic effect for devices which support haptic effects.
 |-
 | [[Global Command: startHapticRumble|startHapticRumble]]
+| Start a haptic rumble effect for devices which support haptic effects.
 |-
 | [[Global Command: stopHapticEffect|stopHapticEffect]]
+| Stop a haptic effect on devices which support haptic effects.
 |-
 | [[Global Command: stopHapticRumble|stopHapticRumble]]
+| Stop a haptic rumble effect on devices which support haptic effects.
 |}

@@ Line 171: / Line 171: @@
 |-
 | [[Global Command: getGameClientAchievement|getGameClientAchievement]]
+| Get the current state of a game client achievement.
 |-
 | [[Global Command: getGameClientStat|getGameClientStat]]
+| Returns the requested game client stat.
 |-
 | [[Global Command: initGameClient|initGameClient]]
+| Initialize the GOG Galaxy client with the given values.
 |-
 | [[Global Command: resetGameClientStats|resetGameClientStats]]
+| Resets all game client stats.
 |-
 | [[Global Command: setGameClientAchievement|setGameClientAchievement]]
+| Set a game client achievement to "done".
 |-
 | [[Global Command: setGameClientStat|setGameClientStat]]
+| Sets the specified game client stat to the given value.
 |}

@@ Line 153: / Line 153: @@
 |-
 | [[Global Command: shaderCompile|shaderCompile]]
+| Compile a shader.
 |-
 | [[Global Command: shaderSetOptions|shaderSetOptions]]
+| Set shader options.
 |-
 | [[Global Command: shaderUniform|shaderUniform]]
+| Set uniforms for shader.
 |}

@@ Line 111: / Line 111: @@
 |-
 | [[Global Command: registerHookFunction|registerHookFunction]]
+| Register a hook function for a specific operation.
 |-
 | [[Global Command: unregisterEventHandler|unregisterEventHandler]]

@@ Line 108: / Line 108: @@
 |-
 | [[Global Command: registerEventHandler|registerEventHandler]]
+| Registering an event handler allows you to run custom functions on specific engine events.
 |-
 | [[Global Command: registerHookFunction|registerHookFunction]]
@@ Line 114: / Line 114: @@
 |-
 | [[Global Command: unregisterEventHandler|unregisterEventHandler]]
+| Unregister an event handler for a specific engine event which had been registered before.
 |}
@@ Line 126: / Line 126: @@
 |-
 | [[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.
 |}