mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18: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>
85 lines
1.4 KiB
Markdown
85 lines
1.4 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [setTailTitle](./bitburner.userinterface.settailtitle.md)
|
||
|
||
## UserInterface.setTailTitle() method
|
||
|
||
Set the title of the tail window of a script.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
setTailTitle(title: string | ReactNode, pid?: number): void;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
<table><thead><tr><th>
|
||
|
||
Parameter
|
||
|
||
|
||
</th><th>
|
||
|
||
Type
|
||
|
||
|
||
</th><th>
|
||
|
||
Description
|
||
|
||
|
||
</th></tr></thead>
|
||
<tbody><tr><td>
|
||
|
||
title
|
||
|
||
|
||
</td><td>
|
||
|
||
string \| [ReactNode](./bitburner.reactnode.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
The new title for the tail window.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
pid
|
||
|
||
|
||
</td><td>
|
||
|
||
number
|
||
|
||
|
||
</td><td>
|
||
|
||
_(Optional)_ Optional. PID of the script having its tail closed. If omitted, the current script is used.
|
||
|
||
|
||
</td></tr>
|
||
</tbody></table>
|
||
|
||
**Returns:**
|
||
|
||
void
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 0 GB
|
||
|
||
This sets the title to the given string, and also forces an update of the tail window's contents.
|
||
|
||
The title is saved across restarts, but only if it is a simple string.
|
||
|
||
If the pid is unspecified, it will modify the current script’s logs.
|
||
|
||
Otherwise, the pid argument can be used to change the logs from another script.
|
||
|
||
It is possible to pass any React Node instead of a string. See [ReactElement](./bitburner.reactelement.md) and [ReactNode](./bitburner.reactnode.md) types for additional info.
|
||
|