API Reference

Editor Classes

210 types

Type Name Description
class AboutWidget Editor
class AdvancedDropdownItem Editor A tree node for use with AdvancedDropdownWidget. Items with children are categories; items without children are selectab
class AdvancedDropdownPopup Editor A popup wrapper around AdvancedDropdownWidget.
class AdvancedDropdownWidget Editor A generic sliding hierarchical selector widget. Build a tree of AdvancedDropdownItem and hand it to this widget.
class AnglesControlWidget Editor
class Animate Editor
class Application Editor
class Asset Editor
class AssetPreviewAttribute Editor
class AssetSystem Editor The asset system, provides access to all the assets.
class AssetTagSystem Editor Handles asset tags.
class AssetType Editor
class AutoComplete Editor
class BaseItemWidget Editor
class BaseScrollWidget Editor
class BaseWindow Editor
class BBoxControlWidget Editor
class BoolControlWidget Editor
class BoxLayout Editor 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 Editor
class Button Editor A simple button widget.
class CanDropAttribute Editor.MapEditor
class CanEditAttribute Editor
class Checkbox Editor A generic checkbox widget.
enum CheckState Editor Check state of a Checkbox.
class CloudAsset Editor
class CodeEditor Editor For opening source code files in whatever code editor the user has selected.
class ColorSampler Editor
class ComboBox Editor
class ComponentEditorWidget Editor A control widget is used to edit the value of a single SerializedProperty.
class ConsoleSystem Editor
class ContextMenu Editor Identical to Menu except DeleteOnClose defaults to true. Can optionally be made searchable by setting Searchable to true
struct ContextMenuEvent Editor Information about a Widgets context menu event.
class ControlWidget Editor A control widget is used to edit the value of a single SerializedProperty.
enum CursorShape Editor TODO: Make this match whatever we do in game
class Dialog Editor A wrapper to more easily create dialog windows.
enum DockArea Editor
class DockAttribute Editor
class DockManager Editor
class DockWindow Editor A window that is built from docking windows
class Drag Editor
class DragAssetData Editor Represents an asset being dragged into an editor window. Assets will either be sourced from a package (see PackageIdent)
class DragData Editor Contains drag and drop data for tool widgets. See DragEvent.
enum DropAction Editor Used to tell the user what kind of action will happen during a drag and drop event on mouse release. In Windows, these a
class DropdownControlWidget Editor Base class for dropdown control widgets with multi-select support.
class EditorAppAttribute Editor
class EditorContext Editor.MapEditor
class EditorEvent Editor
class EditorForAssetTypeAttribute Editor Used in conjunction with IAssetEditor to declare a window that can edit an asset type
class EditorMainWindow Editor
class EditorPreferences Editor
class EditorScene Editor
class EditorShortcuts Editor
class EditorSystem Editor
class EditorUtility Editor
enum ElideMode Editor
class EnableColorAlphaAttribute Editor If used on a Color or Color32 property, enables alpha modification in editors.
class EnumControlWidget Editor
class ExportConfig Editor
class FieldMetaDataAttribute Editor Base attribute which allows adding metadata to properties.
class FileDialog Editor
class FileSystem Editor A filesystem that can be accessed by the game.
class FloatControlWidget Editor
class FloatSlider Editor
enum FocusChangeReason Editor Describes why a Widgets' keyboard focus has changed via FocusChangeReason) and FocusChangeReason) callbacks.
enum FocusMode Editor
class FolderEdit Editor An editable text box with a button to browse for an arbitrary folder using OS file browser dialog.
class Frame Editor Like a widget - but is drawn
class GameData Editor Lets all native and managed tools know about any engine / game entities.
class GameEditorSession Editor
class GameMode Editor Registers a widget with the input system, so it uses SDL.
class GameScenePicker Editor Opens an invisible popup above the game screen which allows you to left click once on the scene. This is great for thing
struct GraphicsHoverEvent Editor Information about a GraphicsItems mouse hover event.
class GraphicsItem Editor
class GraphicsLine Editor
struct GraphicsMouseEvent Editor Information about a GraphicsItems mouse click event.
class GraphicsView Editor
class GraphicsWidget Editor
class GridLayout Editor 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 Editor
class Hammer Editor.MapEditor
class HammerMainWindow Editor.MapEditor This is our CQHammerMainWnd
class HammerManagedInspector Editor.MapEditor
class HammerSceneEditorSession Editor.MapEditor
class HammerSession Editor.MapEditor This is our CQHammerMainWnd
class HammerSourceLocation Editor.MapEditor Source location for graphs created in a Hammer editor session.
class HidePropertyAttribute Editor A way to hide properties from parent classes in tools.
class History Editor.MapEditor Undo/redo history for the current active mapdoc
class HistoryList<T> Editor A helper class to store a list of strings, which can then be navigated around, saved, restored
interface IAssetEditor Editor A widget (usually window) implementing this will be able to edit assets via the asset browser. The widget should be mark
interface IBlockTool Editor.MapEditor Interface for the addon layer to implement, this is called from native Hammer.
interface ICodeEditor Editor Interface for editors to open code files. Any class that implements this interface is automatically added to the list. A
class IconButton Editor
class IconLabel Editor A material icon label
interface IEditorAttribute<T> Editor Allows an editor widget to provide an attribute that it can use. Editors with attributes are chosen over editors without
interface IEditorAttributeBase Editor.Internal
interface IEntityTool Editor.MapEditor Interface for the addon layer to implement, this is called from native Hammer.
interface IMapViewDropTarget Editor.MapEditor Provides an interface for dragging and dropping Asset or Package on a map view. Use with CanDropAttribute to register yo
class Input Editor
class InputOutputBase Editor Represents a variable
enum InputOutputType Editor
class InputSystem Editor
class InspectorAttribute Editor
class InspectorWidget Editor When using InspectorAttribute with a type that inherits from InspectorWidget, when you inspect an object of that class,
class IntegerControlWidget Editor
interface IPathTool Editor.MapEditor Interface for the addon layer to implement, this is called from native Hammer.
interface IPopupEditor<T> Editor An popup editor capable of editing type T. This is created when EditorUtility.OpenControlSheet is called, which is gene
interface IProgress Editor
interface IProgressSection Editor
interface IToolFactory Editor.MapEditor
enum KeyCode Editor
struct KeyEvent Editor Information about a Widgets keyboard event.
class Label Editor A simple text label.
class Layout Editor
class LibraryProject Editor
class LibrarySystem Editor
class LineEdit Editor A single line text entry. See TextEdit for multi line version.
class LinkableSplitter Editor Splitter that can be linked to move alongside others
class ListView Editor
class MapClass Editor Represents an entity class used by the map editor
class MapClassVariable Editor Represents a variable.
class MapDocument Editor.MapDoc Represents an open map document. A document has a tree of MapNode that represent the world.
class MapEntity Editor.MapDoc MapEntity in Hammer is a type of MapNode that has a set of key/value pairs. The keyvalues represent the authoritative st
class MapGameObject Editor.MapDoc
class MapGroup Editor.MapDoc A map node which has the sole purpose of grouping other map nodes together.
class MapInstance Editor.MapDoc A map node which allows a target group and its children to be placed with a new position and orientation in the world wi
class MapMesh Editor.MapDoc MapMesh is the Hammer map node which represents editable mesh geometry in a Hammer map. This is the map node that is cre
class MapNode Editor.MapDoc A common class used for all objects in the world object tree.
class MapPath Editor.MapDoc Path containing a bunch of MapPathNode
class MapPathNode Editor.MapDoc Nodes along a MapPath
class MapStaticOverlay Editor.MapDoc An overlay which is rendered using a mesh generated by projecting faces onto surrounding geometry. Baked during map comp
class MapView Editor.MapEditor MapViews are owned by the MapViewMgr. They display the MapViewMgr's mapdoc. The MapView provides either a 2
class MapWorld Editor.MapDoc MapWorld is the root node of a MapDocument, however it can have multiple sub MapWorld of prefabs.
class MarginControlWidget Editor
class Menu Editor
class MenuAttribute Editor
class MenuBar Editor
class MetaData Editor 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 Editor Base attribute which allows adding FGD metadata to classes.
class ModelDoc Editor.ModelEditor
struct MouseEvent Editor Information about a Widgets mouse event.
class Option Editor
enum Orientation Editor
class Output Editor
class Paint Editor
enum PenStyle Editor
class Pixmap Editor A pixel map, or just a simple image.
class PopupDialogWidget Editor
class PopupWidget Editor A popup widget that automatically deletes itself once it stops being visible
class PrimitiveBuilder Editor.MeshEditor Build primitives out of polygons.
class ProjectList Editor
class ProjectPublisher Editor
class QObject Editor
class QStringList Editor
class QTextBlock Editor
class RectControlWidget Editor
enum RenderMode Editor
class RotationControlWidget Editor
class SceneEditor Editor
class SceneEditorSession Editor A SceneEditorSession holds a Scene that is open in the editor. It creates a widget, has a selection and undo system.
class SceneFolder Editor
class SceneRenderingWidget Editor Render a scene to a native widget. This replaces NativeRenderingWidget.
class ScrollArea Editor A widget that can scroll its Canvas.
class ScrollBar Editor
enum ScrollbarMode Editor
class SegmentedControl Editor
class Selection Editor.MapEditor Current selection set for the active map
enum SelectMode Editor.MapEditor
class Separator Editor
class ShortcutAttribute Editor
enum ShortcutContext Editor Scope of the shortcut. Requires focus at this level for the shortcut to be active. Defaults to WindowShortcut.
enum ShortcutType Editor
class SimpleText Editor.Graphic
enum SizeConstraint Editor
enum SizeMode Editor
class SphereControlWidget Editor
class Splitter Editor Split frame, allows dragging to resize panels
class SpriteAnimationControlWidget Editor
class StackLineHandlerAttribute Editor 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 Editor
class StandaloneExporter Editor
class StatusBar Editor
class StringControlWidget Editor
class SuspendUpdates Editor Suspends updates in the widget for this using scope.
class TabBar Editor
class TextAreaControlWidget Editor
class TextCursor Editor
class TextEdit Editor A multi-line text entry. See LineEdit for a single line version.
struct TextureResidencyInfo Editor Provides information about currently resident textures on the GPU
class TextureResourceCompiler Editor
class Theme Editor
class TitleBarButtons Editor A list of title bar buttons, at the top right of a window.
class ToolBar Editor
enum ToolbarPosition Editor
class ToolButton Editor A button that shows as an icon and tries to keep itself square.
enum ToolButtonStyle Editor
class ToolRender Editor Renders basic stuff for tool views
struct Trace Editor Trace for tools, not to be confused with SceneTrace
struct TraceResult Editor
class TransformControlWidget Editor
class TrayIcon Editor Like a widget - but is drawn
class VariantControlWidget Editor
class VectorControlWidget Editor
class VectorIntControlWidget Editor
class VirtualWidget Editor
struct WheelEvent Editor Information about a mouse wheel scroll event of a Widget.
class Widget Editor A generic widget.
class WidgetSignal Editor
class Window Editor
enum WindowFlags Editor