Getting Started

Video Tutorial

On first use, the AutoFields Settings window will automatically appear:

This window allows you to configure default namespaces, script folder paths, field naming styles, and automatic tracking behavior.

Settings

• Default Namespace

  Sets the base namespace used for generated scripts.

• Default Scripts Folder

  Controls where the generated C# files are placed.

  Placeholders:

  {UxmlFolder}: the generated script will be saved in the same directory as its source .uxml file.

  {Namespace}: will be replaced with Default Namespace.

  Any dots in the namespace will be replaced with the directory separator.

  Example:

  Namespace: MyCompany.Scripts.Toolkit

  Folder: Assets/Scripts/UI/{Namespace}/

  Result: Assets/Scripts/UI/MyCompany/Scripts/Toolkit/

• Track All VisualTreeAssets

  If enabled, AutoFields will track all UXML files in the project automatically. Assets labeled DoNotTrack or located in the Packages will be skipped.

• Watch *.uxml Files Changes

  Unity sometimes fails to detect changes in .uxml files — this option ensures updates are picked up reliably.

• Property Name Case

  Choose between PascalCase or camelCase for generated property names.

• Ignored Name Masks

  Exclude specific element names. Supports wildcards (*). For example, ignore-* will ignore any element whose name starts with ignore-.

• Delete Scripts for Untracked Assets

  Automatically remove scripts if their source UXML files are no longer tracked.

• Delete Scripts for Deleted Assets

  Automatically remove scripts if their source UXML files are removed.

Enabling AutoFields

To activate AutoFields functionality:

1. Review or modify the settings as needed.

2. Click the Enable AutoFields button.

3. Once enabled:

   • AutoFields will immediately generate scripts for existing UXML files if Track All VisualTreeAssets is enabled.

   • Any new or modified tracked UXML files will automatically trigger script generation according to the settings.

Next Steps

• Mark UXML file as tracked using the context menu (right click on asset in the Project window) AutoFields / Track VisualTreeAsset if Track All VisualTreeAssets is disabled

• Add name="element-name" attributes to elements in your UXML file and save it.

• Access these elements in your script by simply using the generated field or property:

  var doc = GetComponent<UIDocument>();
  var ui = new AutoGenerated.AutoFieldsSample(doc.rootVisualElement);
  ui.TestLabel.text = "Changed in Runtime";
  ui.TestButton.clicked += () => Debug.Log("Button Click");
  ui.TestButton.text = "Added Click Event in Runtime";
  

Menu

You can open the menu with a right click on the asset in the Project window and selecting AutoFields, or using the menu Asset / AutoFields

• Track VisualTreeAsset adds the asset to the tracked list

• Untrack VisualTreeAsset removes the asset from the tracked list

• VisualTreeAsset Settings opens Tracked Assets window for this asset.

Generated Class Names

Each generated script will contain a single class whose name is derived from the UXML file name. The file name is converted to a valid C# class name using PascalCase formatting. Invalid characters are removed.

For the UXML file my-settings-panel.uxml will be created MySettingsPanel.generated.cs script with class name: MySettingsPanel.

You can then use this class as a partial or base class for your UI logic, with all named elements available as strongly-typed fields or properties.