Skip to content

Readme.md

Latest commit

 

History

History
73 lines (52 loc) · 3.96 KB

Readme.md

File metadata and controls

73 lines (52 loc) · 3.96 KB

Query Scripts

Use C# to query the currently loaded game instance, in particular from its pak files mbin items.

The tab toolbar has buttons to: create a new script, clear all script logs, save all script edits to disk.
The script toolbar has buttons to: delete, save, compile, execute, stop execute (only enabled while script running).

New

The New Script button will create a new .cs script file in the ./Scripts/Query/ folder. A file system watcher will detect the new file and add it to the listbox.

When creating a new script a popup will prompt for the script file name.
Double-clicking a script file name will open a popup to rename the script file.

The class name is initially set to the file name with ' ', '_', and '-' removed.

Edit

Each query script file must have a class that derives from cmk.NMS.QueryScript and overrides its Execute method. New scripts are created from a template that meets these requirements.
The script file may also contain other classes and methods. All types and methods used by a query script must be in a loaded Assembly, these are generally from: .NET library, a .NET exe | dll in the application folder, or a .NET dll in the ./Plugins folder.

As you move the cursor over the script intellisense like feedback is provided in the script window statusbar. When you enter a '.' the app will display any available code-completion options in a popup e.g. methods, fields.

You can double-click a pak item path string to view the item in the PAK Items tab.

There are three main properties a script will use:

  • Game. This is the currently loaded game instance. It contains the following notable properties:
    • Location. Game path, NMS build date, Release information.
    • MBINC. libMBIN | MBINCompiler to be used based on Release information. Currently this will always be the link loaded libMBIN.dll.
    • PCBANKS. Collection of all game pak files.
    • MODS. Collection of all mod pak files.
    • Language. Dictionary of language Id - Value pairs for current language Identifier.
    • Substances, Products, Technologies. Lists of the various in-game items.
    • RefinerRecipes, CookingRecipes. Lists of the various in-game recipes.
  • Log. List of log items for script. These items are displayed in the Log view, below the script editor.
  • Cancel. A token that is signalled when you click the Cancel button in the script toolbar while the script is being Executed.

Compile

The results of the compile, including any errors, will be displayed in the Log view below the script editor.
In the above example we deleted the last 't' from the CreateText method name. The error tells us the script file name (Dump_Products), the line (19), column (30), and what is wrong (System.IO.File class does not contain a 'CreateTex' method).

Execute

If you add Log entries in a tight loop the UI thread may spend all its time updating the Log view. This may result in the other app windows and controls becoming unresponsive. If you may need to capture many log messages consider writing them to a file instead.

When Log items are added, CollectionChanged?.DispatcherBeginInvoke is called to notify any listeners (the Log view window) of the change. This can result in groups of Log items suddenly being displayed in a Log view, as opposed to one at a time. Although DispatcherInvoke would give a smoother Log view response, it also adds significant performance overhead in these cases due to the background threads, that are adding the Log items, having to wait for the UI thread to handle each CollectionChanged event and update the Log view.

When a query script is executing you can select and execute other query scripts. When you select a query script the script toolbar button states will update based on if the script is being executed or not.