realvirtual.io
  • Building Digital Twins with Unity and realvirtual.io
  • Basics
    • Installation
    • Demo Model
      • Old Demo Model
    • Editor User Interface
      • Hierarchy Window
      • 3D Views
      • Quick Edit
      • Move Pivot Points (Pro)
      • Selection Window (Pro)
      • Material Window (Pro)
      • Measurement (Pro)
      • Kinematic Tool (Pro)
      • Model Checker
    • Runtime UI
      • Group Manager
      • Debug Console
      • Responsiveness
      • Runtime Persistence
    • Importing and exporting
    • Folder structure
    • Tutorial
    • Physics
    • CAD import (Pro)
      • CADLink (Pro)
      • CAD Checker (Pro)
      • CAD Updater (Pro)
    • Reusable Components (Prefabs)
    • Cadenas parts4cad
    • Publishing the Digital Twin
    • Revision management
  • News
  • Login & Download Updates (Pro)
  • Components & Scripts
    • Realvirtual
      • Environment Controller
    • MU, Source and Sink
      • Source
      • Sink
    • Motion and Kinematic
      • Drive
      • Kinematic
      • Group
      • Joint
      • CAM
      • TransportSurface
      • Guided Transport
      • Drive behavior
      • Chain
      • Chain element
      • Motion for developers
    • Sensors
      • Sensor
      • Measure
      • MeasureRaycast
    • Picking and Placing MUs
      • Grip
      • Gripper
      • Fixer
      • Pattern
    • Changing MUs
      • MaterialChanger
      • PartChanger
      • Cutter
    • Scene Interaction
      • 3D Buttons
      • Screen Overlay Buttons
      • Scene Selectables
      • Lamp
      • Interact3D
      • UI components
      • HMI components (Pro)
        • Start your own HMI
        • HMI Tab
        • HMI DropDown
        • HMI Puschbutton
        • HMI Switch
        • HMI Value
        • HMI Text
        • HMI Slider
        • HMI Message
        • HMI Marker
      • ModelZoo (Pro)
    • Interfaces
      • Interface Tools
        • Signal Manager
        • Signal Importer Exporter
        • Signal Catcher
        • OnValueChangedReconnect
      • Signal Importer / Exporter
      • ABB RobotStudio (Pro)
      • Denso Robotics (Pro)
      • EthernetIP (Pro)
      • Fanuc (Pro)
      • FMI
      • Igus Rebel
      • MQTT (Pro)
      • Modbus (Pro)
      • OPCUA (Pro)
      • PLCSIM Advanced (Pro)
      • RoboDK (Pro)
      • RFSuite (Pro)
      • SEW SimInterface (Pro)
      • Siemens Simit Interface (Pro)
      • Simit Shared Memory (Pro)
      • Simulink (Pro)
      • S7 TCP
      • TwinCAT (Pro)
      • TwinCAT HMI (Pro)
      • UDP (Pro)
      • Universal Robots (Pro)
      • Wandelbots Nova (Pro)
      • Websocket (Pro)
      • Windmod Y200 (Pro)
      • Custom Interfaces
    • Performance Tools
      • Combine Meshes (Pro)
      • Create Prefab (Pro)
      • Hierarchy Cleanup (Pro)
      • Mesh Optimizer (Pro)
      • Performance Optimizer (Pro)
    • Defining Logic
      • Unity Scripting
      • Behavior Graph
      • Logicsteps
      • Unity Visual Scripting
      • Recorder
    • Robot Inverse Kinematics (Pro)
    • Volume Tracking (Pro)
  • Multiplayer (Pro)
  • Extensions
    • ModelZoo
      • Beckhoff TwinCAT
      • Siemens S7
      • Denso Cobotta 1300
      • Wandelbots Nova Fanuc CRX
      • Universal Robots UR10
      • Fanuc Roboguide
    • realvirtual.io AIBuilder
      • realvirtual.io AI Builder Overview
      • Generate AI Training Data
      • AI Training
      • Testing AI in a Digital Twin
      • Deploying the AI
    • realvirtual.io Simulation
      • Conveyor Library
      • Path System
        • Path finding
        • Line
        • Curve
        • Workstation
        • Catcher
        • Pathmover
    • realvirtual.io Industrial Metaverse
      • Setup Guide
      • VR Modules
      • AR Modules
      • Multiuser
    • AGX Physics
    • VR Builder
    • CMC ViewR
  • Advanced Topics
    • Render Pipelines
    • Mixed Reality with Meta Quest3
    • Upgrade Guide
      • Upgrade to 2022
    • Open Digital Twin Interface
    • Usefull Addons
    • Improving Performance
    • Supported Platforms
    • Compiler Defines
    • For Developers
      • Important Classes and Interfaces
      • Assembly Definitions
      • Starting your development
      • Class documentation
      • realvirtual Init Sequence
      • realvirtualBehavior Lifetime Methods
      • Testing
    • Newtonsoft JSON
    • Troubleshooting
  • Release Notes
  • AI Digital Twin Assistant (GPT4)
  • License Conditions
Powered by GitBook
On this page
Edit on GitHub
  1. Advanced Topics

Compiler Defines

PreviousSupported PlatformsNextFor Developers

Last updated 9 months ago

realvirtual.io uses some compiler defines (also called Scripting Define Symbols) for managing different configurations. Compiler defines are switches which can be set to define which part of the C# source code are compiled or not. Sometimes it is necessary to use compiler defines to prevent unwanted compiler error messages. Which compiler defines needs to be set is depended on the Assets you purchased (realvirtual.io Starter, realvirtual.io Professional).

Most compiler defines are usually created automatically once you install the realvirtual.io Asset. You can reset the realvirtual.io settings, including the compiler defines, by selecting realvirtual > Apply standard settings:

You can find the current compiler defines under File > Build Settings > Player Settings > Other Settings > Scripting Define Symbols:

Some interfaces are needing special Complier Defines - this is mentioned on the Interface documentation page.

Here is a list and description of the used compiler defines. (before 2022 - GAME4AUTOMATION)

Compiler Define
Description

REALVIRTUAL

Standard compiler define which needs to be set to enable realvirtual.io Standard and professional

REALVIRTUAL_PROFESSIONAL

Compiler define which needs to be set only for realvirtual.io Professional. The standard setting of the compiler defines for realvirtual.io Professional is GAME4AUTOMATION; GAME4AUTOMATION_PROFESSIONAL

REALVIRTUAL_PLAYMAKER

OPCUA4UNITY

REALVIRTUAL_VISCUALSCRIPTING

CINEMACHINE

Compiler Define if Unitys Cinemachine is installed and should be used.

REALVIRTUAL_AGX

Turns on AGX Phyisics simulation capabilites in realvirtual.io if AGX Unity Plugin is installed

REALVIRTUAL_BESTHTTP

REALVIRTUAL_BESTMQTT

REALVIRTUAL_JSON

REALVIRTUAL_BESTHTTP3

REALVIRTUAL_BESTMQTT3

REALVIRTUAL_CUTTER

REALVIRTUAL_TEST

REALVIRTUAL_BURST

This compiler define needs to be set to be able to use the realvirtual.io Playmaker nodes. These nodes are only included in Professional version. You should set this define only if Playmaker is installed. See

Compiler Define for

Compiler Define if Unity Visual Scripting package is installed and should be used by realvirtual.io. See

Needed for BestHTTPV2 based interfaces like or

Needed for BESTMQTT v1 base interfaces like

Needed for JSON based interfaces like

Needed for BestHTTP V3 based interfaces like or

Needed for BESTMQT V3 based interfaces like

For the use of component

Needs to be set if should be used and Unity Test Framework is installed.

Needs to be set if Contact Detection should be used in the and if Unity Burst Compiler package is installed.

OPCUA (Pro)
Unity Visual Scripting
TwinCAT HMI (Pro)
MQTT (Pro)
MQTT (Pro)
TwinCAT HMI (Pro)
TwinCAT HMI (Pro)
MQTT (Pro)
MQTT (Pro)
Cutter
Test automation
Kinematic Tool
Compiler Defines (example setup - only use what is needed in your installation)