bitburner-src/markdown/bitburner.ns.prompt.md
omuretsu 06a985bdf8 Revert "Remove markdown from git tracking ()"
This reverts commit bbb6e3f309935aebac74ddb1fbeec12dfb7540b1.
2022-10-21 11:16:00 -04:00

37 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [prompt](./bitburner.ns.prompt.md)
## NS.prompt() method
Prompt the player with an input modal.
<b>Signature:</b>
```typescript
prompt(
txt: string,
options?: { type?: "boolean" | "text" | "select" | undefined; choices?: string[] },
): Promise<boolean | string>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| txt | string | Text to appear in the prompt dialog box. |
| options | { type?: "boolean" \| "text" \| "select" \| undefined; choices?: string\[\] } | Options to modify the prompt the player is shown. |
<b>Returns:</b>
Promise&lt;boolean \| string&gt;
True if the player click “Yes”; false if the player clicks “No”; or the value entered by the player.
## Remarks
RAM cost: 0 GB
Prompts the player with a dialog box. If `options.type` is undefined or "boolean", the player is shown "Yes" and "No" prompts, which return true and false respectively. Passing a type of "text" will give the player a text field and a value of "select" will show a drop-down field. Choosing type "select" will require an array or object to be passed via the `options.choices` property. The scripts execution is halted until the player selects one of the options.