mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-08 08:43:53 +01:00
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [setTitle](./bitburner.ns.settitle.md)
|
||
|
||
## NS.setTitle() method
|
||
|
||
Set the title of the tail window of a script.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
setTitle(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.
|
||
|