> For the complete documentation index, see [llms.txt](https://giantgrey.gitbook.io/databrain/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://giantgrey.gitbook.io/databrain/add-ons/progress/runtime-ui-setup.md).

# Runtime UI Setup

{% hint style="info" %}
Please also have a look at the demo scene.\
The RuntimeProgressTest class assigned to the \_DEMO gameObject in the demo scene handles all important aspects, like starting a research and listening to events.
{% endhint %}

The runtime setup of a Progress Graph consists of three components:

* **Progress Controller (In the scene)**\
  Controls the loading of a graph, as well as starting a research
* **Progress Graph UI Controller  (In the scene)**\
  Builds the actual graph
* **Progress Node UI Element**\
  The actual UI Node. Handles UI Interaction and starts a new research on mouse click.

You can of course <mark style="background-color:orange;">create your own ProgressGraphUIController</mark> if you like to build your graph differently.\
Simply make sure to implement the <mark style="background-color:orange;">IProgressGraphUIControl</mark> interface to your custom class and assign the GameObject which has the custom class to the ProgressController ProgressUIControl field in the inspector.

## Progress Controller

<div align="left"><figure><img src="/files/AC1dToDwtBVamQPb7c8M" alt=""><figcaption></figcaption></figure></div>

The ProgressController contains multiple methods which allows you to control a Progress Graph like starting a research or listening to specific events.\
Make sure to have a reference to the ProgressController script to control your graph.\
Please have a look at the API section to see all available methods and events.

{% content-ref url="/pages/XW6wDE0sa4BuMZY6frp1" %}
[ProgressController](/databrain/add-ons/progress/api/progresscontroller.md)
{% endcontent-ref %}

* Progress Graph: The assigned Progress Graph (can be switched at runtime)
* Progress UI Control: The GameObject which controls the actual Progress Graph UI. Must implement the IProgressGraphUIControl interface.
* Load On Start: If true, the graph will be loaded directly on start.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://giantgrey.gitbook.io/databrain/add-ons/progress/runtime-ui-setup.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.