Unity Editor Foundations

https://www.foundations.unity.com
Admin
Official guidance for building intuitive and engaging experiences for the Unity Editor, covering...
Tokens:65,596
Snippets:1,389
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Delayed Fields Examples

Source: https://www.foundations.unity.com/components/numeric-field

Examples of delayed integer, float, and double fields in Unity's Editor GUI.

```csharp
EditorGUI.DelayedIntField
EditorGUI.Delayed
IntField
```

```csharp
EditorGUI.DelayedFloatField
EditorGUI.Delayed
FloatField
```

```csharp
EditorGUI.DelayedDoubleField
EditorGUI.Delayed
DoubleField
```

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

### Scripting references for IMGUI Help Box

Source: https://www.foundations.unity.com/components/help-box

Provides a link to the Unity Scripting API documentation for the EditorGUI.HelpBox function in IMGUI.

```Unity Scripting API
Unity - Scripting API: 
EditorGUI.HelpBox
docs.unity3d.com
```

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

### Multi-column tree view example

Source: https://www.foundations.unity.com/components/multi-column-views

This example demonstrates how to create columns for a multi-column tree view using `MultiColumnHeaderState.Column` and set various properties like header content, alignment, sorting, and width.

```csharp
var columnList = new List<MultiColumnHeaderState.Column>();

// Create 10 columns where the text of each column is its index (i)
for (var i = 0; i < 10; i++)
{
      columnList.Add(new MultiColumnHeaderState.Column
       {
           headerContent = i,
           headerTextAlignment = TextAlignment.Left,
           sortedAscending = true,
           sortingArrowAlignment = TextAlignment.Left,
           width = 100,
           minWidth = 30,
           autoResize = true
       })
}
```

```csharp
MultiColumnHeaderState columnState = new MultiColumnHeaderState(columnList);
```

```csharp
MultiColumnHeader header = new MultiColumnHeader(columnState);
```

```csharp
TreeView treeView = new TreeView(..., header);
```

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

### ShowTab

Source: https://www.foundations.unity.com/patterns/windowing

Shows a docked Editor window.

```csharp
EditorWindow.ShowTab
```

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

### IMGUI EndScrollView

Source: https://www.foundations.unity.com/components/scroll-view

Ends a scrollview started with a call to BeginScrollView.

```csharp
EditorGUILayout.EndScrollView
```

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

### IMGUI Foldout Scripting Reference

Source: https://www.foundations.unity.com/components/foldout

Scripting API reference for the EditorGUI.Foldout function in IMGUI.

```UnityScript
IMGUI
EditorGUI.Foldout
Unity - Scripting API:  
EditorGUI.Foldout
docs.unity3d.com
```

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

### Scripting references for UI Toolkit Help Box

Source: https://www.foundations.unity.com/components/help-box

Provides a link to the Unity Scripting API documentation for the HelpBox component in UI Toolkit.

```Unity Scripting API
Unity - Scripting API: 
HelpBox
docs.unity3d.com
```

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

### Delayed Text Field (IMGUI)

Source: https://www.foundations.unity.com/components/text-field

Example of using a delayed text field in IMGUI.

```csharp
EditorGUI.DelayedTextField
```

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

### IMGUI Foldout

Source: https://www.foundations.unity.com/components/foldout

Instantiates a foldout in IMGUI.

```csharp
EditorGUI.Foldout
Instantiates a foldout
Docs ->
```

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

### IMGUI Single-line Text Field

Source: https://www.foundations.unity.com/components/text-field

Example of creating a single-line text field using IMGUI.

```csharp
EditorGUILayout.TextField
```

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

### Scripting API for Dialogs

Source: https://www.foundations.unity.com/patterns/errors-and-messaging

Examples of Unity's Scripting API for displaying different types of dialog boxes.

```csharp
DisplayAlertDialog
Dialog with one button ok
Unity Docs ->
DisplayDecisionDialog
Dialogs with two buttons ok / cancel
Unity Docs ->
DisplayComplexDecision  
Dialog
Dialogs with three buttons ok / alt / cancel
Unity Docs ->
```

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

### Helpbox with Call-to-Action Elements

Source: https://www.foundations.unity.com/components/help-box

Illustrates how to embed hyperlinks and use specific tags for call-to-action elements within Helpboxes in the UI Toolkit.

```html
Hyperlinks can be embedded directly in the body text using the <a> tag with an href attribute to specify the destination, without requiring additional UI components.
To track analytics on a link click, you must use the `<link>` tag (supported in UITK rich text) instead of `<a>`. This tag does _not_ open a URL automatically; instead, it fires a standard event that you can listen to in C#, allowing you to record the analytics event _before_ manually opening the URL.
In the UITK framework, a Helpbox can include one Button and one Link element as separate UI components.
```

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

### IMGUI EditorGUI.HelpBox API

Source: https://www.foundations.unity.com/components/help-box

This snippet demonstrates how to create a help box with a message using the EditorGUI.HelpBox method in Unity's IMGUI system.

```csharp
EditorGUI.HelpBox
Makes a help box with a message to the user
```

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

### IMGUI Multi-line Text Area

Source: https://www.foundations.unity.com/components/text-field

Example of creating a multi-line text field (text area) using IMGUI.

```csharp
EditorGUILayout.TextArea
```

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

### Multi-column tree view UXML

Source: https://www.foundations.unity.com/components/multi-column-views

Example UXML code for defining a multi-column tree view with 'Name' and 'Populated?' columns.

```UXML
<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../../UIElementsSchema/UIElements.xsd" editor-extension-mode="False">
    <ui:MultiColumnTreeView fixed-item-height="20">
        <!-- Columns and Column aren't Visual Elements or controls; they are considered attributes of MultiColumnListView. -->
        <ui:Columns>
            <ui:Column name="name" title="Name" width="120" />
            <ui:Column name="populated" title="Populated?" width="80" />
        </ui:Columns>
    </ui:MultiColumnTreeView>
</ui:UXML>
```
Tokens:
Raw