API Editor
namespace

Editor

178 types

Classes

Type Name Description
class AboutWidget
class AdvancedDropdownItem A tree node for use with AdvancedDropdownWidget. Items with children are categories; items without children are selectab
class AdvancedDropdownPopup A popup wrapper around AdvancedDropdownWidget.
class AdvancedDropdownWidget A generic sliding hierarchical selector widget. Build a tree of AdvancedDropdownItem and hand it to this widget.
class AnglesControlWidget
class Animate
class Application
class Asset
class AssetPreviewAttribute
class AssetSystem The asset system, provides access to all the assets.
class AssetTagSystem Handles asset tags.
class AssetType
class AutoComplete
class BaseItemWidget
class BaseScrollWidget
class BaseWindow
class BBoxControlWidget
class BoolControlWidget
class BoxLayout A widget layout. You can think of it as an invisible box of rows or columns, each one containing a widget, useful for au
class BuildStepExtensions
class Button A simple button widget.
class CanEditAttribute
class Checkbox A generic checkbox widget.
class CloudAsset
class CodeEditor For opening source code files in whatever code editor the user has selected.
class ColorSampler
class ComboBox
class ComponentEditorWidget A control widget is used to edit the value of a single SerializedProperty.
class ConsoleSystem
class ContextMenu Identical to Menu except DeleteOnClose defaults to true. Can optionally be made searchable by setting Searchable to true
class ControlWidget A control widget is used to edit the value of a single SerializedProperty.
class Dialog A wrapper to more easily create dialog windows.
class DockAttribute
class DockManager
class DockWindow A window that is built from docking windows
class Drag
class DragAssetData Represents an asset being dragged into an editor window. Assets will either be sourced from a package (see PackageIdent)
class DragData Contains drag and drop data for tool widgets. See DragEvent.
class DropdownControlWidget Base class for dropdown control widgets with multi-select support.
class EditorAppAttribute
class EditorEvent
class EditorForAssetTypeAttribute Used in conjunction with IAssetEditor to declare a window that can edit an asset type
class EditorMainWindow
class EditorPreferences
class EditorScene
class EditorShortcuts
class EditorSystem
class EditorUtility
class EnableColorAlphaAttribute If used on a Color or Color32 property, enables alpha modification in editors.
class EnumControlWidget
class ExportConfig
class FieldMetaDataAttribute Base attribute which allows adding metadata to properties.
class FileDialog
class FileSystem A filesystem that can be accessed by the game.
class FloatControlWidget
class FloatSlider
class FolderEdit An editable text box with a button to browse for an arbitrary folder using OS file browser dialog.
class Frame Like a widget - but is drawn
class GameData Lets all native and managed tools know about any engine / game entities.
class GameEditorSession
class GameMode Registers a widget with the input system, so it uses SDL.
class GameScenePicker Opens an invisible popup above the game screen which allows you to left click once on the scene. This is great for thing
class GraphicsItem
class GraphicsLine
class GraphicsView
class GraphicsWidget
class GridLayout A widget layout. You can think of it as an invisible box of rows or columns, each one containing a widget, useful for au
class GroupButtonControlWidget
class HidePropertyAttribute A way to hide properties from parent classes in tools.
class HistoryList<T> A helper class to store a list of strings, which can then be navigated around, saved, restored
class IconButton
class IconLabel A material icon label
class Input
class InputOutputBase Represents a variable
class InputSystem
class InspectorAttribute
class InspectorWidget When using InspectorAttribute with a type that inherits from InspectorWidget, when you inspect an object of that class,
class IntegerControlWidget
class Label A simple text label.
class Layout
class LibraryProject
class LibrarySystem
class LineEdit A single line text entry. See TextEdit for multi line version.
class LinkableSplitter Splitter that can be linked to move alongside others
class ListView
class MapClass Represents an entity class used by the map editor
class MapClassVariable Represents a variable.
class MarginControlWidget
class Menu
class MenuAttribute
class MenuBar
class MetaData A class to CRUD json files. This should probably be a generic class since it seems like we might want to do this with st
class MetaDataAttribute Base attribute which allows adding FGD metadata to classes.
class Option
class Output
class Paint
class Pixmap A pixel map, or just a simple image.
class PopupDialogWidget
class PopupWidget A popup widget that automatically deletes itself once it stops being visible
class ProjectList
class ProjectPublisher
class QObject
class QStringList
class QTextBlock
class RectControlWidget
class RotationControlWidget
class SceneEditor
class SceneEditorSession A SceneEditorSession holds a Scene that is open in the editor. It creates a widget, has a selection and undo system.
class SceneFolder
class SceneRenderingWidget Render a scene to a native widget. This replaces NativeRenderingWidget.
class ScrollArea A widget that can scroll its Canvas.
class ScrollBar
class SegmentedControl
class Separator
class ShortcutAttribute
class SphereControlWidget
class Splitter Split frame, allows dragging to resize panels
class SpriteAnimationControlWidget
class StackLineHandlerAttribute Marks a method as a custom handler for stack trace lines matching a certain pattern. The method must take in a Match par
class StackRow
class StandaloneExporter
class StatusBar
class StringControlWidget
class SuspendUpdates Suspends updates in the widget for this using scope.
class TabBar
class TextAreaControlWidget
class TextCursor
class TextEdit A multi-line text entry. See LineEdit for a single line version.
class TextureResourceCompiler
class Theme
class TitleBarButtons A list of title bar buttons, at the top right of a window.
class ToolBar
class ToolButton A button that shows as an icon and tries to keep itself square.
class ToolRender Renders basic stuff for tool views
class TransformControlWidget
class TrayIcon Like a widget - but is drawn
class VariantControlWidget
class VectorControlWidget
class VectorIntControlWidget
class VirtualWidget
class Widget A generic widget.
class WidgetSignal
class Window

Structs

Type Name Description
struct ContextMenuEvent Information about a Widgets context menu event.
struct GraphicsHoverEvent Information about a GraphicsItems mouse hover event.
struct GraphicsMouseEvent Information about a GraphicsItems mouse click event.
struct KeyEvent Information about a Widgets keyboard event.
struct MouseEvent Information about a Widgets mouse event.
struct TextureResidencyInfo Provides information about currently resident textures on the GPU
struct Trace Trace for tools, not to be confused with SceneTrace
struct TraceResult
struct WheelEvent Information about a mouse wheel scroll event of a Widget.

Enums

Type Name Description
enum CheckState Check state of a Checkbox.
enum CursorShape TODO: Make this match whatever we do in game
enum DockArea
enum DropAction Used to tell the user what kind of action will happen during a drag and drop event on mouse release. In Windows, these a
enum ElideMode
enum FocusChangeReason Describes why a Widgets' keyboard focus has changed via FocusChangeReason) and FocusChangeReason) callbacks.
enum FocusMode
enum InputOutputType
enum KeyCode
enum Orientation
enum PenStyle
enum RenderMode
enum ScrollbarMode
enum ShortcutContext Scope of the shortcut. Requires focus at this level for the shortcut to be active. Defaults to WindowShortcut.
enum ShortcutType
enum SizeConstraint
enum SizeMode
enum ToolbarPosition
enum ToolButtonStyle
enum WindowFlags

Interfaces

Type Name Description
interface IAssetEditor A widget (usually window) implementing this will be able to edit assets via the asset browser. The widget should be mark
interface ICodeEditor Interface for editors to open code files. Any class that implements this interface is automatically added to the list. A
interface IEditorAttribute<T> Allows an editor widget to provide an attribute that it can use. Editors with attributes are chosen over editors without
interface IPopupEditor<T> An popup editor capable of editing type T. This is created when EditorUtility.OpenControlSheet is called, which is gene
interface IProgress
interface IProgressSection