ShortcutAttribute
Creates an attribute for an action shortcut with an ID, optional context, and optional default binding.
Read time 4 minutesLast updated 12 days ago
Definition
- Type: Constructor
- Namespace: UnityEditor.ShortcutManagement
- Assembly: UnityEditor.CoreModule
ShortcutAttribute(string, Type)
Creates an attribute for an action shortcut with an ID, optional context, and optional default binding.
public ShortcutAttribute(string id, Type context = null)
Parameters
Remarks
An action shortcut is triggered when the binding for the shortcut is pressed down. The method on which this attribute is placed must either take no arguments or a single argument of type ShortcutArguments.
You can bind a ClutchShortcutAttribute and a ShortcutAttribute to the same mouse button. In this case, the action shortcut triggers when the mouse button is released.
The ID is used to display the shortcut in the configuration interface unless the optional displayName property is set. Use a forward slash group multiple shortcuts together in the configuration interface, e.g. "MyWindow/Shortcut1" and "MyWindow/Shortcut2".
ShortcutAttribute(string, Type, KeyCode, ShortcutModifiers)
Creates an attribute for an action shortcut with an ID, optional context, and optional default binding.
public ShortcutAttribute(string id, Type context, KeyCode defaultKeyCode, ShortcutModifiers defaultShortcutModifiers = ShortcutModifiers.None)
Parameters
Shortcut ID.
Optional shortcut context type.
Optional key code for default binding.
Optional shortcut modifiers for default binding.
Remarks
An action shortcut is triggered when the binding for the shortcut is pressed down. The method on which this attribute is placed must either take no arguments or a single argument of type ShortcutArguments.
You can bind a ClutchShortcutAttribute and a ShortcutAttribute to the same mouse button. In this case, the action shortcut triggers when the mouse button is released.
The ID is used to display the shortcut in the configuration interface unless the optional displayName property is set. Use a forward slash group multiple shortcuts together in the configuration interface, e.g. "MyWindow/Shortcut1" and "MyWindow/Shortcut2".
ShortcutAttribute(string, Type, string, KeyCode, ShortcutModifiers)
Creates an attribute for an action shortcut with an ID, optional context, and optional default binding.
public ShortcutAttribute(string id, Type context, string tag, KeyCode defaultKeyCode, ShortcutModifiers defaultShortcutModifiers = ShortcutModifiers.None)
Parameters
Shortcut ID.
Optional shortcut context type.
Optional custom context used to filter shortcuts after window context is determined.
Optional key code for default binding.
Optional shortcut modifiers for default binding.
Remarks
An action shortcut is triggered when the binding for the shortcut is pressed down. The method on which this attribute is placed must either take no arguments or a single argument of type ShortcutArguments.
You can bind a ClutchShortcutAttribute and a ShortcutAttribute to the same mouse button. In this case, the action shortcut triggers when the mouse button is released.
The ID is used to display the shortcut in the configuration interface unless the optional displayName property is set. Use a forward slash group multiple shortcuts together in the configuration interface, e.g. "MyWindow/Shortcut1" and "MyWindow/Shortcut2".
ShortcutAttribute(string, Type, string, KeyCode, ShortcutModifiers, int)
Creates an attribute for an action shortcut with an ID, optional context, and optional default binding.
public ShortcutAttribute(string id, Type context, string tag, KeyCode defaultKeyCode, ShortcutModifiers defaultShortcutModifiers, int priority)
Parameters
Shortcut ID.
Optional shortcut context type.
Optional custom context used to filter shortcuts after window context is determined.
Optional key code for default binding.
Optional shortcut modifiers for default binding.
Optional priority for adjusting order position in Helper Bar.
Remarks
An action shortcut is triggered when the binding for the shortcut is pressed down. The method on which this attribute is placed must either take no arguments or a single argument of type ShortcutArguments.
You can bind a ClutchShortcutAttribute and a ShortcutAttribute to the same mouse button. In this case, the action shortcut triggers when the mouse button is released.
The ID is used to display the shortcut in the configuration interface unless the optional displayName property is set. Use a forward slash group multiple shortcuts together in the configuration interface, e.g. "MyWindow/Shortcut1" and "MyWindow/Shortcut2".
ShortcutAttribute(string, KeyCode, ShortcutModifiers)
Creates an attribute for an action shortcut with an ID, optional context, and optional default binding.
public ShortcutAttribute(string id, KeyCode defaultKeyCode, ShortcutModifiers defaultShortcutModifiers = ShortcutModifiers.None)
Parameters
Shortcut ID.
Optional key code for default binding.
Optional shortcut modifiers for default binding.
Remarks
An action shortcut is triggered when the binding for the shortcut is pressed down. The method on which this attribute is placed must either take no arguments or a single argument of type ShortcutArguments.
You can bind a ClutchShortcutAttribute and a ShortcutAttribute to the same mouse button. In this case, the action shortcut triggers when the mouse button is released.
The ID is used to display the shortcut in the configuration interface unless the optional displayName property is set. Use a forward slash group multiple shortcuts together in the configuration interface, e.g. "MyWindow/Shortcut1" and "MyWindow/Shortcut2".