iloveagoodcrisp / atlas Goto Github PK

HaloScript is a comprehensive language support extension for all iterations of the Halo Script language used in the Halo: The Masterchief Collection Mod Tools. HaloScript provides:

• Autocompletion
• Documentation on all HaloScript functions
• Hover descriptions for HaloScript elements
• Function argument hints
• Syntax highlighting
• Snippets
• Error Checking

This extension contributes each game's Halo Script iteration as a separate language. Once you've opened a hsc file, you can select the correct HaloScript language for your current file from the Status Bar.

The HaloScript syntax comes in two flavours, the classic lisp styled syntax used in Halo 1 - Halo Reach, and the newer C-like syntax featured in Halo 4.

You can set the default .hsc file language by editing your user settings.json file. For example to set Halo 4 Script as the default you would add:

    "files.associations": {
        "*.hsc": "hsc4"
    },

HaloScript is compatiable with any VSCode theme. Dark (Visual Studio - C/C++) is the theme used in the examples below.

Snippets are templates you can add to help you quickly add code to your scripts. HaloScript includes a large number of snippets for quickly creating template scripts, variables and loops. Snippets are also the method for quickly accessing the various enum values present in HaloScript.

If snippets are not showing when you start typing, you can press CTRL+SPACE to trigger Intellisense. Snippets can be distinguished from other autocomplete suggestions by the square icon. Once the snippet is highlighted, you can press TAB to insert it. Certain snippets included multiple parts, you can use TAB to jump between these.

The full snippets list can be accessed through the Command Palette (shortcut CTRL+SHIFT+P), and selecting Insert Snippet.

HaloScript offers automcompletion for functions, built-in globals, value types, script types, and keywords. Autocomplete suggestions will show as you type. Use TAB to accept the autocomplete suggestion.

Autocomplete suggestions will also display relevant information, such as descriptions and accepted arguments for a function. When accepting an autocomplete suggestion for a function, parentheses will be automatically inserted if they are not already present.

Argument hints are displayed when writing out a HaloScript function. These hints will highlight the structure of the arguments required for a function, the function description, the current argument to input, and a description of the type of argument to supply.

Arguments that end with ? are optional.

Simply hover over any HaloScript function, built-in global, value type, or keyword to prompt a description of that item.

TabOut lets you use the tab key to jump out parentheses using TAB. This will make it a much smoother experience to work with HaloScript given its heavy use of parentheses.

Script compilation directly from VSCode is supported for Halo 4 only. While editing a Halo 4 Script file you can use the Command Palette (shortcut CTRL+SHIFT+P) to access the command Compile Scenario Scripts or simply right-click in the editor and select the command from the context menu.

Note that script compilation will only work correctly while editing a scenario script file. Compilation directly from a global or object script file is not supported.

HaloScript includes a basic level of debugging. The extension will report unmatched opening and closing parentheses, with plans to expand error checking further in the future.

Alexis Jonsson - Icon design

Crisp - Extension Developer