> For the complete documentation index, see [llms.txt](https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/ui/dialogs.md).

# Dialogs and blackouts

## Confirmation dialogs

`GameDialogs.Confirm` asks a question in the game's own confirmation panel (the one its Exit uses): the question, Yes and No, the screen behind dimmed.

```csharp
GameDialogs.Confirm(context, "Leave the game?",
    onYes: () => Rooms.ToMainMenu(),
    onNo: () => context.Log("Staying"));
```

`onYes` runs when it's answered Yes; `onNo`, if given, when it's closed any other way. It returns `false` if the panel couldn't be shown. For anything more than a yes or no, make a [window](/stoneforgeteam-docs/ui/windows.md).

## Blackouts

`Blackout` holds the screen black, as the game's own fades do, with a line of text in the middle if wanted, while something happens behind it: another game's world on its way, a long load.

```csharp
Blackout.Show("Waiting for the host...");
// ... later
Blackout.Text = "Almost there...";
// ... when it's ready
Blackout.Hide();
```

| `Blackout`   |                                                                                             |
| ------------ | ------------------------------------------------------------------------------------------- |
| `Show(text)` | Fades the screen to black and holds it, with text in the middle. Already up: just the text. |
| `Text`       | The text in the middle (`""` for none).                                                     |
| `Hide()`     | Fades it back out.                                                                          |
| `IsShown`    | Whether it's up (fading in, or held).                                                       |

It stays until `Hide()` or the next room change, whose own fade takes it over.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://stoneforgeteam.gitbook.io/stoneforgeteam-docs/ui/dialogs.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.