# Realvirtual

### Introduction <a href="#introduction" id="introduction"></a>

Every scene which is using realvirtual.io functions needs to include the *realvirtual.io* asset (before 2022 Game4automation) on the top hierarchy level of the scene. You need to keep the name and the location.

If you create a new scene with the *realvirtual* menu, the *realvirtual.io a*sset is automatically included. You can also add the *realvirtual.io* asset by manually adding it to an existing scene:

<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-21ec752d95fa162a663c715bea5d2533e582e3c4%2FrvaddRVobj.png?alt=media" alt=""><figcaption><p>The <em>realvirtual.io</em> Asset includes the Realvirtual<em>Controller</em> (see below) as well as a standard scene navigation, standard lights, the Runtime UI as well as a base plate.</p></figcaption></figure></div>

### realvirtual.io Controller <a href="#realvirtual-io-controller" id="realvirtual-io-controller"></a>

The most important part of the *realvirtual.io* Asset is the RealvirtualController Script. This asset keeps the scene settings. Most realvirtual.io objects will call this controller or get some settings from it. This is, why the RealvirtualController is a must for all scenes with realvirtual.io functions.

<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-bebf216bb34f4985173a5081272615c03a27c40e%2Frealvirtual-controller.png?alt=media" alt=""><figcaption></figcaption></figure></div>

## General Options <a href="#general-options" id="general-options"></a>

**Connected**

Setting for defining, if the simulation is starting in “Connected” mode. If true, this will set the global connecting status to connected (see also [Connection-Status](https://doc.realvirtual.io/basics/runtime-ui#connection-status)).

**Model Checker Enabled**

Enables the model checking when simulation starts (see[ Model Checker](https://doc.realvirtual.io/basics/user-interface/model-checker))

**Validate Before Start**

Enables pre-play validation that checks for common configuration issues before starting the simulation. When enabled, realvirtual performs automatic validation of your scene setup and displays warnings in the console for issues that should be resolved before running the simulation.

**Validation On Components Added**

Enables validation checks when components are added to GameObjects during Editor mode. This provides immediate feedback when adding components that might have configuration conflicts.

For complete documentation of the validation system, see [Pre-Play Validation](https://doc.realvirtual.io/components-and-scripts/game4automation/pre-play-validation).

**Stop Physics when Paused**

Starting from release 2022.15, physics simulations do not stop when the simulation is paused in RuntimeUI. This allows you to continue navigating the scene with the mouse even while the simulation is paused. However, if you need to fully stop the simulation, including all physics calculations, you can enable the "Stop Physics When Paused" option. This will ensure that both the simulation and physics are completely paused.

**Scale**

Defines how many millimeters fits into one Unity Unit. If, as usual, one Unity unit is considered as one Meter, the Scale should be set to 1000. The Scale is used for all input fields of Behavior components whith distance or length properties.

{% hint style="info" %}
As a standard in all Behavior components the values for distances and lengths are always considered as Millimeters.
{% endhint %}

**Speed Override**

Overrides the speed of all drives. You can slow down or speed up all drives in the scene by selecting another value for the speed override. A value of two means doubled speed.

{% hint style="info" %}
Please consider, that this value also influences the physical behavior of the model. For example if a Value of 10 is selected the bottles in the demo model will tumble around.
{% endhint %}

**Time Scale**

Speeds up the simulation. This also speeds up the physics so that the simulation is just running faster but internally in the calculations running in real time.

{% hint style="info" %}
If the time scale is to hight it might happen that sensors are not getting active any more because the products are passing to fast the sensors.
{% endhint %}

**Hide Groups**

Hides the defined Groups when the simulation is started. Groups can be defined manually by adding the Group component to any gameobject or - in a more comfortable way - by using the [Selection Window](https://doc.realvirtual.io/basics/user-interface/selection-window) (This is only available in Professional Version).

**Restart**

In certain scenarios, such as fairs or demonstration models, you may need the simulation to automatically start and stop after a specific duration. By enabling the restart function, you can set a predefined time interval for the scene to restart. This ensures that your simulation runs continuously without manual intervention, making it ideal for presentations or automated demos.

**Additive Scene Loading**

With realvirtual.io 2021.06, we have added support for additive scene loading. With additive scene loading, multiple individual scenes can form an entire model. More about the basics of additive scenes is described here in the Unity documentatio(<https://docs.unity3d.com/Manual/MultiSceneEditing.html>).

When using additive scene loading, the Game4automationController is automatically disabled in the additive scenes. All [MUs](https://doc.realvirtual.io/components-and-scripts/mu-movable-unit) created by [Soruces](https://doc.realvirtual.io/components-and-scripts/mu-movable-unit/source) are automatically created within the main scene. Within AdditiveScenes the path (Assets/….) can be defined within the Unity project to all scenes that should be loaded additively. It can be defined separately whether the scene should only be loaded in Edit Mode or also in Play Mode.

## UI Options

**Hierarchy Update Cycle**

Cylcle for updating the icons and signal values in the hierarchy view during runtime.

**Scale Handles**

The scale size of the realvirtuil.io Gizmos.

**Standard Source**

The standard Source that should be inserted into the model when Hotkey Source (Ins) is pressed.

**Editor Gizmo Settings**

The color settings for Editor Tools like[ Kinematic Tool.](https://doc.realvirtual.io/basics/user-interface/kinematic-tool-pro)

**UI Enabled On Start**

Enables and disables the full UI on simulation start (runtime inspector and runtime menu bar).

**Runtime Inspector Enabled**

Enables and disables the runtime inspector.

**Object Selection Enabled**

Enables the object selection and highlighning of components in the scene. See also [RuntimeUI](https://doc.realvirtual.io/basics/runtime-ui).

**Hide Info Box**

Hides the info box at simulation start.

**Runtime Application UI**

A pointer to the Application UI (menu, runtime inspector and so on).

**Runtime Automation UI**

A pointer to the Automation UI (the buttons and lights which are controlling the automation)

## Skin Controller

The `Skin Controller` is a component of the realvirtual prefab that configures the UI settings for realvirtual.

<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-3b6ad0f0d173f88bff61329bf11ba254296f90a8%2Fskincontroller.png?alt=media" alt=""><figcaption></figcaption></figure></div>

The Skin Controller customizes button and window colors, font size, and font color. It includes two predefined settings. To create a custom definition, right-click in the project panel and select **Create > realvirtual > Create realvirtual UI Skin**.\
Within the Skin definition are several sections. Relevant for the basic in realvirtual are the marked areas in the picture below.

<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-1d49fd16ec91772158a557ecfe91e003cd938fc9%2FrealvirtualUISKin.png?alt=media" alt=""><figcaption></figcaption></figure></div>

## Visual Settings (deprecated)

{% hint style="info" %}
In realvirtual.io Version 6, the management of visual settings has been updated, particularly with the new [EnvironmentController ](https://doc.realvirtual.io/components-and-scripts/game4automation/environment-controller)component. The [EnvironmentControlle](https://doc.realvirtual.io/components-and-scripts/game4automation/environment-controller)r is responsible for configuring environmental aspects such as lighting, skyboxes, and ambient settings within your digital twin projects.\\
{% endhint %}

**Enable Visual Settings**

If set to false the realvirtual.io controller will not change anything from its own on lightning, camera and so on so all settings below will not be applied.

**Standard Base Plate And Lights**

You can turn of with this the standard base plate and the lights which are included in the *game4automation* Asset.

**Base Plate Dimensions**

The dimensions of the base plate in meters.

**Sun Light intensity**

Sets the intensity of all sun lights (which are all lights market with the tag *g4a sun*)

**First Light intensity**

Sets the intensity of all first lights (which are all lights market with the tag *g4a firstlight*).\
This lights are usually used for the light which is lightning the scene like the big light in a building.

**Second Light intensity**

Sets the intensity of all second lights (which are all lights market with the tag *g4a secondlight*)\
This lights are usually used mainly for decoration purposes, like small spot lights in a building.

**Quality Level**

Sets the overall visual quality. This has impact on the render performance and screen update rate. Ultra is the best. Unity is very good performing so Ultra is OK for most use cases. In lower settings for example shadows and reflections are turned off.

**Hierarchy Icons**

Settings for the Hierarchy Icons and annotations in the Hierarchy view

**Hotkeys**

Hotkey settings.

© 2025 realvirtual GmbH [https://realvirtual.io](https://realvirtual.io/) - All rights reserved. No part of this publication may be reproduced, distributed, or transmitted in any form or by any means, including printing, saving, photocopying, recording, or other electronic or mechanical methods, without the prior written permission of the publisher.


---

# Agent Instructions: 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://doc.realvirtual.io/components-and-scripts/game4automation.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.