Class InterfaceOptions

Editor interface options data container.

System.Object
InterfaceOptions
Namespace: FlaxEditor.Options
Assembly: FlaxEngine.CSharp.dll
Syntax
[CustomEditor]
public class InterfaceOptions : Object

Constructors

InterfaceOptions()

Declaration
public InterfaceOptions()

Fields

FallbackFonts

The list of fallback fonts to use when main text font is missing certain characters. Empty to use fonts from GraphicsSettings.

Declaration
[EditorDisplay("Fonts", null)]
[EditorOrder(750)]
public FontAsset[] FallbackFonts
Field Value
FontAsset[]

NumberOfGameClientsToLaunch

Gets or sets a value indicating the number of game clients to launch when building and/or running cooked game.

Declaration
[Range(1F, 4F)]
[EditorDisplay("Cook & Run", null)]
[EditorOrder(600)]
public int NumberOfGameClientsToLaunch
Field Value
System.Int32

Properties

AutoAcceptColorPickerChange

If checked, color pickers will always modify the color unless 'Cancel' if pressed, otherwise color won't change unless 'Ok' is pressed.

Declaration
[EditorDisplay("Interface", null)]
[EditorOrder(290)]
public bool AutoAcceptColorPickerChange { get; set; }
Property Value
System.Boolean

CenterMouseOnGameWinFocus

Gets or sets a value indicating whether center mouse position on window focus in play mode. Helps when working with games that lock mouse cursor.

Declaration
[EditorDisplay("Interface", "Center Mouse On Game Window Focus")]
[EditorOrder(100)]
[Tooltip("Determines whether center mouse position on window focus in play mode. Helps when working with games that lock mouse cursor.")]
public bool CenterMouseOnGameWinFocus { get; set; }
Property Value
System.Boolean

ConnectionCurvature

Gets or sets the curvature of the line connecting to connected visject nodes.

Declaration
[Range(0F, 2F)]
[EditorDisplay("Visject", null)]
[EditorOrder(550)]
public float ConnectionCurvature { get; set; }
Property Value
System.Single

ContentWindowOrientation

Gets or sets the editor content window orientation.

Declaration
[EditorDisplay("Interface", null)]
[EditorOrder(280)]
[Tooltip("Editor content window orientation.")]
public Orientation ContentWindowOrientation { get; set; }
Property Value
Orientation

DebugLogClearOnPlay

Gets or sets the clear on play for debug log messages.

Declaration
[EditorDisplay("Debug Log", "Clear on Play")]
[EditorOrder(360)]
[Tooltip("Clears all log entries on enter playmode.")]
public bool DebugLogClearOnPlay { get; set; }
Property Value
System.Boolean

DebugLogCollapse

Gets or sets the collapse mode for debug log messages.

Declaration
[EditorDisplay("Debug Log", null)]
[EditorOrder(361)]
[Tooltip("Collapses similar or repeating log entries.")]
public bool DebugLogCollapse { get; set; }
Property Value
System.Boolean

DebugLogPauseOnError

Gets or sets the automatic pause on error for debug log messages.

Declaration
[EditorDisplay("Debug Log", "Pause on Error")]
[EditorOrder(362)]
[Tooltip("Performs auto pause on error.")]
public bool DebugLogPauseOnError { get; set; }
Property Value
System.Boolean

DebugLogShowErrorMessages

Gets or sets the automatic pause on error for debug log messages.

Declaration
[EditorDisplay("Debug Log", "Show error messages")]
[EditorOrder(370)]
[Tooltip("Shows/hides error messages.")]
public bool DebugLogShowErrorMessages { get; set; }
Property Value
System.Boolean

DebugLogShowInfoMessages

Gets or sets the automatic pause on error for debug log messages.

Declaration
[EditorDisplay("Debug Log", "Show info messages")]
[EditorOrder(372)]
[Tooltip("Shows/hides info messages.")]
public bool DebugLogShowInfoMessages { get; set; }
Property Value
System.Boolean

DebugLogShowWarningMessages

Gets or sets the automatic pause on error for debug log messages.

Declaration
[EditorDisplay("Debug Log", "Show warning messages")]
[EditorOrder(371)]
[Tooltip("Shows/hides warning messages.")]
public bool DebugLogShowWarningMessages { get; set; }
Property Value
System.Boolean

DebugLogTimestampsFormat

Gets or sets the timestamps prefix mode for output log messages.

Declaration
[EditorDisplay("Debug Log", null)]
[EditorOrder(350)]
[Tooltip("The timestamps prefix mode for debug log messages.")]
public InterfaceOptions.TimestampsFormats DebugLogTimestampsFormat { get; set; }
Property Value
InterfaceOptions.TimestampsFormats

DefaultGameWindowMode

Gets or sets a value indicating how the game window should be displayed when the game is launched.

Declaration
[EditorDisplay("Play In-Editor", "Game Window Mode")]
[EditorOrder(520)]
[Tooltip("Determines how the game window is displayed when the game is launched.")]
public InterfaceOptions.GameWindowMode DefaultGameWindowMode { get; set; }
Property Value
InterfaceOptions.GameWindowMode

FocusGameWinOnPlay

Gets or sets a value indicating whether auto-focus game window on play mode start.

Declaration
[EditorDisplay("Play In-Editor", "Focus Game Window On Play")]
[EditorOrder(500)]
[Tooltip("Determines whether auto-focus game window on play mode start.")]
public bool FocusGameWinOnPlay { get; set; }
Property Value
System.Boolean

FocusOutputLogOnCompilationError

Gets or sets a value indicating whether auto-focus output log window on code compilation error.

Declaration
[EditorDisplay("Output Log", "Focus Output Log On Compilation Error")]
[EditorOrder(450)]
[Tooltip("Determines whether auto-focus output log window on code compilation error.")]
public bool FocusOutputLogOnCompilationError { get; set; }
Property Value
System.Boolean

FocusOutputLogOnGameBuildError

Gets or sets a value indicating whether auto-focus output log window on game build error.

Declaration
[EditorDisplay("Output Log", "Focus Output Log On Game Build Error")]
[EditorOrder(460)]
[Tooltip("Determines whether auto-focus output log window on game build error.")]
public bool FocusOutputLogOnGameBuildError { get; set; }
Property Value
System.Boolean

IconsScale

Gets or sets the editor icons scale. Editor restart required.

Declaration
[Limit(0.1F, 4F, 0.01F)]
[EditorDisplay("Interface", null)]
[EditorOrder(250)]
[Tooltip("Editor icons scale. Editor restart required.")]
public float IconsScale { get; set; }
Property Value
System.Single

InterfaceScale

Gets or sets the Editor User Interface scale. Applied to all UI elements, windows and text. Can be used to scale the interface up on a bigger display. Editor restart required.

Declaration
[Limit(0.1F, 10F, 1F)]
[EditorDisplay("Interface", null)]
[EditorOrder(10)]
[Tooltip("Editor User Interface scale. Applied to all UI elements, windows and text. Can be used to scale the interface up on a bigger display. Editor restart required.")]
public float InterfaceScale { get; set; }
Property Value
System.Single

LargeFont

Gets or sets the large font for editor UI.

Declaration
[EditorDisplay("Fonts", null)]
[EditorOrder(710)]
[Tooltip("The large font for editor UI.")]
public FontReference LargeFont { get; set; }
Property Value
FontReference

MediumFont

Gets or sets the medium font for editor UI.

Declaration
[EditorDisplay("Fonts", null)]
[EditorOrder(720)]
[Tooltip("The medium font for editor UI.")]
public FontReference MediumFont { get; set; }
Property Value
FontReference

NewWindowLocation

Gets or sets the method window opening.

Declaration
[EditorDisplay("Interface", "New Window Location")]
[EditorOrder(150)]
[Tooltip("Define the opening method for new windows, open in a new tab by default.")]
public InterfaceOptions.DockStateProxy NewWindowLocation { get; set; }
Property Value
InterfaceOptions.DockStateProxy

NodeDescriptionPanel

Gets or sets a value that indicates wether the context menu description panel is shown or not.

Declaration
[EditorDisplay("Visject", null)]
[EditorOrder(550)]
[Tooltip("Shows/hides the description panel in visual scripting context menu.")]
public bool NodeDescriptionPanel { get; set; }
Property Value
System.Boolean

OutputLogScrollToBottom

Gets or sets the value for automatic scroll to bottom in output log.

Declaration
[EditorDisplay("Output Log", "Scroll to bottom")]
[EditorOrder(470)]
[Tooltip("Scroll the output log view to bottom automatically after new lines are added.")]
public bool OutputLogScrollToBottom { get; set; }
Property Value
System.Boolean

OutputLogShowLogType

Gets or sets the log type prefix mode for output log messages.

Declaration
[EditorDisplay("Output Log", "Show Log Type")]
[EditorOrder(410)]
[Tooltip("Determines whether show log type prefix in output log messages.")]
public bool OutputLogShowLogType { get; set; }
Property Value
System.Boolean

OutputLogTextColor

Gets or sets the output log text color.

Declaration
[EditorDisplay("Output Log", "Text Color")]
[EditorOrder(430)]
[Tooltip("The output log text color.")]
public Color OutputLogTextColor { get; set; }
Property Value
Color

OutputLogTextFont

Gets or sets the output log text font.

Declaration
[EditorDisplay("Output Log", "Text Font")]
[EditorOrder(420)]
[Tooltip("The output log text font.")]
public FontReference OutputLogTextFont { get; set; }
Property Value
FontReference

OutputLogTextShadowColor

Gets or sets the output log text shadow color.

Declaration
[EditorDisplay("Output Log", "Text Shadow Color")]
[EditorOrder(440)]
[Tooltip("The output log text shadow color.")]
public Color OutputLogTextShadowColor { get; set; }
Property Value
Color

OutputLogTextShadowOffset

Gets or sets the output log text shadow offset. Set to 0 to disable this feature.

Declaration
[EditorDisplay("Output Log", "Text Shadow Offset")]
[EditorOrder(445)]
[Tooltip("The output log text shadow offset. Set to 0 to disable this feature.")]
public Float2 OutputLogTextShadowOffset { get; set; }
Property Value
Float2

OutputLogTimestampsFormat

Gets or sets the timestamps prefix mode for output log messages.

Declaration
[EditorDisplay("Output Log", "Timestamps Format")]
[EditorOrder(400)]
[Tooltip("The timestamps prefix mode for output log messages.")]
public InterfaceOptions.TimestampsFormats OutputLogTimestampsFormat { get; set; }
Property Value
InterfaceOptions.TimestampsFormats

PlayButtonAction

Gets or sets a value indicating what action should be taken upon pressing the play button.

Declaration
[EditorDisplay("Play In-Editor", "Play Button Action")]
[EditorOrder(510)]
public InterfaceOptions.PlayAction PlayButtonAction { get; set; }
Property Value
InterfaceOptions.PlayAction

SeparateValueAndUnit

Gets or sets the option to put a space between numbers and units for unit formatting.

Declaration
[EditorDisplay("Interface", null)]
[EditorOrder(310)]
public bool SeparateValueAndUnit { get; set; }
Property Value
System.Boolean

ShowSelectedCameraPreview

Gets or sets a value indicating whether show selected camera preview in the editor window.

Declaration
[EditorDisplay("Interface", null)]
[EditorOrder(80)]
[Tooltip("Determines whether show selected camera preview in the edit window.")]
public bool ShowSelectedCameraPreview { get; set; }
Property Value
System.Boolean

ShowTreeLines

Gets or sets tree line visibility.

Declaration
[EditorDisplay("Interface", null)]
[EditorOrder(320)]
[Tooltip("Toggles tree line visibility in places like the Scene or Content Panel.")]
public bool ShowTreeLines { get; set; }
Property Value
System.Boolean

SmallFont

Gets or sets the small font for editor UI.

Declaration
[EditorDisplay("Fonts", null)]
[EditorOrder(730)]
[Tooltip("The small font for editor UI.")]
public FontReference SmallFont { get; set; }
Property Value
FontReference

SurfaceGridSnapping

Gets or sets the surface grid snapping option.

Declaration
[EditorDisplay("Visject", "Grid Snapping")]
[EditorOrder(551)]
[Tooltip("Toggles grid snapping when moving nodes.")]
public bool SurfaceGridSnapping { get; set; }
Property Value
System.Boolean

SurfaceGridSnappingSize

Gets or sets the surface grid snapping option.

Declaration
[EditorDisplay("Visject", "Grid Snapping Size")]
[EditorOrder(551)]
[Tooltip("Defines the size of the grid for nodes snapping.")]
[VisibleIf("SurfaceGridSnapping", false)]
public float SurfaceGridSnappingSize { get; set; }
Property Value
System.Single

TitleFont

Gets or sets the title font for editor UI.

Declaration
[EditorDisplay("Fonts", null)]
[EditorOrder(700)]
[Tooltip("The title font for editor UI.")]
public FontReference TitleFont { get; set; }
Property Value
FontReference

UseNativeWindowSystem

Gets or sets a value indicating whether use native window title bar. Editor restart required.

Declaration
[EditorDisplay("Interface", null)]
[EditorOrder(70)]
[Tooltip("Determines whether use native window title bar. Editor restart required.")]
public bool UseNativeWindowSystem { get; set; }
Property Value
System.Boolean

ValueFormatting

Gets or sets the formatting option for numeric values in the editor.

Declaration
[EditorDisplay("Interface", null)]
[EditorOrder(300)]
public InterfaceOptions.ValueFormattingType ValueFormatting { get; set; }
Property Value
InterfaceOptions.ValueFormattingType

Extension Methods