mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-20 16:22:56 +02:00
API: Move tail-related APIs to another namespace (#1935)
* API: Move tail-related APIs to another namespace * Add missing RAM cost config * Remove setTailFontSize from NS namespace
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
<!-- 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
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| title | string \| [ReactNode](./bitburner.reactnode.md) | The new title for the tail window. |
|
||||
| pid | number | _(Optional)_ Optional. PID of the script having its tail closed. If omitted, the current script is used. |
|
||||
|
||||
**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.
|
||||
|
||||
Reference in New Issue
Block a user