A complete language extension for Viz Script development in Visual Studio Code
- Now supports Viz4
- Activate by triggering
Change Language Mode
on Command Palette and choosingViz4SceneScript
/Viz4ContainerScript
or by opening a supported filetype.- Scene scripts:
.vs4 .viz4
- Container scripts:
.vs4c .viz4c
- Scene scripts:
- Activate by triggering
- Syntax Highlighting
- Auto-Completion ( ctrl-spacebar to trigger, auto triggers if Quick Suggestions: "Other" is true.)
- Supports both built-in and document completions
- Includes completions updated to Viz Engine/Artist 3.14
- Color Themes
- Syntax check your code on a Viz Engine ( ctrl-f5)
- Get and set container and scene scripts in Viz Artist ( Commands:
Get scripts from Viz
andSet current script in Viz
) - Signature Help (ctrl-shift-spacebar to trigger, auto triggers on
"("
if function/sub is found )- Supports both built-in and document functions.
- Supports overloading
- Definition Provider(ctrl-click to jump to definition )
- Symbol Searching (ctrl-shift-o to trigger )
-
Activate by triggering
Change Language Mode
on Command Palette and choosingVizSceneScript
/VizContainerScript
or by opening a supported filetype. -
Can also be triggered by running
Viz Script: Get scripts from Viz
.vs .viz .v3script (legacy, might be removed)
.vsc .vizc
- Added keywords to completions. (if,then,else etc.)
- Keywords are lowercase by default. Can be changed in settings
vizscript.keywordLowercase
- Keywords are lowercase by default. Can be changed in settings
- Utilized the new status bar background color to move syntax check error messages to status bar
- VS Code version must be
1.53.0
or higher
- VS Code version must be
- Added option to show Event completion snippets on root level. (e.g. OnInit())
- This feature can be deactivated in settings
vizscript.showEventSnippetCompletionsOnRoot
(Activated by default)
- This feature can be deactivated in settings
- Definition provider now supports more types.
Get scripts from Viz
is now available at all time. Also without any document open.
- Added completions for Container and Scene on root level
- This feature can be deactivated in settings
vizscript.showThisCompletionsOnRoot
(Activated by default)
- This feature can be deactivated in settings
- Early support for communication with Viz Artist
- The command
Get scripts from Viz
will list all scene and container script in the currently active scene - The command
Set current script in Viz
or shortcut ctrl-shift-F5 will set the fetched script in Viz Artist
- The command
- Initial support for snippet completions on Global Procedures (disabled by default)
-
Now supports both Scene and Container scripts
- The extension now contributes two languages
- VizSceneScript
- VizContainerScript
- Validation works for both variants
- "This" keyword enables context sensitive completions based on the language selected
- The correct script type will automatically be selected when a file is opened based on the extension
- Scene scripts:
- .vs
- .viz
- .v3script (legacy, might be removed)
- Container scripts:
- .vsc
- .vizc
- Scene scripts:
- The extension now contributes two languages
-
Added support for descriptions on document completions
- A comment directly above a function or sub will be used as description.
- A comment directly after a variable declaration will be used as description.
- Validate your code on a Viz Engine
- Shortcut ctrl-F5 or
Viz Script: Compile code
on Command Palette (Ctrl-Shift-P) - The line with an error will be highlighted in the editor.
- The hostname and port can be configured in the extension.
- Viz Engine must be OnAir.
- Shortcut ctrl-F5 or
- Turn features on and off in the extension configuration.
- Right click extension and choose "Extension Settings"
- Settings:
- Host Name: The hostname for connection to Viz Engine
- Host Port: The port number for connection to Viz Engine
- Enable Auto Complete: Enable Auto Complete functionality
- Enable Definition: Enable Jump to Definition for easy navigation
- Enable Signature Help: Enable Signature Help for both built-in and custom procedures
- Color Themes
- Right click the extension and choose "Set Color Theme" or Command Palette - "Preferences: Color Theme"
- Themes:
- Viz Script Classic (Colors based on the original palette from Viz)
- Viz Script Enhanced (Updated color palette for improved readability)
I recommend these settings in VS Code to get the best result with this plugin.
To open settings.json:
- Ctrl-Shift-P to open Command Palette
- Search for "Preferences: Open Settings(JSON)
- Paste the code below. Remember "," between each setting.
"editor.quickSuggestions": {
"other": true,
"comments": false,
"strings": false
},
"editor.wordBasedSuggestions": false,
"editor.foldingHighlight": false
I have no affiliation with Vizrt and this extension is personal work.