> For the complete documentation index, see [llms.txt](https://doc.realvirtual.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.realvirtual.io/components-and-scripts/scene-interaction/hmi-components-pro/hmi-switch.md).

# HMI Switch (Deprecated)

realvirtual.io Professional

{% hint style="danger" %}
**Deprecated — no realvirtual WEB equivalent.** This interactive Unity uGUI control is deprecated. It is **not exported to realvirtual WEB** and has no direct counterpart there — the browser-based 3D-HMI does not use authored slider / switch / button / dropdown widgets. Instead, [**realvirtual WEB**](/extensions/realvirtual-web.md) builds operator HMIs from its own components and plugin system (WebSensor, WebError, KPI and message panels, and the React overlay layer). Writing signals from the browser is handled by the connect/debug tools, not by authored control widgets.
{% endhint %}

The HMI Switch works as toggle switching the connected Signal status between true and false. To use it with the render mode "Worldspace" you need the HMI-PanelWorldSpace as parent.

<div align="left"><figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-f1590e7edc406bd278c05fb76703e706f661b0d0%2FhmiSwitchExample.png?alt=media" alt=""><figcaption><p>Switches are used to start and stop<br>the can conveyor and the gantry.</p></figcaption></figure></div>

## Properties

<div align="left"><figure><img src="https://260262196-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FpYxFg97YnJX96UzNNTSd%2Fuploads%2Fgit-blob-58969b1b3171eb799a780110e0fe9fb96bef68e9%2FHMISwitch.png?alt=media" alt=""><figcaption></figcaption></figure></div>

* `ColorOn` : color in case of Signal status true
* `SignalOn` : PLCInputBool signal connected to the Button
* `SignalInit` : PLCOutputBool signal for the value of the Switch when the application starts
* `Text`: Button text
* `Text Size` : font size
* `IsOn` : read only for the current state of the switch


---

# 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://doc.realvirtual.io/components-and-scripts/scene-interaction/hmi-components-pro/hmi-switch.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.