Version: 2022.3
LanguageEnglish
  • C#

ClutchShortcutAttribute Constructor

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public ClutchShortcutAttribute(string id, Type context = null);

Declaration

public ClutchShortcutAttribute(string id, Type context, KeyCode defaultKeyCode, ShortcutManagement.ShortcutModifiers defaultShortcutModifiers = None);

Declaration

public ClutchShortcutAttribute(string id, KeyCode defaultKeyCode, ShortcutManagement.ShortcutModifiers defaultShortcutModifiers = None);

Declaration

public ClutchShortcutAttribute(string id, Type context, string tag, KeyCode defaultKeyCode, ShortcutManagement.ShortcutModifiers defaultShortcutModifiers = None);

Parameters

id Shortcut ID.
context Optional shortcut context type.
defaultKeyCode Optional key code for default binding.
defaultShortcutModifiers Optional shortcut modifiers for default binding.
tag Optional custom context used to filter shortcuts after window context is determined.

Description

Creates an attribute for a clutch shortcut with an ID, optional context, and optional default binding.

A clutch shortcut is triggered when the binding for the shortcut is pressed down and also when it is released. The method on which this attribute is placed must take a single argument of type ShortcutArguments.

You can bind a ClutchShortcutAttribute and a ShortcutAttribute to the same mouse button. In this case, the clutch shortcut triggers when the mouse button is slightly dragged and also when it is released.

The ID is used to display the shortcut in the configuration interface. Use a forward slash group multiple shortcuts together in the configuration interface, e.g. "MyWindow/Shortcut1" and "MyWindow/Shortcut2".