KeyCombinationOverrideMode Enumeration |
Determines how Actions bound to keys that are also used in key combinations behave.
Example: Ctrl is bound to Action1 and Ctrl + W is bound to Action 2.
When Ctrl is pressed, Action1 activates until W is also pressed.
This enum defines how the underlying Action1 bound to Ctrl will behave when H is pressed
and when H is released. When Ctrl + H is pressed, the key combination overrides Action1
and it returns a value of False.
Namespace: Rewired.Config
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public enum KeyCombinationOverrideMode
Members| Member name | Value | Description | |
|---|---|---|---|
| None | 0 | All key combination override handling is disabled for all keys including modifier and primary keys. Even if a key combination includes a key that is already bound to an Action, both the Action bound to the key combination and the Action bound to the individual key will return true when pressed. Example: W is bound to Action1. Cntl + W is bound to Action2. When Cntl + W is pressed, both Action1 and Action2 return true. | |
| Pause | 1 | An Action bound to a modifier key that is a member of a key combination will return False for the duration that the key combination is active. Once the key combination becomes inactive by releasing the primary key, the Action bound to the modifier key will no longer be overridden and return a True value. | |
| Cancel | 2 | An Action bound to a modifier key that is a member of a key combination will return False for the duration that the key combination is active. When any key of the overriding key combination is released, the Action bound to the modifier key will no longer be overridden and return a True value if the key is still pressed. | |
| Overlap | 3 | An Action bound to a modifier key that is a member of a key combination will return True as long as the key is held and will not have its value overridden by the key combination unless the modifier key matches the primary key of the key combination. Actions bound to each modifier key in the key combination will return value along with the Action bound to the key combination. Example: Cntl is bound to Action1. Cntl + W is bound to Action2. When Cntl + W is pressed, both Action1 and Action2 return true. Note that this does not apply to the primary key of a key combination. In the previous example, an Action bound to W alone does not return true when Cntl + W is pressed. This also does not apply to key combinations themselves. Key combinations can be overridden by other key combinations that have more modifiers. Example: Cntl + W is bound to Action1. Cntl + Shift + W is bound to Action2. When Cntl + Shift + W is pressed, Action2 returns true, but Action1 returns false. If a key combination is overridden by another key combination that has more modifiers, the overridden key combination will return false until all constiutent keys are released and pressed again. |
See Also