Please open an issue after checking the Official ScarDoc documentation.Įxception: Any symbol marked with is open for documentation contributions. However changes can be considered for clear errors in documentation. Documentation improvements or changes will generally not be accepted for symbols covered by the official ScarDoc. The vast majority of this API documentation is based on the official ScarDoc released by Relic Entertainment. Error in documentation: Please open an issue.Undocumented/missing symbols (function, constant, blueprint such as, etc.): Please open an issue.Search for 'Lua color mode' and change the setting to GrammarĪs of July 22nd 2020, the VS Code extension a does not support Semantic highlighting.This prevents loading SCAR symbols from the Mod Builder's build cache.Search for 'Lua workspace ignoredir' and add Intermediate Cache.Search for 'Lua workspace library', click 'Edit in settings.json' and add the following setting:.Search for the 'File associations' setting and add *.scar (key field) lua (value field).Open Visual Studio code and open User Settings.Make sure to delete the previous version first. Repeat this step for updating your local copy of the API documentation.Download and extract the latest release from releases or use git to clone this repository.Install the a Visual Studio Code extension if you haven't already.These instructions assume that you're at least somewhat familiar with Visual Studio Code. If a version of this API documentation should be made available without underscore and AE prefixed symbols, please open an issue. The underscore prefixed symbols are likely intended for internal use and the AE prefixed are intended to be called from attribute instances via scar_function_call. This includes symbols whose name starts with an underscore _ or AE prefix. Added documentation for previously undocumented functions such as scartype and some of the UI functions.Ĭurrently all symbols are included in the documentation.Exported lists of values that exist in the runtime _G table while in a standard multiplayer match context.Official ScarDoc released by Relic Entertainment.This documentation is generated from 3 sources: The project that generates this API documentation is currently not made public as it is incredibly messy due to several iterations and rewrites over the years.

This project aims to provide comprehensive intellisense for writing Company of Heroes 2 SCAR scripts.

Console commands company of heroes 2