Represents a manager that configures a particular instance of the shortcuts system.
The manager maintains a list of available profiles which can be retrieved with GetAvailableProfiles. Some of the methods require the passed profile ID to be available at the time it is called. Creating a new profile with CreateProfile makes it available and deleting a profile with DeleteProfile makes it not available anymore.
It also maintains a reference to the active profile (activeProfileId) which determines the active bindings based on the shortcut overrides of the active profile. RebindShortcut and ClearShortcutOverride requires the active profile to not be read-only (i.e. IsProfileReadOnly returns false
for activeProfileId) since these two methods modify the active profile.
Finally, it maintains a list of available shortcuts which can be retrieved with GetAvailableShortcuts. All methods that take a shortcut ID require that the shortcut is avaliable.
activeProfileId | Gets or sets the ID of the currently active profile. |
ClearShortcutOverride | Clears the binding for shortcut with given shortcut ID from the active profile. |
CreateProfile | Creates a new profile with the given profile ID. |
DeleteProfile | Deletes profile with the given profile ID. |
GetAvailableProfileIds | Returns an enumeration of all of avaliable profile IDs. |
GetAvailableShortcutIds | Returns an enumeration of all available shortcut IDs. |
GetShortcutBinding | Returns the active binding for the given shortcut ID. |
IsProfileIdValid | Checks that the profile ID is valid. |
IsProfileReadOnly | Is the profile for the given profile ID read-only? |
IsShortcutOverridden | Does the active profile override the binding for the given shortcut ID? |
RebindShortcut | Rebinds the shortcut for the given shortcut ID to the given binding in the active profile. |
RenameProfile | Renames the ID of a profile. |
activeProfileChanged | Raised when the ID of the active profile is changed. |
shortcutBindingChanged | Raised when shortcut overrides are changed on the active profile. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.