s&box docs
API ReferenceEditor

Optionclass

object→QObject→Option
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.Option : Editor.QObject

Constructors3

Showing 3 constructors

Methods3

Showing 3 methods

protected virtual void OnToggled(bool b)PROTECTEDVIRTUAL

Called when this option was toggled.

ParameterTypeDescription
bbool—
Returns:void—

protected virtual void OnTriggered()PROTECTEDVIRTUAL

Called when this option was clicked..

Returns:void—

public void SetIcon(Editor.Pixmap pixmap)PUBLIC

Sets an icon for the option via a raw image.

ParameterTypeDescription
pixmapPixmap—
Returns:void—

Properties13

Showing 13 properties

public bool Editor.Option.Checkable { get; set; }PUBLICGETSET

Whether this option is a toggle option. `Editor.Option.Checked`.

Returns:bool—

public bool Editor.Option.Checked { get; set; }PUBLICGETSET

Whether this option is toggled/checked. `Editor.Option.Checkable`.

Returns:bool—

public bool Editor.Option.Enabled { get; set; }PUBLICGETSET

Whether this option can be clicked. Will also be visually different.

Returns:bool—

public string Editor.Option.Icon { get; set; }PUBLICGETSET

The icon for this option.

Returns:string—

public Editor.Pixmap Editor.Option.IconImage { get; set; }PUBLICGETSET

The icon for this option.

Returns:Pixmap—

public string Editor.Option.IconText { get; set; }PUBLICGETSET

Text to display if `Editor.Option.Text` is empty.

Returns:string—

public string Editor.Option.Shortcut { get; set; }PUBLICGETSETOBSOLETE

Obsolete: Please use ShortcutName, which takes a shortcut ident (such as editor.save) instead of keys (such as CTRL+S).

Returns:string—

public string Editor.Option.ShortcutName { get; set; }PUBLICGETSET

Returns:string—

public string Editor.Option.StatusText { get; set; }PUBLICGETSETOBSOLETE

Obsolete: Use StatusTip

Returns:string—

public string Editor.Option.StatusTip { get; set; }PUBLICGETSET

Returns:string—

public string Editor.Option.Text { get; set; }PUBLICGETSET

Text for this option.

Returns:string—

public string Editor.Option.Tooltip { get; set; }PUBLICGETSETOBSOLETE

Obsolete: Use ToolTip

Returns:string—

public string Editor.Option.ToolTip { get; set; }PUBLICGETSET

Returns:string—

Related Guides

→Dedicated Servers→Editor Shortcuts→Exporting Video→Guidelines & Quality Bar→Monetization→Prefab Templates

WindowPosition

Previous Page

Checkable

Next Page

On this page

Constructorspublic Option(Editor.QObject parent, System.String title, Editor.Pixmap icon, System.Action action = null)public Option(Editor.QObject parent, System.String title = null, System.String icon = null, System.Action action = null)public Option(System.String title = null, System.String icon = null, System.Action action = null)Methodsprotected virtual System.Void OnToggled(System.Boolean b)protected virtual System.Void OnTriggered()public System.Void SetIcon(Editor.Pixmap pixmap)Propertiespublic System.Boolean Editor.Option.Checkable { get; set; }public System.Boolean Editor.Option.Checked { get; set; }public System.Boolean Editor.Option.Enabled { get; set; }public System.String Editor.Option.Icon { get; set; }public Editor.Pixmap Editor.Option.IconImage { get; set; }public System.String Editor.Option.IconText { get; set; }public System.String Editor.Option.Shortcut { get; set; }public System.String Editor.Option.ShortcutName { get; set; }public System.String Editor.Option.StatusText { get; set; }public System.String Editor.Option.StatusTip { get; set; }public System.String Editor.Option.Text { get; set; }public System.String Editor.Option.Tooltip { get; set; }public System.String Editor.Option.ToolTip { get; set; }Metadata