Unity 6.6 Script Reference

https://docs.unity3d.com/6.6/ScriptReference/
Admin
Unity 6.6 Script Reference is the official API documentation for Unity's scripting API, providing...
Tokens:27,156
Snippets:582
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### SceneSetup

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The setup information for a Scene in the SceneManager. This cannot be used in Play Mode.

```APIDOC
## SceneSetup

### Description
Contains setup information for a Scene within the SceneManager. Note: This class is not usable in Play Mode.

### Usage
Primarily used for editor-time scene management and configuration.
```

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

### ProcessService

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Allows you to start slave instances of UnityEditor, opened to the same Project as the master instance, with a specific RoleProviderAttribute.

```APIDOC
## Class: ProcessService

### Description
*This is an experimental feature.* The ProcessService allows you to start slave instances of UnityEditor, opened to the same Project as the master instance, with a specific RoleProviderAttribute.

### Usage
This experimental API can be used to launch and manage additional Unity Editor instances for specific tasks.
```

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

### PostProcessBuildAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Attribute to get a notification just after building the player.

```APIDOC
## Attribute: PostProcessBuildAttribute

### Description
Add this attribute to a method to get a notification just after building the player.

### Usage
Apply this attribute to methods that need to execute logic immediately following a player build.
```

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

### PostProcessSceneAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Attribute to get a notification just after building the Scene.

```APIDOC
## Attribute: PostProcessSceneAttribute

### Description
Add this attribute to a method to get a notification just after building the Scene.

### Usage
Use this attribute on methods that require execution after a Scene has been built.
```

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

### SceneViewCameraWindow

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Use this class to instantiate a SceneViewCameraWindow window.

```APIDOC
## SceneViewCameraWindow

### Description
Provides functionality to instantiate and manage SceneViewCameraWindow windows.

### Usage
Create and display dedicated camera windows for scene inspection.
```

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

### SettingsService

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This class provides global APIs to interact with the Settings window.

```APIDOC
## Class: SettingsService

### Description
This class provides global APIs to interact with the Settings window.

### Usage
Provides static methods for accessing and manipulating settings within the Unity Editor's Settings window.
```

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

### SimulatorProviderSettingsEditor

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This is custom Editor for Simulator Provider Settings.

```APIDOC
## Class: SimulatorProviderSettingsEditor

### Description
This is custom Editor for Simulator Provider Settings.

### Usage
Provides a custom inspector interface for editing the `SimulatorProviderSettings` within the Unity Editor.
```

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

### GizmoUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A static class for interacting with Scene View icons and gizmos for types.

```APIDOC
## Class: GizmoUtility

### Description
A static class for interacting with the Scene View icons and gizmos for types.

### Usage
This utility class provides methods for managing and drawing gizmos and icons in the Scene view.
```

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

### EditorApplication

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Provides a collection of static utilities, properties, and events to interact with the Unity Editor application itself.

```APIDOC
## Class: EditorApplication

### Description
Provides a collection of static utilities, properties, and events to interact with the Unity Editor application itself.

### Summary
This class is the entry point for interacting with the Unity Editor's core functionalities from scripts. It allows access to application-level events, such as script reloading, and provides utilities for managing the editor's state.
```

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

### Plugin

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Represents the currently active version control plug-in and its configuration options.

```APIDOC
## Class: Plugin

### Description
The plug-in class describes the currently active version control plug-in and its configuration options.

### Usage
Developers can use this class to query information about the active version control plug-in and its settings.
```

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

### GenericMenu

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Allows the creation of custom context menus and dropdown menus.

```APIDOC
## Class: GenericMenu

### Description
GenericMenu lets you create custom context menus and dropdown menus.

### Usage
Use this class to build and display custom menus within the Unity Editor.
```

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

### PrefabStageUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Utility methods related to Prefab stages.

```APIDOC
## Class: PrefabStageUtility

### Description
Utility methods related to Prefab stages.

### Usage
Provides helper functions for interacting with Prefab editing stages.
```

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

### SketchupMaterialDescriptionPreprocessor

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This is a default implementation for AssetPostprocessor.OnPreprocessMaterialDescription, this implementation converts material descriptions imported from Sketchup assets into materials for the internal rendering pipeline.

```APIDOC
## Class: SketchupMaterialDescriptionPreprocessor

### Description
This is a default implementation for AssetPostprocessor.OnPreprocessMaterialDescription, this implementation converts material descriptions imported from Sketchup assets into materials for the internal rendering pipeline.

### Usage
Processes material descriptions during the import of SketchUp assets, converting them into a format compatible with Unity's rendering pipeline.
```

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

### ScriptableWizard

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Derive from this class to create an editor wizard.

```APIDOC
## ScriptableWizard

### Description
Base class for creating custom editor wizards in Unity.

### Usage
Inherit from ScriptableWizard and implement its methods to create your own editor wizards.
```

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

### SettingsProvider

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

SettingsProvider is the configuration class that specifies how a Project setting or a preference should appear in the Settings or Preferences window.

```APIDOC
## Class: SettingsProvider

### Description
SettingsProvider is the configuration class that specifies how a Project setting or a preference should appear in the Settings or Preferences window.

### Usage
Used to define and customize the appearance and behavior of settings and preferences within the Unity Editor's settings windows.
```

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

### BuildPipeline

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

API for building players or AssetBundles.

```APIDOC
## Class: BuildPipeline

### Description
API for building players or AssetBundles.
```

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

### PurchasingSettings

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Editor API for the Unity Services editor feature. Normally Purchasing is enabled from the Services window, but if writing your own editor extension, this API can be used.

```APIDOC
## Class: PurchasingSettings

### Description
Editor API for the Unity Services editor feature. Normally Purchasing is enabled from the Services window, but if writing your own editor extension, this API can be used.

### Usage
Allows programmatic access to Unity Services purchasing settings, particularly for editor extensions.
```

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

### ShaderUtil

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Utility methods to assist with working with shaders from the Editor.

```APIDOC
## Class: ShaderUtil

### Description
Utility methods to assist with working with shaders from the Editor.

### Usage
Provides helper functions for common shader-related operations within the Unity Editor.
```

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

### AssetSettingsProvider

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Specialization of SettingsProvider that converts legacy settings to Unified Settings. It uses an Editor to build the UI for the Settings window by wrapping the Editor.OnInspectorGUI function.

```APIDOC
## Class: AssetSettingsProvider

### Description
AssetSettingsProvider is a specialization of the SettingsProvider class that converts legacy settings to Unified Settings. Internally, it creates an Editor for specific Assets and builds the UI for the Settings window by wrapping the Editor.OnInspectorGUI function.

### Usage
Internally used to wrap existing settings, converting legacy settings (those using the Inspector for modification) to Unified Settings.
```

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

### BuildReport

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The BuildReport API gives you information about the Unity build process.

```APIDOC
## Class: BuildReport

### Description
The BuildReport API gives you information about the Unity build process.
```

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

### ScriptableSingleton<T0>

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Generic class for storing Editor state.

```APIDOC
## ScriptableSingleton<T0>

### Description
A generic class designed for storing and managing editor state in a singleton pattern.

### Usage
Use this class to create persistent, globally accessible editor state objects.
```

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

### SimulatorProviderLoader

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

SimulatorProviderLoader implements the loader for the Adaptive Performance Device Simulator plugin.

```APIDOC
## Class: SimulatorProviderLoader

### Description
SimulatorProviderLoader implements the loader for the Adaptive Performance Device Simulator plugin.

### Usage
Handles the loading process for the Adaptive Performance Device Simulator plugin.
```

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

### AssetPreview

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Utility for fetching asset previews by instance ID. It supports asynchronous loading and provides methods to check loading status and control the cache size.

```APIDOC
## Class: AssetPreview

### Description
Utility for fetching asset previews by instance ID of assets. Methods are provided for requesting if all previews have been fully loaded, and loaded previews are stored in a cache whose size can be controlled.

### Methods
- **GetAssetPreview**: Fetches an asset preview.
- **IsLoadingAssetPreviews**: Checks if asset previews are currently loading.
- **SetPreviewTextureCacheSize**: Controls the size of the preview texture cache.
```

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

### FBXMaterialDescriptionPreprocessor

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A default implementation for AssetPostprocessor.OnPreprocessMaterialDescription that converts FBX material descriptions.

```APIDOC
## Class: FBXMaterialDescriptionPreprocessor

### Description
This is a default implementation for AssetPostprocessor.OnPreprocessMaterialDescription, this implementation converts material descriptions imported from FBX assets into materials for the internal rendering pipeline.

### Usage
This class handles the preprocessing of material descriptions from FBX files for the Unity rendering pipeline.
```

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

### Provider

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This class provides access to the version control API.

```APIDOC
## Class: Provider

### Description
This class provides access to the version control API.

### Usage
Developers can use this class to interact with the version control system through code.
```

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

### ShortcutHandler

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Shortcut handler.

```APIDOC
## Class: ShortcutHandler

### Description
Shortcut handler.

### Usage
Manages the handling and execution of defined shortcuts within the Unity Editor.
```

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

### EditorWindow

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Base class for creating custom Editor windows.

```APIDOC
## Class: EditorWindow

### Description
Derive from this class to create a custom Editor window.

### Usage
Inherit from EditorWindow to build your own dockable windows within the Unity Editor.
```

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

### RunBeforePackageAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Add this attribute to a callback method to mark that this callback must be run before any callbacks that are part of the specified package.

```APIDOC
## RunBeforePackageAttribute

### Description
Marks a callback method to ensure it runs before callbacks from a specified package.

### Usage
Apply this attribute to a callback method.

### Parameters
* **package** (string) - The name of the package whose callbacks should follow this one.
```

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

### FileUtil

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Provides methods for moving, copying, and deleting files or directories.

```APIDOC
## Class: FileUtil

### Description
Lets you do move, copy, delete operations over files or directories.

### Usage
This static class offers utility functions for common file and directory manipulation tasks.
```

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

### PlayModeWindow

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Provides methods to interact with the selected Unity PlayModeView (GameView, Simulator).

```APIDOC
## Class: PlayModeWindow

### Description
Class containing methods to interact with the selected Unity PlayModeView (GameView, Simulator).

### Usage
This class is intended for direct use by developers to control and interact with the Play Mode view within the Unity Editor.
```

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

### PreviewSceneStage

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The PreviewSceneStage class represents an editing context based on a single preview Scene.

```APIDOC
## Class: PreviewSceneStage

### Description
The PreviewSceneStage class represents an editing context based on a single preview Scene.

### Usage
Used for managing the editor's state when previewing a specific Scene.
```

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

### GizmoInfo

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Contains information about the Scene View gizmo and icon for a component type.

```APIDOC
## Class: GizmoInfo

### Description
GizmoInfo contains information about the Scene View gizmo and icon for a component type.

### Usage
This class holds data related to the visual representation of components in the Scene view.
```

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

### PrefabUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Utility class for any Prefab related operations.

```APIDOC
## Class: PrefabUtility

### Description
Utility class for any Prefab related operations.

### Usage
This class offers a collection of static methods for performing various operations on Prefabs.
```

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

### PrefabReplacingSettings

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Settings controlling the behavior of PrefabUtility.ReplacePrefabAssetOfPrefabInstance.

```APIDOC
## Class: PrefabReplacingSettings

### Description
Settings controlling the behavior of PrefabUtility.ReplacePrefabAssetOfPrefabInstance.

### Usage
This class allows customization of how Prefab instances are replaced.
```

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

### StateMachineBehaviourContext

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This class contains all the owner's information for this State Machine Behaviour.

```APIDOC
## Class: StateMachineBehaviourContext

### Description
This class contains all the owner's information for this State Machine Behaviour.

### Usage
Holds contextual information about the owner of a State Machine Behaviour, used during its execution.
```

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

### ShaderGUI

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Abstract class to derive from for defining custom GUI for shader properties and for extending the material preview.

```APIDOC
## Class: ShaderGUI

### Description
Abstract class to derive from for defining custom GUI for shader properties and for extending the material preview.

### Usage
Inherit from this class to create custom user interfaces for shader properties in the Material Inspector and to modify the material preview.
```

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

### SceneView

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Use this class to manage SceneView settings, change the SceneView camera properties, subscribe to events, call SceneView methods, and render open scenes.

```APIDOC
## SceneView

### Description
Manages and controls the Scene view in the Unity Editor, including camera properties, events, and rendering.

### Usage
Access and modify Scene view settings, camera, and rendering behavior through this class.
```

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

### ProjectBindDrawer

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A container that fetches the UIElements that draw the Project Binding UI, and subscribes to its events.

```APIDOC
## Class: ProjectBindDrawer

### Description
A container that fetches the UIElements that draw the Project Binding UI, and subscribes to its events.

### Usage
Used within the UIElements system to manage the UI for project bindings.
```

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

### SimulatorProviderSettings

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Provider Settings for Simulator Provider which controls the editor runtime asset instance which stores the Settings.

```APIDOC
## Class: SimulatorProviderSettings

### Description
Provider Settings for Simulator Provider which controls the editor runtime asset instance which stores the Settings.

### Usage
Manages the settings for the Simulator Provider, including the runtime asset instance that holds these settings.
```

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

### GameObjectUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Contains utility functions for working with GameObjects.

```APIDOC
## Class: GameObjectUtility

### Description
GameObject utility functions.

### Usage
This static class provides helper methods for common GameObject operations.
```

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

### PreloadInfo

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Container for holding a list of preload objects for a Scene to be built.

```APIDOC
## Class: PreloadInfo

### Description
Container for holding a list of preload objects for a Scene to be built.

### Usage
Used to specify objects that should be preloaded for a Scene.
```

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

### EventService

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A singleton ChannelClient that runs on all Unity instances, connected to the 'events' channel for inter-instance communication.

```APIDOC
## Class: EventService

### Description
The EventService is a singleton implementation of a ChannelClient that runs on all instances of Unity. It is connected to the "events" channel and allows a Unity instance to send JSON messages to other EventServices in external process, or other instances of Unity.

### Usage
This service facilitates communication between different Unity instances or external processes via JSON messages.
```

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

### SceneTemplateService

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A utility class that manages SceneTemplateAsset instantiation.

```APIDOC
## SceneTemplateService

### Description
A utility class responsible for managing the instantiation process of SceneTemplateAssets.

### Usage
Use this service to programmatically create scenes from templates.
```

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

### ProfilerWindow

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Use the ProfilerWindow class for interactions with the Profiler Window such as checking which frame it currently shows and controlling the selected Profiler sample in the CPU or GPU Usage Modules.

```APIDOC
## Class: ProfilerWindow

### Description
Use the ProfilerWindow class for interactions with the Profiler Window such as checking which frame it currently shows and controlling the selected Profiler sample in the CPU or GPU Usage Modules.

### Usage
This class allows programmatic interaction with the Unity Profiler window, including frame selection and sample inspection.
```

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

### Progress

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The Progress utility class reports the progress of asynchronous tasks to Unity.

```APIDOC
## Class: Progress

### Description
The Progress utility class reports the progress of asynchronous tasks to Unity.

### Usage
Developers can use this class to report the status of long-running operations to the Unity editor's progress bar.
```

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

### SimulatorAdaptivePerformanceSubsystem

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The subsystem is used for simulating Adaptive Performance in the Editor with the Device Simulator. It is also used for Adaptive Performance tests and to simulate Adaptive Performance when it is not available on the hardware you work with.

```APIDOC
## Class: SimulatorAdaptivePerformanceSubsystem

### Description
The subsystem is used for simulating Adaptive Performance in the Editor with the Device Simulator. It is also used for Adaptive Performance tests and to simulate Adaptive Performance when it is not available on the hardware you work with.

### Usage
Enables simulation of Adaptive Performance features within the Unity Editor, particularly useful for testing and development on devices where Adaptive Performance might not be natively available.
```

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

### SimulatorProviderConstants

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Static constants for the Simulator Provider.

```APIDOC
## Class: SimulatorProviderConstants

### Description
Static constants for the Simulator Provider.

### Usage
Provides a collection of constant values used by the Simulator Provider.
```

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

### EditorUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Contains general utility functions for the Unity Editor.

```APIDOC
## Class: EditorUtility

### Description
Editor utility functions.

### Usage
This static class provides a collection of helpful methods for various editor-related tasks.
```

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

### AudioImporter

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Use this class to modify AudioClip import settings from editor scripts.

```APIDOC
## Class: AudioImporter

### Description
Use this class to modify AudioClip import settings from editor scripts.
```

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

### PresetSelector

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This class implements a modal window that selects a Preset asset from the Project.

```APIDOC
## Class: PresetSelector

### Description
This class implements a modal window that selects a Preset asset from the Project.

### Usage
Provides a UI for users to select Preset assets within the Unity Editor.
```

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

### ShaderInclude

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Shader include file asset.

```APIDOC
## Class: ShaderInclude

### Description
Shader include file asset.

### Usage
Represents a shader include file asset within the Unity project.
```

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

### SettingsProviderAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Attribute used to register a new SettingsProvider. Use this attribute to decorate a function that returns an instance of a SettingsProvider. If the function returns null, no SettingsProvider appears in the Settings window.

```APIDOC
## Class: SettingsProviderAttribute

### Description
Attribute used to register a new SettingsProvider. Use this attribute to decorate a function that returns an instance of a SettingsProvider. If the function returns null, no SettingsProvider appears in the Settings window.

### Usage
Apply this attribute to functions that return `SettingsProvider` instances to register them with the Unity Editor's settings system.
```

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

### PrefabOverride

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Class with information about a given override on a Prefab instance.

```APIDOC
## Class: PrefabOverride

### Description
Class with information about a given override on a Prefab instance.

### Usage
Developers can use this class to inspect and manage overrides applied to Prefab instances.
```

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

### ScriptCompilerOptions

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Compiler options passed to the script compiler.

```APIDOC
## ScriptCompilerOptions

### Description
Represents compiler options that are passed to the script compilation process.

### Usage
Configure script compilation behavior by setting options on this object.
```

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

### SpriteAtlasUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Utility methods to pack atlases in the Project.

```APIDOC
## Class: SpriteAtlasUtility

### Description
Utility methods to pack atlases in the Project.

### Usage
Provides helper functions for packing sprite atlases within the Unity project.
```

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

### ProfilerModuleViewController

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Provides a single view of content for a ProfilerModule displayed in the Profiler window.

```APIDOC
## Class: ProfilerModuleViewController

### Description
Provides a single view of content for a ProfilerModule displayed in the Profiler window.

### Usage
This class manages the display of data for a specific Profiler module.
```

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

### ShaderData

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This class describes a shader.

```APIDOC
## Class: ShaderData

### Description
This class describes a shader.

### Usage
Represents shader information, likely used for analysis or inspection purposes.
```

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

### SceneTemplatePipelineAdapter

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

An adapter that implements all the functions of ISceneTemplatePipeline for easier usage. Use it to partially override a ISceneTemplatePipeline.

```APIDOC
## SceneTemplatePipelineAdapter

### Description
An adapter class that implements the ISceneTemplatePipeline interface, facilitating easier usage and partial overrides.

### Usage
Inherit from this class to customize Scene template instantiation pipelines with minimal code.
```

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

### EditorPrefs

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Stores and accesses Unity Editor preferences.

```APIDOC
## Class: EditorPrefs

### Description
Stores and accesses Unity Editor preferences.

### Summary
This class provides a simple key-value store for saving and retrieving user preferences within the Unity Editor. It's useful for persisting settings between editor sessions.
```

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

### StageUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Utility methods related to stages.

```APIDOC
## Class: StageUtility

### Description
Utility methods related to stages.

### Usage
Provides helper functions for common operations involving `Stage` objects.
```

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

### EditorUserBuildSettings

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Provides access to user-specific build settings within the Unity Editor.

```APIDOC
## Class: EditorUserBuildSettings

### Description
User build settings for the Editor.

### Usage
This class allows scripts to access and modify user-defined build configurations.
```

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

### ShortcutBaseAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Abstract base class for ShortcutAttribute and ClutchShortcutAttribute.

```APIDOC
## Class: ShortcutBaseAttribute

### Description
Abstract base class for ShortcutAttribute and ClutchShortcutAttribute.

### Usage
Serves as a base class for attributes related to defining shortcuts in the Unity Editor.
```

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

### ProjectSearchEngineAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A class attribute that registers Project search engines automatically. Search engines with this attribute must implement the IProjectSearchEngine interface.

```APIDOC
## Attribute: ProjectSearchEngineAttribute

### Description
A class attribute that registers Project search engines automatically. Search engines with this attribute must implement the IProjectSearchEngine interface.

### Usage
Used to automatically register custom search engine implementations.
```

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

### Events

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

An interface for accessing Package Manager events to monitor package changes.

```APIDOC
## Interface: Events

### Description
An interface for accessing the package manager events. Use these events to monitor package changes in your Unity project.

### Usage
Implement this interface to subscribe to and handle events related to package management.
```

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

### ScriptablePacker

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

ScriptablePacker Interface. Provides a custom implementation to pack sprites into textures. This is the Scriptable Packer interface.

```APIDOC
## ScriptablePacker

### Description
Interface for creating custom sprite packing implementations. Allows defining custom logic for packing sprites into textures.

### Usage
Implement this interface to provide custom sprite packing algorithms.
```

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

### RunBeforeAssemblyAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Add this attribute to a callback method to indicate that this callback must be run before any callbacks that are part of the specified assembly.

```APIDOC
## RunBeforeAssemblyAttribute

### Description
Indicates that a callback method must run before callbacks from a specified assembly.

### Usage
Apply this attribute to a callback method.

### Parameters
* **assembly** (string) - The name of the assembly whose callbacks should follow this one.
```

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

### Port

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

GraphView Port class.

```APIDOC
## Class: Port

### Description
GraphView Port class.

### Usage
This class is part of the GraphView API and is used for creating and managing ports in visual scripting or node-based editors.
```

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

### ProfilerEditorUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A Utility class for Profiler tooling in the Unity Editor.

```APIDOC
## Class: ProfilerEditorUtility

### Description
A Utility class for Profiler tooling in the Unity Editor.

### Usage
Provides helper methods for interacting with and extending Unity's Profiler tools.
```

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

### ProjectSearchContext

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A search context implementation for Project search engines. All methods that are called on a Project search engine, and expect a ISearchContext, receive an object of this type.

```APIDOC
## Class: ProjectSearchContext

### Description
A search context implementation for Project search engines. All methods that are called on a Project search engine, and expect a ISearchContext, receive an object of this type.

### Usage
Provides the necessary context for Project search operations.
```

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

### PrefabStage

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The PrefabStage class represents an editing context for Prefab Assets.

```APIDOC
## Class: PrefabStage

### Description
The PrefabStage class represents an editing context for Prefab Assets.

### Usage
This class is used to manage the editing environment when working with Prefab Assets.
```

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

### ProjectAuditor

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The ProjectAuditor class is responsible for auditing the Unity project.

```APIDOC
## Class: ProjectAuditor

### Description
The ProjectAuditor class is responsible for auditing the Unity project.

### Usage
This class provides functionality for analyzing the Unity project for potential issues or best practice violations.
```

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

### ProviderSettingsEditor

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This is a custom Editor base for Provider Settings. It displays provider general settings and you can use it to extend provider settings editors to display custom provider settings.

```APIDOC
## Class: ProviderSettingsEditor

### Description
This is a custom Editor base for Provider Settings. It displays provider general settings and you can use it to extend provider settings editors to display custom provider settings.

### Usage
Provides a base class for creating custom editor interfaces for provider settings.
```

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

### ProjectSearch

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Use this API to perform searches in the Project. Engines for this type of search implement the IProjectSearchEngine interface.

```APIDOC
## Class: ProjectSearch

### Description
Use this API to perform searches in the Project. Engines for this type of search implement the IProjectSearchEngine interface.

### Usage
Provides functionality to search for assets and other items within the Unity project.
```

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

### Preset

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A Preset contains default values for an Object.

```APIDOC
## Class: Preset

### Description
A Preset contains default values for an Object.

### Usage
This class allows developers to define and manage presets for various Unity objects.
```

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

### EditorBuildSettings

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This class allows you to modify the Editor Build Settings via script.

```APIDOC
## Class: EditorBuildSettings

### Description
This class allows you to modify the Editor Build Settings via script.

### Summary
Use this class to programmatically manage build settings, including adding or removing scenes from the build, and configuring build options.
```

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

### PopupWindowContent

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Class used to implement content for a popup window.

```APIDOC
## Class: PopupWindowContent

### Description
Class used to implement content for a popup window.

### Usage
This is a base class for developers to extend when creating custom content for popup windows.
```

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

### ShortcutAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Registers a static method as the action for an action shortcut.

```APIDOC
## Class: ShortcutAttribute

### Description
Registers a static method as the action for an action shortcut.

### Usage
Apply this attribute to static methods to define them as shortcuts that can be triggered within the Unity Editor.
```

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

### PopupWindow

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Class used to display popup windows that inherit from PopupWindowContent.

```APIDOC
## Class: PopupWindow

### Description
Class used to display popup windows that inherit from PopupWindowContent.

### Usage
Developers can utilize this class to create and manage custom popup windows in the Unity Editor.
```

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

### ShortcutManager

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Provides access to an instance of IShortcutManager for managing shortcuts.

```APIDOC
## Class: ShortcutManager

### Description
Provides access to an instance of IShortcutManager for managing shortcuts.

### Usage
Offers global access to the shortcut management system, allowing for registration, querying, and management of editor shortcuts.
```

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

### QueryEngine

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

A QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators. Default query engine of type object.

```APIDOC
## Class: QueryEngine

### Description
A QueryEngine defines how to build a query from an input string. It can be customized to support custom filters and operators. Default query engine of type object.

### Usage
Provides a flexible system for parsing and executing queries, with support for custom extensions.
```

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

### SketchUpImporter

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Derives from AssetImporter to handle importing of SketchUp files.

```APIDOC
## Class: SketchUpImporter

### Description
Derives from AssetImporter to handle importing of SketchUp files.

### Usage
Custom asset importer for handling SketchUp file formats within the Unity Editor.
```

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

### ProfilerModule

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Represents a Profiler module in the Profiler window.

```APIDOC
## Class: ProfilerModule

### Description
Represents a Profiler module in the Profiler window.

### Usage
This class is used to access and manage individual modules within the Unity Profiler window.
```

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

### StickyNote

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Instantiates a [GraphElement] used for comment text.

```APIDOC
## Class: StickyNote

### Description
Instantiates a [GraphElement] used for comment text.

### Usage
Represents a sticky note element within a graph, used for adding comments or annotations.
```

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

### EditorTool

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Use this class to implement editor tools. This is the base class from which all editor tools are inherited.

```APIDOC
## Class: EditorTool

### Description
Use this class to implement editor tools. This is the base class from which all editor tools are inherited.

### Summary
This is the base class for creating custom tools that can be used within the Unity Editor. You can define custom behaviors and interactions for your tools by inheriting from this class.
```

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

### StaticOcclusionCullingVisualization

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Used to visualize static occlusion culling at development time in Scene view.

```APIDOC
## Class: StaticOcclusionCullingVisualization

### Description
Used to visualize static occlusion culling at development time in Scene view.

### Usage
Enables the visualization of static occlusion culling data directly within the Scene view during development.
```

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

### PortSource<T0>

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Port source.

```APIDOC
## Class: PortSource<T0>

### Description
Port source.

### Usage
Represents a source for a port, likely used in conjunction with the Port class for data flow.
```

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

### ObjectFactory Class

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Use the DefaultObject to create a new UnityEngine.Object in the editor. This class is essential for instantiating new assets or objects programmatically within the Unity Editor.

```APIDOC
## ObjectFactory

### Description
Use the DefaultObject to create a new UnityEngine.Object in the editor.

### Usage
Provides methods for creating new Unity objects, such as prefabs, materials, or scripts, via editor scripting.

### Example
```csharp
using UnityEditor;
using UnityEngine;

public class CreateNewObject
{
    [MenuItem("GameObject/Create Custom Object", false, 10)]
    static void CreateCustomObject()
    {
        GameObject newObj = new GameObject("MyCustomObject");
        // You might use ObjectFactory here for more complex object creation scenarios
        // For simple GameObject creation, 'new GameObject()' is often sufficient.
        // Example of creating a primitive:
        GameObject cube = GameObject.CreatePrimitive(PrimitiveType.Cube);
        cube.name = "MyPrimitiveCube";
        // ObjectFactory.CreatePrimitive(PrimitiveType.Cube);
    }
}
```
```

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

### RunAfterPackageAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Add this attribute to a callback method to mark that this callback must be run after any callbacks that are part of the specified package.

```APIDOC
## RunAfterPackageAttribute

### Description
Marks a callback method to ensure it runs after callbacks from a specified package.

### Usage
Apply this attribute to a callback method.

### Parameters
* **package** (string) - The name of the package whose callbacks should precede this one.
```

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

### SceneTemplateAsset

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

An Asset that stores everything required to instantiate a new Scene from a templated Scene.

```APIDOC
## SceneTemplateAsset

### Description
An Asset type that holds all necessary data to create a new Scene based on a template.

### Usage
Create and use SceneTemplateAssets to standardize scene creation workflows.
```

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

### SpriteUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Helper utilities for accessing Sprite data.

```APIDOC
## Class: SpriteUtility

### Description
Helper utilities for accessing Sprite data.

### Usage
Provides utility functions for retrieving and working with sprite data in Unity.
```

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

### Unity Editor Enumerations

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

This section details various enumerations available in the Unity Editor scripting API. These enumerations provide predefined constants that can be used to configure settings, control behavior, and represent states within the editor.

```APIDOC
## Unity Editor Enumerations

This page lists and describes various enumerations used within the Unity Editor for controlling different aspects of the editor's behavior and asset import processes.

### Enumerations

- **SpritePackerMode**: Sprite Packer mode for the current project.
- **StandaloneBuildSubtarget**: Options for the desktop platform subtarget type.
- **StaticEditorFlags**: Describes which Unity systems consider the GameObject as static, and include the GameObject in their precomputations in the Unity Editor.
- **StatusCode**: This enumeration represents the status of a Package Manager operation.
- **StatusQueryOptions**: Options for querying the version control system status of a file.
- **StereoRenderingPath**: Enum used to specify what stereo rendering path to use.
- **StickyNoteChange**: Enum that specifies the type of change to the [StickyNote].
- **StickyNoteFontSize**: Enum used to describe the font size used by the [StickyNote].
- **StickyNoteTheme**: Enum used to describe the visual theme used by the [StickyNote].
- **StrippingLevel**: Managed code stripping level.
- **SubmitResult**: The status of an operation returned by the VCS.
- **SVGType**: An enum describing how SVG files are imported.
- **TemplateInstantiationMode**: An enumeration of options for handling a Scene dependency Asset when you instantiate a SceneTemplateAsset.
- **TerrainBrushPreviewMode**: Enum to specify whether DrawBrushPreview previews the source render texture or the destination render texture of a PaintContext.
- **TerrainCategory**: A category with which to define tools that inherit from the ITerrainPaintToolWithOverlays interface.
- **TerrainDetailMeshRenderMode**: Options for determining the render mode of the mesh detail.
- **TessellationMode**: An enum describing how the SVG file will be tessellated.
- **TextCursorPlacement**: Where to place the cursor in the text. (see ISearchView.SetSearchText).
- **TextureCompressionFormat**: Options for the compressed texture formats that are available on the target build platform.
- **TextureCompressionQuality**: Compression Quality.
- **TextureImporterAlphaSource**: Select how the alpha of the imported texture is generated.
- **TextureImporterCompression**: Select the kind of compression you want for your texture.
- **TextureImporterCubemapConvolution**: Defines Cubemap convolution mode.
- **TextureImporterFormat**: Imported texture format for TextureImporter.
- **TextureImporterGenerateCubemap**: Cubemap generation mode for TextureImporter.
- **TextureImporterMipFilter**: Mip map filter for TextureImporter.
- **TextureImporterNormalFilter**: Normal map filtering mode for TextureImporter.
- **TextureImporterNPOTScale**: Scaling mode for non power of two textures in TextureImporter.
- **TextureImporterRGBMMode**: RGBM encoding mode for HDR textures in TextureImporter.
- **TextureImporterShape**: The shape of the imported texture.
- **TextureImporterSingleChannelComponent**: Selects which Color/Alpha channel Single Channel Textures uses.
- **TextureImporterSwizzle**: Options for where texture color channel data comes from in the TextureImporter.
- **TextureImporterType**: Select this to set basic parameters depending on the purpose of your texture.
- **TextureResizeAlgorithm**: For Texture to be scaled down choose resize algorithm. ( Applyed only when Texture dimension is bigger than Max Size ).
- **Tool**: Which tool is active in the editor.
- **TouchPhase**: Indicates where in its lifecycle a given touch is.
- **TransitionInterruptionSource**: Which AnimatorState transitions can interrupt the Transition.
- **TreeViewSelectionOptions**: Enum used by the TreeView.SetSelection method.
- **tvOSSdkVersion**: Supported tvOS SDK versions.
- **UIOrientation**: Default mobile device orientation.
- **UpgradeProperties**: The various supported upgrade properties in a ReportItem.
- **VariableKind**: Specifies the scope of a IVariable.
- **VertexChannelCompressionFlags**: Use these enum flags to specify which elements of a vertex to compress.
- **VideoBitrateMode**: Bit rate after the clip is transcoded.
- **VideoCodec**: Choose the video codec to use to import video clips.
- **VideoDeinterlaceMode**: Describes how the fields in the image, if any, should be interpreted.
- **VideoEncodeAspectRatio**: Methods to compensate for aspect ratio discrepancies between the source resolution and the wanted encoding size.
- **VideoEncodingProfile**: Use the options in this enumeration to change the encoder profile.
- **VideoResizeMode**: How the video clip's images will be resized during transcoding.
- **VideoSpatialQuality**: Controls the imported clip's internal resize to save space at the cost of blurrier images.
- **ViewTool**: Enum for Tools.viewTool.
- **VisibleObjects**: A bit field that contains the different categories of object that the object selector window can display.
- **VisionOSSdkVersion**: Supported VisionOS SDK versions.
- **WebGLClientBrowserType**: An enum containing the supported client web browsers.
- **WebGLCompressionFormat**: An enum containing different compression types.
- **WebGLDebugSymbolMode**: An enum containing different modes for debug symbols.
- **WebGLExceptionSupport**: Options for Exception support in WebGL.
- **WebGLLinkerTarget**: The build format options available when building to WebGL.
- **WebGLMemoryGrowthMode**: An enum containing different memory growth modes.
```

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

### EditorToolbarUtility

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Provides utility functions for working with the Editor Toolbar.

```APIDOC
## Class: EditorToolbarUtility

### Description
Editor utility functions when working with EditorToolbar.

### Usage
This class offers static methods to assist in manipulating or interacting with the Editor Toolbar.
```

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

### ShaderImporter

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Shader importer lets you modify shader import settings from Editor scripts.

```APIDOC
## Class: ShaderImporter

### Description
Shader importer lets you modify shader import settings from Editor scripts.

### Usage
Allows programmatic control over how shaders are imported into the Unity project, enabling customization of import settings via editor scripts.
```

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

### SceneAsset

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

SceneAsset is used to reference Scene objects in the Editor.

```APIDOC
## SceneAsset

### Description
Represents a reference to a Scene object within the Unity Editor.

### Usage
Used for referencing scenes in editor scripts and assets.
```

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

### GraphElement

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Base class for main GraphView VisualElements.

```APIDOC
## Class: GraphElement

### Description
Base class for main GraphView VisualElements.

### Usage
This is the base class for all visual elements that make up a graph view.
```

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

### EditorWindowTitleAttribute

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

Used to set the title text and icon for an Editor window.

```APIDOC
## Class: EditorWindowTitleAttribute

### Description
Use this class to set title text and icon for an Editor window.

### Usage
Apply this attribute to your custom EditorWindow class to define its title and icon.
```

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

### PropertyDatabase

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The PropertyDatabase is a system that can store, in a thread-safe manner, properties of different kinds into a single file that we call a property database.

```APIDOC
## Class: PropertyDatabase

### Description
The PropertyDatabase is a system that can store, in a thread-safe manner, properties of different kinds into a single file that we call a property database.

### Usage
This class provides a thread-safe mechanism for storing and retrieving properties.
```

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

### SpriteAtlasImporter

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

SpriteAtlasImporter imports SpriteAtlasAsset and generates SpriteAtlas.

```APIDOC
## Class: SpriteAtlasImporter

### Description
SpriteAtlasImporter imports SpriteAtlasAsset and generates SpriteAtlas.

### Usage
Handles the import process for `SpriteAtlasAsset`, creating the final `SpriteAtlas` asset.
```

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

### Stage

Source: https://docs.unity3d.com/ScriptReference/UnityEditor.html

The Stage class represents an editing context which includes a collection of Scenes.

```APIDOC
## Class: Stage

### Description
The Stage class represents an editing context which includes a collection of Scenes.

### Usage
Defines an editing context that manages a collection of scenes, facilitating multi-scene editing workflows.
```
Tokens:
Raw