mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 06:48:42 +02:00
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
206 lines
2.5 KiB
Markdown
206 lines
2.5 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md)
|
|
|
|
## UserInterface interface
|
|
|
|
User Interface API.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
interface UserInterface
|
|
```
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[clearTerminal()](./bitburner.userinterface.clearterminal.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Clear the Terminal window, as if the player ran `clear` in the terminal
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[closeTail(pid)](./bitburner.userinterface.closetail.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Close the tail window of a script.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getGameInfo()](./bitburner.userinterface.getgameinfo.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Gets the current game information (version, commit, ...)
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getStyles()](./bitburner.userinterface.getstyles.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the current styles
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getTheme()](./bitburner.userinterface.gettheme.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the current theme
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[moveTail(x, y, pid)](./bitburner.userinterface.movetail.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Move a tail window.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[openTail(fn, host, args)](./bitburner.userinterface.opentail.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Open the tail window of a script.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[renderTail(pid)](./bitburner.userinterface.rendertail.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Render a tail window.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[resetStyles()](./bitburner.userinterface.resetstyles.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Resets the player's styles to the default values
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[resetTheme()](./bitburner.userinterface.resettheme.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Resets the player's theme to the default values
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[resizeTail(width, height, pid)](./bitburner.userinterface.resizetail.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Resize a tail window.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setStyles(newStyles)](./bitburner.userinterface.setstyles.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Sets the current styles
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setTailFontSize(pixel, fn, host, args)](./bitburner.userinterface.settailfontsize.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set the font size of the tail window of a script.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setTailTitle(title, pid)](./bitburner.userinterface.settailtitle.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set the title of the tail window of a script.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setTheme(newTheme)](./bitburner.userinterface.settheme.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Sets the current theme
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[windowSize()](./bitburner.userinterface.windowsize.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the current window size
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|