Version: 2022.1
LanguageEnglish
  • C#

ShortcutAttribute Constructor

Leave feedback
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 ShortcutAttribute(string id, Type context = null);

Declaration

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

Declaration

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

Declaration

public ShortcutAttribute(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 an action shortcut with an ID, optional context, and optional default binding.

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.

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".

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright ©2022 Unity Technologies. Publication Date: 2022-11-18.
Tutorials Community Answers Knowledge Base Forums Asset Store Terms of use LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information