factoriomod-debug 2.0.13 → 2.1.2

package/doc/debugadapter.md

@@ -1,16 +0,0 @@
-# Debug Adapter
-
-## Runtime Lua Diagnostics
-
-The debugger also injects runtime diagnostics into all hooked mods:
-
-  * Event Handler Replacement: A warning will be issued when an event handler is registered to an event that already has a handler that is not equal to the new one.
-
-## Debugging inside Zip Files
-
-If [Zip File Explorer](https://marketplace.visualstudio.com/items?itemName=slevesque.vscode-zipexplorer) is also installed, breakpoints and stepping will work inside zipped mods.
-
-## Advanced Features
-
-  * [Debugger Mod API](debugapi.md)
-  * [Custom Debug Views](variables.md)

package/doc/debugapi.md

@@ -1,41 +0,0 @@
-# Debugger API
-
-## Detecting Debugging
-
-Mods may detect that the debugger is attached by the presence of the global variable `__DebugAdapter`. Mods **MUST NOT** create this variable themselves, or write to any fields within it.
-
-## String Interpolation
-
-Several locations in the interface use string interpolation with expressions in `{}`. The inner expression is evaluated as lua code. `{[}` and `{]}` can be used to emit literal `{` and `}`.
-
-When used with Logpoint expressions, exception strings, and `__DebugAdapter.print()`, the inner expression has access to all locals and upvalues at the current location, and the expression `{...}` will represent the varargs available at that location, if available.
-
-The expression always has access to globals.
-
-## Debug Print
-
-The function `__DebugAdapter.print(expr,alsoLookIn)` can be used to print messages using string interpolation to the vscode debug console. An indexable object `alsoLookIn` may provide additional values for the expressions in the string, which will be used before other variables.
-
-## Manual Breakpoints
-
-If normal breakpoints are unusable for some reason, you can call `__DebugAdapter.breakpoint(mesg:LocalisedString)` to break. If `mesg` is specified, it is displayed in the editor like an exception.
-
-## Terminate Session
-
-`__DebugAdapter.terminate()` can be used to terminate a debug session from mod code.
-
-## Restart Session
-
-`__DebugAdapter.restart()` can be used to restart a debug session from mod code.
-
-## Simulate Events
-
-`__DebugAdapter.raise_event(event:defines.events|number|string,data:EventData,modname:string)` can be used to call event handlers directly for testing. `data` is not validated, so you must ensure it is a well-formed event payload for `event` yourself. All event and custom-input handlers are raisable, even those not raisable through `script`.
-
-## Ignore Functions in Stepping
-
-Functions can be excluded from stepping with `__DebugAdapter.stepIgnore(funcOrTable)`.
-
-## Disable dumping for large files
-
-files can be excluded from dumping with `__DebugAdapter.dumpIgnore(nameOrNames)`. These must be exact source names, e.g. `"@__modname__/file.lua"`. This will disable disassembly, breakpoint validation, and possibly other future features in these files. This may be appropriate if you are experiencing long hangs on `require`s of large (5+MB) data files.

package/doc/profile.md

@@ -1,9 +0,0 @@
-# Profiling
-
-Setting `"hookMode": "profile"` in your launch config to enables profiling. This mode does not provide debug feaures (stepping, inspection, etc), but instead provides inline timing/hitcount data for every line and function executed in control stage. Flamegraph, highlighting and rulers are also provided to assist in finding hotspots. Mods may recognize the this mode by the presence of the global variable `__Profiler`. Mods **MUST NOT** create this variable themselves, or write to any fields within it.
-
-The profiler also provides a remote inteface `profiler` with the following functions:
-
-  * `dump()` - dump all timers immediately
-  * `slow()` - return to slow-start mode (dumping on return from every event temporarily)
-  * `save(name)` - return to slow-start mode and trigger an autosave with the given name. Defaults to "profiler" if unspecified.