> For the complete documentation index, see [llms.txt](https://docs.arcware.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.arcware.cloud/unreal-engine-setup/using-the-arcware-pixel-streaming-template-project/getting-started/arcware-blueprints/arcware-hud.md).

# Arcware HUD

Arcware Blueprints

**Name:**\
BP\_Arcware\_HUD\_Hidden\_Mouse / BP\_Arcware\_HUD\_Visible\_Mouse\
\
**Location:** \
Content/Arcware\_Functionality/HUD/BP\_Arcware\_HUD\_Hidden\_Mouse.uasset\
\
**Use:** \
These two HUD's are presets for how the in-game mouse behaves.&#x20;

<figure><img src="https://451842398-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxeRHVvCMHTEw8OnxbYIg%2Fuploads%2Fmy6FLllzNMIc3Kr2ZKfv%2FArcware%20HUD%20-%20In%20Content%20Folder.jpg?alt=media&amp;token=ae79010a-5347-41a8-8378-3853a9c0d774" alt=""><figcaption><p>GameMode in content browser</p></figcaption></figure>

**'**&#x42;P\_Arcware\_HUD\_Hidden\_Mouse'\
This HUD should be used when your pixel stream has UI provided via the web-browser. In this scenario, you don't need to click any UI in the game so you don't need to show the in-game mouse cursor. \
\
'BP\_Arcware\_HUD\_Visible\_Mouse'\
This HUD should be used when your pixel stream has in-game UI. In this scenario, the user needs to interact with the in-game UI so the in-game mouse cursor must be visible. When this HUD is used it provides an example of in-game UI, which shows the most useful functionality for the in-game mouse, such as, only showing the mouse cursor when the menu is open.&#x20;

<figure><img src="https://451842398-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxeRHVvCMHTEw8OnxbYIg%2Fuploads%2FzSvGR46Kp0fJvrjadxNb%2FArcware%20HUD%20-%20in-game%20UI.jpg?alt=media&amp;token=bf72af69-1790-40a8-8aad-0e44fec3689e" alt=""><figcaption><p>in-game UI provided by 'BP_Arcware_HUD_Visible_Mouse'<br></p></figcaption></figure>

The UI asset used in the HUD is called '**Arcware\_UI**', you can open it to repurpose the Mouse/UI logic however necessary for your own project.&#x20;

<figure><img src="https://451842398-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxeRHVvCMHTEw8OnxbYIg%2Fuploads%2FFUQXpz37cPTHECHthqe7%2FArcware%20HUD%20-%20in-game%20UI%20blueprint.jpg?alt=media&amp;token=e5e8175d-e033-44e8-912e-f28282d322b2" alt=""><figcaption></figcaption></figure>

The desired HUD can be assigned in the **GameMode**.&#x20;

<figure><img src="https://451842398-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxeRHVvCMHTEw8OnxbYIg%2Fuploads%2FwKz5y8E1yWVQz0FEZVKN%2FArcware%20HUD%20-%20Setting%20Classes.jpg?alt=media&amp;token=2c3fb513-9de6-4714-9d09-ca3985ad89dc" alt=""><figcaption><p>Setting Blueprint Class's in the GameMode </p></figcaption></figure>


---

# 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://docs.arcware.cloud/unreal-engine-setup/using-the-arcware-pixel-streaming-template-project/getting-started/arcware-blueprints/arcware-hud.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.
