Files
bitburner-src/markdown/bitburner.userinterface.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* 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>
2025-09-26 14:52:39 -07:00

2.5 KiB

Home > bitburner > UserInterface

UserInterface interface

User Interface API.

Signature:

interface UserInterface 

Methods

Method

Description

clearTerminal()

Clear the Terminal window, as if the player ran clear in the terminal

closeTail(pid)

Close the tail window of a script.

getGameInfo()

Gets the current game information (version, commit, ...)

getStyles()

Get the current styles

getTheme()

Get the current theme

moveTail(x, y, pid)

Move a tail window.

openTail(fn, host, args)

Open the tail window of a script.

renderTail(pid)

Render a tail window.

resetStyles()

Resets the player's styles to the default values

resetTheme()

Resets the player's theme to the default values

resizeTail(width, height, pid)

Resize a tail window.

setStyles(newStyles)

Sets the current styles

setTailFontSize(pixel, fn, host, args)

Set the font size of the tail window of a script.

setTailTitle(title, pid)

Set the title of the tail window of a script.

setTheme(newTheme)

Sets the current theme

windowSize()

Get the current window size