Unity Manual

https://docs.unity3d.com/6000.0/Documentation/Manual/
Admin
Unity is a powerful real-time 3D development platform used for creating games, simulations, and...
Tokens:3,115,357
Snippets:19,849
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Example: Create a license request file for Unity 2022.2.0b4

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManualActivationCmdWin.html

Example command using the default installation path for a 2022.2.0b4 Editor. Run from the computer where Unity is installed.

```powershell
"C:\Program Files\Unity\Hub\Editor\2022.2.0b4\Editor\Unity.exe" -batchmode -createManualActivationFile -logfile
```

--------------------------------

### Activate Unity license from command line (example)

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManualActivationCmdWin.html

Example command using a 2022.2.0b4 Editor installed at "C:\Program Files\Unity\Hub\Editor\2022.2.0b4\Editor\Unity.exe" and a .ulf file at "C:\Users\myAccount\Downloads\Unity_v2017.x.ulf".

```powershell
"C:\Program Files\Unity\Hub\Editor\2022.2.0b4\Editor\Unity.exe" -batchmode -manualLicenseFile "C:\Users\myAccount\Downloads\Unity_v2017.x.ulf" -logfile
```

--------------------------------

### Example list of missing dependencies generated by Unity Installer

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ent-unpriv-install.html

Example output of a missing dependencies list that the Unity Installer might generate for a standard user. Includes dependency names, download locations, local installer paths, and firewall rules that must be set.

```markdown
Dependency: Visual C++ 2010 runtime (x64)
Download location: https://www.microsoft.com/en-ca/download/details.aspx?id=26999
Local Installer: C:\Users\nonadmin\AppData\Local\Unity 2023.1.0a5\MissingDependencies\vcredist_x64_2010.exe
 
Dependency: Visual C++ 2013 runtime (x64)
Download location: https://www.microsoft.com/en-ca/download/details.aspx?id=40784
Local Installer: C:\Users\nonadmin\AppData\Local\Unity 2023.1.0a5\MissingDependencies\vcredist_x64_2013.exe
 
Dependency: Visual C++ 2015 runtime (x64)
Download location: https://www.microsoft.com/en-ca/download/details.aspx?id=48145
Local Installer: C:\Users\nonadmin\AppData\Local\Unity 2023.1.0a5\MissingDependencies\vcredist_x64_2015.exe
 
Make sure that the following rules are set:
netsh advfirewall firewall delete rule name=all program='C:\Users\nonadmin\AppData\Local\Unity 2023.1.0a5\Editor\Unity.exe'
netsh advfirewall firewall delete rule name=all program='C:\Users\nonadmin\AppData\Local\Unity 2023.1.0a5\Editor\Data\Tools\nodejs\node.exe'
netsh advfirewall firewall add rule name='Unity 2023.1.0a5 Editor' dir=in action=allow program='C:\Users\nonadmin\AppData\Local\Unity 2023.1.0a5\Editor\Unity.exe' profile=domain protocol=any
netsh advfirewall firewall add rule name='Unity 2023.1.0a5 Editor' dir=in action=block program='C:\Users\nonadmin\AppData\Local\Unity 2023.1.0a5\Editor\Unity.exe' profile=public protocol=any
```

--------------------------------

### Windows: Example path to Unity Editor

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManagingYourUnityLicense.html

Example of the <editor-installation-location> value for a default installation of Unity 2022.2.0b4. Use this path in the activation command.

```shell
C:\Program Files\Unity\Hub\Editor\2022.2.0b4\Editor\Unity.exe
```

--------------------------------

### Example: Activate Unity license on macOS

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManualActivationCmdMac.html

Example command for macOS using a Unity 2022.2.0b4 Editor installed at /Applications/Unity/Hub/Editor/2022.2.0b4/Unity.app and a .ulf file at /Users/myAccount/Downloads/Unity_v2017.x.ulf.

```shell
/Applications/Unity/Hub/Editor/2022.2.0b4/Unity.app/Contents/MacOS/Unity -batchmode -manualLicenseFile /Users/myAccount/Downloads/Unity_v2017.x.ulf -logfile
```

--------------------------------

### Example macOS activation command

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManualActivationCmdMac.html

Full example for a 2022.2.0b4 Editor installed at /Applications/Unity/Hub/Editor/2022.2.0b4/Unity.app. Run from the directory where you want the .alf file to be created.

```shell
/Applications/Unity/Hub/Editor/2022.2.0b4/Unity.app/Contents/MacOS/Unity -batchmode -createManualActivationFile -logfile
```

--------------------------------

### Sample services-config.json configuration

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ent-unpriv-install.html

Example configuration file for enabling standard user installation of Unity Editors. Uses hubDisableElevate and machineWideSecondaryInstallLocation keys.

```json
{
  "hubDisableElevate": true,
  "machineWideSecondaryInstallLocation": "C:\\UnityEditors"
}
```

--------------------------------

### Add a package using Client.Add

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/upm-api.html

Example of using Client.Add to install a package. The method returns an AddRequest, and the example checks its status to log success or error. The code is a Unity Editor script with a menu item.

```cs
using System;
using UnityEditor;
using UnityEditor.PackageManager.Requests;
using UnityEditor.PackageManager;
using UnityEngine;

namespace Unity.Editor.Example {
   static class AddPackageExample
   {
       static AddRequest Request;

       [MenuItem("Window/Add Package Example")]
       static void Add()
       {
           // Add a package to the project
           Request = Client.Add("com.unity.textmeshpro");
           EditorApplication.update += Progress;
       }

       static void Progress()
       {
           if (Request.IsCompleted)
           {
               if (Request.Status == StatusCode.Success)
                   Debug.Log("Installed: " + Request.Result.packageId);
               else if (Request.Status >= StatusCode.Failure)
                   Debug.Log(Request.Error.message);

               EditorApplication.update -= Progress;
           }
       }
   }
}
```

--------------------------------

### Run Unity Accelerator installer in unattended mode

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/accelerator-install-installer.html

Use the --mode unattended argument to run the installer without user interaction. The first example uses minimal options, while the second adds --install-dir, --storage-dir, and --tls-config none.

```bash
$ unity-accelerator-installer.run --mode unattended --admin-username mark --admin-password xxxxx
```

```bash
$ unity-accelerator-installer.run --mode unattended --admin-username mark --admin-password xxxxx --install-dir /opt/Unity/accelerator/ --storage-dir /var/lib/unity-accelerator --tls-config none
```

--------------------------------

### Git LFS version output example

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/upm-errors.html

Example output from 'git lfs --version' when Git LFS is installed. The exact version string may vary depending on your installation.

```shell
git-lfs/2.8.0 (GitHub; darwin amd64; go 1.12.7)
```

--------------------------------

### Find textures in installed packages

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/search-assets.html

Example query using the 'a' filter with 'packages' to find all textures in installed packages.

```plaintext
p: a:packages t:texture
```

--------------------------------

### Example package asset path

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/upm-assets.html

Example path for the file 'image.png' in the 'com.unity.images-library' package subfolder '/Example/Images'.

```C#
"Packages/com.unity.images-library/Example/Images/image.png"
```

--------------------------------

### UXML Button element example

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/best-practice-guides/ui-toolkit-for-advanced-unity-developers/layouts.html

Shows the syntax for a start button in UXML, using the engine:Button element with text and name attributes.

```xml
<engine:Button text="START" name="start-game__button" />
```

--------------------------------

### Install Unity component on macOS using installer command

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/InstallingUnity.html

Use this command to install other Unity components, such as platform build support. Replace the package name with the specific component package, e.g., UnitySetup-Android-Support-for-Editor-6000.0.24f1.pkg.

```shell
sudo installer [-dumplog] -package UnitySetup-Android-Support-for-Editor-6000.0.24f1.pkg -target /
```

--------------------------------

### Basic authentication example

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/upm-config-scoped.html

Example .upmconfig.toml entry using basic authentication with _auth key and optional email and alwaysAuth.

```toml
[npmAuth."http://localhost:8081/myrepository/mylocation"]
_auth = "c19kaW5pcm9AaG90bWFpbC4jb206d3FzdzVhemU9Q=="
email = "username@example.com"
alwaysAuth = true
```

--------------------------------

### Windows: Return license example

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManagingYourUnityLicense.html

Complete example of returning a Unity license on Windows using the default Editor path.

```powershell
"C:\Program Files\Unity\Hub\Editor\2022.2.0b4\Editor\Unity.exe" -quit -batchmode -returnlicense -username name@example.com -password XXXXXXXXXXXXX
```

--------------------------------

### Linux: Return license example

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManagingYourUnityLicense.html

Complete example of returning a Unity license on Linux using a typical Editor path.

```shell
/home/username/Unity/Hub/Editor/2022.2.0b4/Unity -quit -batchmode -returnlicense -username 'name@example.com' -password 'XXXXXXXXXXXXX'
```

--------------------------------

### macOS: Return license example

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManagingYourUnityLicense.html

Complete example of returning a Unity license on macOS using the default Editor path.

```shell
/Applications/Unity/Hub/Editor/2022.2.0b4/Unity.app/Contents/MacOS/Unity -quit -batchmode -returnlicense -username 'name@example.com' -password 'XXXXXXXXXXXXX'
```

--------------------------------

### Get MeshFilter component in C#

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UsingtheMeshClass.html

Use this snippet to access the MeshFilter component attached to the same GameObject. The MeshFilter is required for mesh data, and a MeshRenderer is needed to make the geometry visible. The example assigns the component to a variable in Start().

```csharp
using UnityEngine;
public class ExampleScript : MonoBehaviour
{
    MeshFilter mf;
    void Start()
    {
        //if this gameObject has a MeshFilter, mf will reference the component
        mf = GetComponent<MeshFilter>();    
    }
}
```

--------------------------------

### Asset Store filter query examples

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/search-asset-store.html

Query examples for each Asset Store filter: category, platform, price, on_sale, free, rating, release, version, and publisher. Each example uses the 'store:' token with the respective filter.

```text
store: category=audio/music
```

```text
store: platform=standaloneosxuniversal
```

```text
store: price=20
```

```text
store: on_sale=true
```

```text
store: free=true asteroid
```

```text
store: min_rating=3
```

```text
store: release=OneYearAgo
```

```text
store: version=2022
```

```text
store: publisher=Unity
```

--------------------------------

### -logFile example (Windows)

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/EditorCommandLineArguments.html

Command line example for launching Unity Editor with -projectPath and -logFile on Windows. Wrap paths with spaces in double quotes.

```bash
"C:\Program Files\Unity\Hub\Editor\<Version>\Editor\Unity.exe" -projectPath "C:\Projects\MyGame" -logFile "C:\Logs\Editor.log"
```

--------------------------------

### Example ~/.ssh/config for github.com with id_ed25519

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/upm-config-ssh-git-mac.html

Example configuration for GitHub using an ed25519 key. Replace the host and file path with your own values.

```toml
Host github.com
    UseKeychain yes
    IdentitiesOnly yes
    IdentityFile ~/.ssh/id_ed25519
```

--------------------------------

### translate examples

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UIE-Transform.html

CSS examples for the translate property, showing values in percentages and pixels.

```css
translate: 80%;
translate: 35px;
translate: 5% 10px;
translate: 24px 0%;
```

--------------------------------

### -logFile example (Linux)

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/EditorCommandLineArguments.html

Command line example for launching Unity Editor with -projectPath and -logFile on Linux. Wrap paths with spaces in double quotes.

```bash
"/opt/Unity/Hub/Editor/<Version>/Editor/Unity" -projectPath "/home/me/Projects/MyGame" -logFile "/home/me/logs/Editor.log"
```

--------------------------------

### Assembly Definition Reference by GUID

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/assembly-definition-file-format.html

Example of an Assembly Definition Reference JSON that references another assembly by its asset GUID. The GUID is prefixed with 'GUID:'.

```json
{
    "reference": "GUID:f4de40948f4904ecb94b59dd38aab8a1"
}
```

--------------------------------

### -logFile example (macOS)

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/EditorCommandLineArguments.html

Command line example for launching Unity Editor with -projectPath and -logFile on macOS. Wrap paths with spaces in double quotes.

```bash
"/Applications/Unity/Hub/Editor/<Version>/Unity.app/Contents/MacOS/Unity" -projectPath "/Users/me/Projects/MyGame" -logFile "/Users/me/Logs/Editor.log"
```

--------------------------------

### Example startup timing log output

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/embedded-linux-optional-features.html

Example Player.log output showing startup timing entries with Real and User times in milliseconds. The output includes built-in events and a custom event using the Script API.

```shell
[TIMING::STARTUP] Initial probing done: Real: 19 ms | User: 11 ms
[TIMING::STARTUP] SDL Initialized: Real: 64 ms | User: 54 ms
[TIMING::STARTUP] Scripting runtime loaded: Real: 97 ms | User: 86 ms
[TIMING::STARTUP] Plugins loaded: Real: 97 ms | User: 87 ms
[TIMING::STARTUP] Engine initialized (nogfx): Real: 104 ms | User: 94 ms
[TIMING::STARTUP] Player Prefs loaded: Real: 104 ms | User: 94 ms
[TIMING::STARTUP] Screen initialized: Real: 139 ms | User: 112 ms
[TIMING::STARTUP] Engine initialized (gfx): Real: 187 ms | User: 161 ms
[TIMING::STARTUP] Gfx initialized: Real: 190 ms | User: 163 ms
[TIMING::STARTUP] Input initialized: Real: 190 ms | User: 163 ms
[TIMING::STARTUP] SPLASH - Begin: Real: 190 ms | User: 164 ms
[TIMING::STARTUP] SPLASH - Primary scene assets loaded (async): Real: 2197 ms | User: 1670 ms
[TIMING::STARTUP] SPLASH - All engine initial states established: Real: 2197 ms | User: 1670 ms
```

```shell
[TIMING::STARTUP] HELLO!!: Real: 2198 ms | User: 1671 ms
```

--------------------------------

### Get the volume override component and check the property value

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/urp/customize/restrict-render-pass-scene-area.html

In your custom pass, use the GetComponent API to get the volume override component and check the value of the property. This example gets the MyVolumeOverride component and reads the effectEnabled property.

```cs
class myCustomPass : ScriptableRenderPass
{

    ...

    public void Setup(Material material)
    {
        // Get the volume override component
        MyVolumeOverride myOverride = VolumeManager.instance.stack.GetComponent<MyVolumeOverride>();

        // Get the value of the 'Effect Enabled' property
        bool effectStatus = myOverride.effectEnabled.overrideState ? myOverride.effectEnabled.value : false;
    }
}
```

--------------------------------

### Create a property visitor using PropertyVisitor to get properties with BindableAttribute

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/property-visitors.html

Derives from Unity.Properties.PropertyVisitor and overrides VisitProperty to collect properties that have the BindableAttribute. This is the easiest way to get started with property visitors.

```csharp
public class BindableAttribute
    : Attribute
{
}

public class GatherBindablePropertiesVisitor
    : PropertyVisitor
{
    public List<PropertyPath> BindableProperties { get; set; }

    protected override void VisitProperty<TContainer, TValue>(Property<TContainer, TValue> property, ref TContainer container, ref TValue value)
    {
        if (property.HasAttribute<BindableAttribute>())
            BindableProperties.Add(PropertyPath.AppendProperty(default, property));
    }
}
```

--------------------------------

### Create a Toolbar with C#

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UIE-uxml-element-Toolbar.html

Example demonstrating how to create a Toolbar and add a ToolbarButton and a ToolbarToggle to it.

```APIDOC
## Create a Toolbar with C#

### Description
Creates a Toolbar and adds a ToolbarButton and a ToolbarToggle to it.

### C# Example
```cs
using UnityEditor.UIElements;
...
var toolbar = new Toolbar();
var button = new ToolbarButton(() => { Debug.Log("Button clicked"); }) { text = "Click me" };
toolbar.Add(button);
toolbar.Add(new ToolbarToggle() { text = "Toggle me" });
```

### C# Class
`Toolbar`

### Namespace
`UnityEditor.UIElements`

### Base Class
`VisualElement`

### Inherited UXML Attributes

#### From VisualElement
- `focusable` (boolean) - If false, prevents the element from being focused.
- `tabindex` (int) - Integer used to sort focusable elements in the focus ring. Must be >= 0.
- `content-container` (string) - Logical container where child elements are added.
- `data-source` (Object) - Assigns a data source to this VisualElement.
- `data-source-path` (string) - Path from the data source to the value.
- `data-source-type` (System.Type) - Possible type of data source assignable to this VisualElement.
- `enabled` (boolean) - Returns true if the VisualElement is enabled locally.
- `language-direction` (UIElements.LanguageDirection) - Indicates the directionality of the element's text.
- `name` (string) - The name of this VisualElement.
```

--------------------------------

### ContextualMenuDemo Example

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UIE-contextual-menus.html

Complete example of creating a custom Editor window with two labels and adding contextual menus to each label. Demonstrates adding, inserting, and replacing menu items.

```csharp
using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;

public class ContextualMenuDemo : EditorWindow
{
    [MenuItem("Window/ContextualMenuDemo")]
    public static void ShowExample()
    {
        ContextualMenuDemo wnd = GetWindow<ContextualMenuDemo>();
        wnd.titleContent = new GUIContent("ContextualMenuDemo");
    }

    public void CreateGUI()
    {
        VisualElement root = rootVisualElement;
        VisualElement label = new Label("Right click me!");
        root.Add(label);

        AddANewContextMenu(label);
        InsertIntoAnExistingMenu(label);

        VisualElement second = new Label("Click me also!");
        root.Add(second);

        AddANewContextMenu(second);
        InsertIntoAnExistingMenu(second);

        // Override the default behavior by clearing the menu.
        ReplaceContextMenu(second);
    }

    void AddANewContextMenu(VisualElement element)
    {
        // The manipulator handles the right click and sends a ContextualMenuPopulateEvent to the target element.
        // The callback argument passed to the constructor is automatically registered on the target element.
        element.AddManipulator(new ContextualMenuManipulator((evt) =>
        {
            evt.menu.AppendAction("First menu item", (x) => Debug.Log("First!!!!"), DropdownMenuAction.AlwaysEnabled);
            evt.menu.AppendAction("Second menu item", (x) => Debug.Log("Second!!!!"), DropdownMenuAction.AlwaysEnabled);
        }));
    }

    void InsertIntoAnExistingMenu(VisualElement element)
    {
        element.RegisterCallback<ContextualMenuPopulateEvent>((evt) =>
        {
            evt.menu.AppendSeparator();
            evt.menu.AppendAction("Another action", (x) => Debug.Log("Another Action!!!!"), DropdownMenuAction.AlwaysEnabled);
        });
    }

    void ReplaceContextMenu(VisualElement element)
    {
        element.RegisterCallback<ContextualMenuPopulateEvent>((evt) =>
        {
            evt.menu.ClearItems();
            evt.menu.AppendAction("The only action", (x) => Debug.Log("The only action!"), DropdownMenuAction.AlwaysEnabled);
        });
    }
}
```

--------------------------------

### ExtractMyCounterValue

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/profiler-creating-custom-counters.html

C# example showing how to get an integer counter value from a FrameDataView using the counter name.

```APIDOC
## ExtractMyCounterValue

### Description
This method extracts an integer counter value from a given FrameDataView using the counter name. It first obtains the marker ID for the counter name, then retrieves the counter value as an integer.

### Method
C# method

### Signature
`static int ExtractMyCounterValue(FrameDataView frameData, string counterName)`

### Parameters
- **frameData** (FrameDataView) - Required - The frame data view from which to extract the counter value.
- **counterName** (string) - Required - The name of the counter to retrieve.

### Returns
- **int** - The counter value as an integer.

### Example
```cs
using UnityEditor.Profiling;

class Example
{
    static int ExtractMyCounterValue(FrameDataView frameData, string counterName)
    {
        var counterMarkerId = frameData.GetMarkerId(counterName);
        return frameData.GetCounterValueAsInt(counterMarkerId);
    }
}
```

### Related Methods
- `FrameDataView.GetCounterValueAsLong`
- `FrameDataView.GetCounterValueAsFloat`
- `FrameDataView.GetCounterValueAsDouble`
```

--------------------------------

### InputDevices.GetDevicesAtXRNode

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/xr_input.html

Gets a list of input devices associated with a specific XRNode. The example demonstrates retrieving a left-handed controller.

```APIDOC
## InputDevices.GetDevicesAtXRNode

### Description
Gets a list of input devices associated with a specific XRNode. The example demonstrates retrieving a left-handed controller.

### Method
GetDevicesAtXRNode

### Signature
`public static void GetDevicesAtXRNode(XRNode xrNode, List<InputDevice> inputDevices)`

### Parameters
- **xrNode** (XRNode) - Required - The XR node to query devices for.
- **inputDevices** (List<InputDevice>) - Required - The list to populate with the devices found.

### Example
```cs
var leftHandDevices = new List<UnityEngine.XR.InputDevice>();
UnityEngine.XR.InputDevices.GetDevicesAtXRNode(UnityEngine.XR.XRNode.LeftHand, leftHandDevices);

if(leftHandDevices.Count == 1)
{
    UnityEngine.XR.InputDevice device = leftHandDevices[0];
    Debug.Log(string.Format("Device name '{0}' with role '{1}'", device.name, device.role.ToString()));
}
else if(leftHandDevices.Count > 1)
{
    Debug.Log("Found more than one left hand!");
}
```

### Notes
- The XRNode enumeration defines nodes such as CenterEye, GameController, HardwareTracker, Head, LeftEye, LeftHand, RightEye, RightHand, and TrackingReference.
```

--------------------------------

### Partial stack trace example indicating stripped native symbols

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/TroubleShootingIPhone.html

Example of a partial stack trace displayed in the debugger console, showing only the start of the main thread. This indicates that native symbols were stripped during the release build.

```plain
Thread 1 (thread 11523): 

1. 0 0x0062564c in start ()
```

--------------------------------

### launchUnityHub.cmd - Set proxy environment variables and launch Unity Hub

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ent-proxy-cmd-file.html

Use this command file to launch Unity Hub with the required proxy environment variables. Adjust the proxy credentials, server names, and paths as needed. The file sets HTTP_PROXY, HTTPS_PROXY, and optionally NO_PROXY and NODE_EXTRA_CA_CERTS, then starts Unity Hub. Ensure the path to Unity Hub is correct and use double quotes if it contains spaces.

```shell
@echo off
REM *** NOTE: Add the next 3 lines only if you’re not using Automatic Proxy Configuration
set HTTP_PROXY=http://<username>:<password>@<proxy_name_or_IP_address>:8080
set HTTPS_PROXY=http://<username>:<password>@<proxy_name_or_IP_address>:8080
set NO_PROXY=<licensing_server_name_or_IP_address>
REM *** NOTE: Add the following line only if your web proxy uses SSL inspection
set NODE_EXTRA_CA_CERTS=<path_to_pem_file>
start "" "C:\Program Files\Unity Hub\Unity Hub.exe"
```

--------------------------------

### CORS headers example for Unity Web

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/webgl-networking.html

Example of Access-Control headers to add to HTTP responses, allowing Unity Web to access resources from any origin. Includes common request headers and allows GET, POST, or OPTIONS methods.

```text
"Access-Control-Allow-Credentials": "true",
"Access-Control-Allow-Headers": "Accept, X-Access-Token, X-Application-Name, X-Request-Sent-Time",
"Access-Control-Allow-Methods": "GET, POST, OPTIONS",
"Access-Control-Allow-Origin": "*",
```

--------------------------------

### PopupExample.cs - Create Editor window and show pop-up

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UIE-create-a-popup-window.html

C# script that creates a custom Editor window with a menu item. It loads the UXML file, clones it to the root visual element, and attaches a click handler to the button that shows the pop-up window using PopupWindow.Show().

```cs
using UnityEditor;
using UnityEngine.UIElements;
using PopupWindow = UnityEditor.PopupWindow;
    
public class PopupExample : EditorWindow
{
     //Add menu item
     [MenuItem("Examples/Popup Example")]
     static void Init()
     {
          EditorWindow window = EditorWindow.CreateInstance<PopupExample>();
          window.Show();
     }
    
     private void CreateGUI()
     {
          var visualTreeAsset = AssetDatabase.LoadAssetAtPath<VisualTreeAsset>("Assets/Editor/PopupExample.uxml");
          visualTreeAsset.CloneTree(rootVisualElement);
    
          var button = rootVisualElement.Q<Button>();
          button.clicked += () => PopupWindow.Show(button.worldBound, new PopupContentExample());
     }
}
```

--------------------------------

### Linux: Default Unity Editor path

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManagingYourUnityLicense.html

Example of the <unity-command-location> when Unity Editor is installed to the home directory via Unity Hub.

```shell
/home/<username>/Unity/Hub/Editor/<version>/Unity
```

--------------------------------

### Assembly Definition JSON with GUIDs and excludePlatforms

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/assembly-definition-file-format.html

Example Assembly Definition JSON using assembly GUIDs for references and the excludePlatforms key to specify an array of excluded platforms. Includes settings such as allowUnsafeCode, overrideReferences, precompiledReferences, autoReferenced, defineConstraints, versionDefines, and noEngineReferences.

```yml
{
    "name": "BeeAssembly",
    "references": [
        "GUID:17b36165d09634a48bf5a0e4bb27f4bd",
        "GUID:b470eee7144904e59a1064b70fa1b086",
        "GUID:2bafac87e7f4b9b418d9448d219b01ab",
        "GUID:27619889b8ba8c24980f49ee34dbb44a",
        "GUID:0acc523941302664db1f4e527237feb3"
    ],
    "includePlatforms": [],
    "excludePlatforms": [
        "iOS",
        "macOSStandalone",
        "tvOS"
    ],
    "allowUnsafeCode": false,
    "overrideReferences": true,
    "precompiledReferences": [
        "Newtonsoft.Json.dll",
        "nunit.framework.dll"
    ],
    "autoReferenced": false,
    "defineConstraints": [
        "UNITY_2019",
        "UNITY_INCLUDE_TESTS"
    ],
    "versionDefines": [
        {
            "name": "com.unity.ide.vscode",
            "expression": "[1.7,2.4.1]",
            "define": "MY_SYMBOL"
        },
        {
            "name": "com.unity.test-framework",
            "expression": "[2.7.2-preview.8]",
            "define": "TESTS"
        }
    ],
    "noEngineReferences": false
}
```

--------------------------------

### Create a BindableElement

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UIE-uxml-element-BindableElement.html

C# example demonstrating how to create a BindableElement instance.

```APIDOC
## Create a BindableElement

### Description
Creates a new BindableElement instance.

### C# Example
```cs
var bindableElement = new BindableElement();
```

### C# Class
`BindableElement`

### Namespace
`UnityEngine.UIElements`

### Base Class
`VisualElement`
```

--------------------------------

### TransitionExample.cs - C# script for UI Toolkit transition

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UIE-transition-example.html

Replace the contents of TransitionExample.cs with this code. It creates a Label, sets a transition duration of 3 seconds, and registers pointer over/out events to rotate and scale the label on hover. The script also instantiates a UXML asset and unregisters callbacks in OnDisable.

```csharp
using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;
using System.Collections.Generic;

public class TransitionExample : EditorWindow
{
    [SerializeField]
    VisualTreeAsset m_VisualTreeAsset;

    [MenuItem("Window/UI Toolkit/TransitionExample")]
    public static void ShowExample()
    {
        TransitionExample wnd = GetWindow<TransitionExample>();
        wnd.titleContent = new GUIContent("Transition Example");
    }

    public void CreateGUI()
    {
        // Each editor window contains a root VisualElement object.
        VisualElement root = rootVisualElement;

        // VisualElements objects can contain other VisualElement following a tree hierarchy.
        cSharpLabel = new Label("Hello World! From C#");
        root.Add(cSharpLabel);

        // Create transition on the new Label.
        cSharpLabel.style.transitionDuration = new List<TimeValue>{ new TimeValue(3) };

        // Record default rotate and scale values.
        defaultRotate = cSharpLabel.resolvedStyle.rotate;
        defaultScale = cSharpLabel.resolvedStyle.scale;

        // Set up event handlers to simulate the use of the :hover pseudo-class.
        cSharpLabel.RegisterCallback<PointerOverEvent>(OnPointerOver);
        cSharpLabel.RegisterCallback<PointerOutEvent>(OnPointerOut);

        // Instantiate UXML
        VisualElement labelFromUXML = m_VisualTreeAsset.Instantiate();
        root.Add(labelFromUXML);
    }

    // The Label created with C#.
    VisualElement cSharpLabel;

    // The default rotate and scale values for the new Label.
    Rotate defaultRotate;
    Scale defaultScale;

    void OnPointerOver(PointerOverEvent evt)
    {
        SetHover(evt.currentTarget as VisualElement, true);
    }

    void OnPointerOut(PointerOutEvent evt)
    {
        SetHover(evt.currentTarget as VisualElement, false);
    }

    // When the user enters or exits the Label, set the rotate and scale.
    void SetHover(VisualElement label, bool hover)
    {
        label.style.rotate = hover ? new(Angle.Degrees(10)) : defaultRotate;
        label.style.scale = hover ? new Vector2(1.1f, 1) : defaultScale;
    }

    // Unregister all event callbacks.
    void OnDisable()
    {
        cSharpLabel.UnregisterCallback<PointerOverEvent>(OnPointerOver);
        cSharpLabel.UnregisterCallback<PointerOutEvent>(OnPointerOut);
    }
}
```

--------------------------------

### Activate Unity license from command line (template)

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManualActivationCmdWin.html

Run this command from the computer where Unity is installed, as an administrator. Replace <editor-installation-location> and <yourLicenseFile> with the full paths to Unity.exe and the license file (.ulf or .xml). This command does not return output to the Command Prompt.

```powershell
"<editor-installation-location>" -batchmode -manualLicenseFile <yourLicenseFile> -logfile
```

--------------------------------

### Create launchUnityHub.command with proxy environment variables

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ent-proxy-cmd-file.html

Run this command in Terminal to create an executable script that sets HTTP_PROXY, HTTPS_PROXY, NO_PROXY, and optionally NODE_EXTRA_CA_CERTS, then launches Unity Hub. Adjust the environment variables and Hub path as needed. Use double quotes around the path if it contains spaces.

```bash
echo '#!/usr/bin/env bash
# *** NOTE: Add the next 3 lines only if you’re not using Automatic Proxy Configuration
export HTTP_PROXY=http://<username>:<password>@<proxy_name_or_IP_address>:8080
export HTTPS_PROXY=http://<username>:<password>@<proxy_name_or_IP_address>:8080
export NO_PROXY=<licensing_server_name_or_IP_address>
# *** NOTE: Add the following line only if your web proxy uses SSL inspection
export NODE_EXTRA_CA_CERTS=<path_to_pem_file>
nohup "/Applications/Unity Hub.app/Contents/MacOS/Unity Hub" &>/dev/null &' > launchUnityHub.command
```

--------------------------------

### - (void)runEmbeddedWithArgc:(int)argc argv:(char*[])argv appLaunchOpts:(NSDictionary*)appLaunchOpts;

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UnityasaLibrary-iOS.html

Call this method when you need to run Unity when other Views exist.

```APIDOC
## - (void)runEmbeddedWithArgc:(int)argc argv:(char*[])argv appLaunchOpts:(NSDictionary*)appLaunchOpts;

### Description
Call this method when you need to run Unity when other Views exist.

### Method
- (void)runEmbeddedWithArgc:(int)argc argv:(char*[])argv appLaunchOpts:(NSDictionary*)appLaunchOpts;

### Parameters
- **argc** (int) - Required - The argument count.
- **argv** (char*[]) - Required - The argument vector.
- **appLaunchOpts** (NSDictionary*) - Required - The launch options dictionary.
```

--------------------------------

### InputDevices.GetDevicesWithRole

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/xr_input.html

Retrieves a list of input devices that match a specified InputDeviceRole. The example demonstrates getting all connected GameController devices and logging their names and roles.

```APIDOC
## InputDevices.GetDevicesWithRole

### Description
Retrieves a list of input devices that match a specified InputDeviceRole. The example demonstrates getting all connected GameController devices and logging their names and roles.

### Method
GetDevicesWithRole

### Endpoint
UnityEngine.XR.InputDevices.GetDevicesWithRole(InputDeviceRole role, List<InputDevice> devices)

### Parameters
- **role** (InputDeviceRole) - Required - The device role to filter by. Possible values: GameController, Generic, HardwareTracker, LeftHanded, RightHanded, TrackingReference.
- **devices** (List<InputDevice>) - Required - The list to populate with the matching devices.

### Request Example
```cs
var gameControllers = new List<UnityEngine.XR.InputDevice>();
UnityEngine.XR.InputDevices.GetDevicesWithRole(UnityEngine.XR.InputDeviceRole.GameController, gameControllers);

foreach (var device in gameControllers)
{
    Debug.Log(string.Format("Device name '{0}' has role '{1}'", device.name, device.role.ToString()));
}
```

### Response
#### Success Response
- **devices** (List<InputDevice>) - The list is populated with the devices that match the specified role.

#### Response Example
```cs
// The gameControllers list is populated with InputDevice objects.
// Each device has a name and role property.
```
```

--------------------------------

### Export UnityPluginLoad and access IUnityGraphics

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/native-plugin-interface-introduction.html

Minimal example showing how to export UnityPluginLoad and use IUnityInterfaces to get the IUnityGraphics interface. Include IUnityInterface.h and IUnityGraphics.h.

```cpp
#include "IUnityInterface.h"
#include "IUnityGraphics.h"
// Unity plugin load event
extern "C" void UNITY_INTERFACE_EXPORT UNITY_INTERFACE_API
    UnityPluginLoad(IUnityInterfaces* unityInterfaces)
{
    IUnityGraphics* graphics = unityInterfaces->Get<IUnityGraphics>();
}
```

--------------------------------

### Get Application Cache Directory with AndroidApplication

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/android-high-level-api-code-examples.html

Use this snippet to retrieve the cache directory of the current Android application. It accesses the current activity via AndroidApplication.currentActivity, calls getCacheDir() to get a File object, and then getCanonicalPath() to return the path as a string. This example is for reference; prefer Application.temporaryCachePath and Application.persistentDataPath in production.

```C#
using UnityEngine;
using UnityEngine.Android;

public class JavaExamples
{
    public static string GetApplicationCacheDirectory()
    {
        using var javaFile = AndroidApplication.currentActivity.Call<AndroidJavaObject>("getCacheDir");
        var cacheDirectory = javaFile.Call<string>("getCanonicalPath");
        return cacheDirectory;
    }
}
```

--------------------------------

### C#: Customize IntegerField functionality

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UIE-uxml-element-IntegerField.html

C# example that gets a reference to the UXML field, creates a new disabled field with a style class, and mirrors the value changes.

```csharp
// Get a reference to the field from UXML and assign a value to it.
var uxmlField = container.Q<IntegerField>("the-uxml-field");
uxmlField.value = 42;

// Create a new field, disable it, and give it a style class.
var csharpField = new IntegerField("C# Field");
csharpField.SetEnabled(false);
csharpField.AddToClassList("some-styled-field");
csharpField.value = uxmlField.value;
container.Add(csharpField);

// Mirror the value of the UXML field into the C# field.
uxmlField.RegisterCallback<ChangeEvent<int>>((evt) =>
{
    csharpField.value = evt.newValue;
});
```

--------------------------------

### Get current summary metrics with AsyncReadManagerMetrics.GetCurrentSummaryMetrics

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/AsyncReadManagerMetrics.html

Returns a summary of all metrics collected since the last clear. The example uses the ClearOnRead flag and is guarded by ENABLE_PROFILER and UNITY_2020_2_OR_NEWER.

```csharp
#if ENABLE_PROFILER && UNITY_2020_2_OR_NEWER
    AsyncReadManagerSummaryMetrics summaryOfMetrics 
        = AsyncReadManagerMetrics.GetCurrentSummaryMetrics(AsyncReadManagerMetrics.Flags.ClearOnRead);
#endif
```

--------------------------------

### TestScript: MonoBehaviour that triggers EX0001 warning

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/create-roslyn-analyzer.html

A simple MonoBehaviour that calls Debug.Log in Start, which should trigger the EX0001 warning from the analyzer. Use this to verify the analyzer is working after setup.

```csharp
using UnityEngine;

public class TestScript : MonoBehaviour
{
    void Start()
    {
        Debug.Log("Hello world"); // Should trigger EX0001 warning
    }
}
```

--------------------------------

### C# build script for QNX using BuildPipeline.BuildPlayer

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/qnx-build-command-line.html

Place this script in Assets/Editor/ and call its Build() method via -executeMethod. It sets QNX version and architecture, configures build options, and triggers the build. Logs success or failure based on the build report.

```csharp
using UnityEditor;
using UnityEditor.Build.Reporting;
using UnityEngine;

public class Builder
{
    private static void BuildQNX(QNXOsVersion qnxVersion, QNXArchitecture architecture)
    {
        // Set QNX version in BuildSettings
        EditorUserBuildSettings.selectedQnxOsVersion = qnxVersion;

        // Set architecture in BuildSettings
        EditorUserBuildSettings.selectedQnxArchitecture = architecture;

        // Setup build options (e.g. scenes, build output location)
        var options = new BuildPlayerOptions
        {
            // Change to scenes from your project
            scenes = new[]
            {
                "Assets/Scenes/SampleScene.unity",
            },
            // Change to location the output should go
            locationPathName = "../QNXPlayer/",
            options = BuildOptions.CleanBuildCache | BuildOptions.StrictMode,
            target = BuildTarget.QNX
        };

        var report = BuildPipeline.BuildPlayer(options);

        if (report.summary.result == BuildResult.Succeeded)
        {
            Debug.Log($"Build successful - Build written to {options.locationPathName}");
        }
        else if (report.summary.result == BuildResult.Failed)
        {
            Debug.LogError($"Build failed");
        }
    }

    // This function will be called from the build process
    public static void Build()
    {
        // Build QNX 7.1 ARM64 Unity player
        BuildQNX(QNXOsVersion.Neutrino71, QNXArchitecture.Arm64);
    }
}
```

--------------------------------

### MainPage.xaml.cpp - Initialize Unity rendering and events

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/windowsstore-appcallbacks.html

Shows the MainPage constructor. It gets the AppCallbacks instance, checks for holographic support, and either initializes the view manager for holographic or sets up the swap chain panel, core window events, and D3D XAML initialization for standard XAML. It also handles splash screen removal and window resize events.

```cpp
MainPage::MainPage()
{
    m_SplashScreenRemovalEventToken.Value = 0;
    m_OnResizeRegistrationToken.Value = 0;

    InitializeComponent();
    NavigationCacheMode = ::NavigationCacheMode::Required;

    auto appCallbacks = AppCallbacks::Instance;

    bool isWindowsHolographic = false;

#if UNITY_HOLOGRAPHIC
    // If application was exported as Holographic check if the device actually supports it
    // Otherwise, we treat this as a normal XAML application
    isWindowsHolographic = AppCallbacks::IsMixedRealitySupported();
#endif

    if (isWindowsHolographic)
    {
        appCallbacks->InitializeViewManager(Window::Current->CoreWindow);
    }
    else
    {
        m_SplashScreenRemovalEventToken = appCallbacks->RenderingStarted += ref new RenderingStartedHandler(this, &MainPage::RemoveSplashScreen);

        appCallbacks->SetSwapChainPanel(m_DXSwapChainPanel);
        // Subscribes to all needed system events
        appCallbacks->SetCoreWindowEvents(Window::Current->CoreWindow);

        // This is the main initialization function for Unity
        // Initializes engine graphics, DirectX, and gamepad and joystick input
        // Loads IL2CPP and all engine subsystems except graphics
        appCallbacks->InitializeD3DXAML();
        // At this point, when Unity finishes loading the first level, it enters the main loop.

        m_SplashScreen = safe_cast<App^>(App::Current)->GetSplashScreen();

        auto dispatcher = CoreWindow::GetForCurrentThread()->Dispatcher;
        ThreadPool::RunAsync(ref new WorkItemHandler([this, dispatcher](IAsyncAction^)
        {
            GetSplashBackgroundColor(dispatcher);
        }));

        OnResize();

        m_OnResizeRegistrationToken = Window::Current->SizeChanged += ref new WindowSizeChangedEventHandler([this](Object^, WindowSizeChangedEventArgs^)
        {
            OnResize();
        });
    }
}
```

--------------------------------

### Get summary of metrics array with AsyncReadManagerMetrics.GetSummaryOfMetrics

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/AsyncReadManagerMetrics.html

Retrieves an array of request metrics via GetMetrics and then summarizes them with GetSummaryOfMetrics. The example uses the ClearOnRead flag and is guarded by ENABLE_PROFILER and UNITY_2020_2_OR_NEWER.

```csharp
#if ENABLE_PROFILER && UNITY_2020_2_OR_NEWER
    AsyncReadManagerRequestMetric[] metrics 
        = AsyncReadManagerMetrics.GetMetrics(AsyncReadManagerMetrics.Flags.ClearOnRead);
    AsyncReadManagerSummaryMetrics summaryOfMetrics 
        = AsyncReadManagerMetrics.GetSummaryOfMetrics(metrics);
#endif
```

--------------------------------

### -logFile example (Windows)

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/PlayerCommandLineArguments.html

Example of using -logFile on Windows to specify a log file path. The path is wrapped in double quotes because it contains spaces.

```command line
"C:\Users\me\Builds\MyGame\MyGame.exe" -logFile "C:\Logs\Player.log"
```

--------------------------------

### Get the Horizontal axis value with Input.GetAxis

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/class-InputManager.html

Use Input.GetAxis with the axis name to retrieve the current value of a virtual axis. The example stores the Horizontal axis value in a float variable.

```csharp
float horizontalInput = Input.GetAxis ("Horizontal"); 
```

--------------------------------

### Pass -platform-android-jobworker-affinity argument via adb

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/android-custom-activity-command-line.html

This example passes the -platform-android-jobworker-affinity argument with value 'little' to run Unity job worker threads on little cores. It uses the android.intent.action.MAIN action to start the activity.

```shell
adb shell am start -a android.intent.action.MAIN -n "com.Company.MyGame/com.unity3d.player.UnityPlayerActivity" -e unity \"-platform-android-jobworker-affinity little\"
```

--------------------------------

### Unity CLI command to build for QNX

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/qnx-build-command-line.html

Run this command to start Unity in batch mode and build the project for QNX. Requires QNX_TARGET and QNX_HOST to be set. The -executeMethod Builder.Build calls the build script.

```shell
Unity -quit -batchmode -nographics -buildTarget QNX -executeMethod Builder.Build -projectPath <path-to-unity-project-root>
```

--------------------------------

### Linux Example 1: Named User License Activation Without Serial Key

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManagingYourUnityLicense.html

Activates a named user license without a serial key. Replace the path with your Unity Editor installation path.

```shell
/home/username/Unity/Hub/Editor/2022.2.0b4/Unity -quit -batchmode -serial -username 'name@example.com' -password 'XXXXXXXXXXXXX'
```

--------------------------------

### Windows: Launch Unity and activate license

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/ManagingYourUnityLicense.html

Use this command in the Command Prompt to launch Unity and activate your license. Replace <editor-installation-location> with the full path to your Unity Editor application. Ensure the license file folder exists and you have write permission.

```powershell
"<editor-installation-location>" -quit -batchmode -serial E3-XXXX-XXXX-XXXX-XXXX-XXXX -username name@example.com -password XXXXXXXXXXXXX
```

--------------------------------

### Create ExampleObject.cs ScriptableObject with CreateProperty

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/UIE-get-started-runtime-binding.html

Defines a ScriptableObject named ExampleObject with a string property simpleLabel marked with [CreateProperty] for binding. Requires Unity.Properties and UnityEditor (in editor).

```csharp
using Unity.Properties;
using UnityEngine;
using UnityEngine.UIElements;

#if UNITY_EDITOR
using UnityEditor;
#endif

[CreateAssetMenu]
public class ExampleObject : ScriptableObject
{
    [Header("Simple binding")]
    [CreateProperty]
    public string simpleLabel = "Hello World!";
}
```

--------------------------------

### Unity C# script calling JavaScript functions from .jslib

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/web-interacting-browser-js.html

A C# script that uses DllImport("__Internal") to declare external functions Hello and HelloString, then calls them in Start(). This pairs with the .jslib example above.

```C#
using UnityEngine;
using System.Runtime.InteropServices;

public class NewBehaviourScript : MonoBehaviour {

    [DllImport("__Internal")]
    private static extern void Hello();

    [DllImport("__Internal")]
    private static extern void HelloString(string str);

    void Start() {
        Hello();
        HelloString("This is a string.");
    }
}
```

--------------------------------

### Run Unity Accelerator installer in text mode

Source: https://docs.unity3d.com/6000.0/Documentation/Manual/accelerator-install-installer.html

Run the installer in interactive text mode using --mode text. This mode is available only for Linux and macOS.

```bash
$ sudo ./unity-accelerator-installer.run --mode text
```
Tokens:
Raw