Skip to content

Improve KEY_CODE/MODIFIER_MASK description #114796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KoBeWi wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve KEY_CODE/MODIFIER_MASK description #114796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions doc/classes/@GlobalScope.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2367,10 +2367,20 @@
Section sign ([code]§[/code]) key.
</constant>
<constant name="KEY_CODE_MASK" value="8388607" enum="KeyModifierMask" is_bitfield="true">
Key Code mask.
Bit mask with all bits enabled except for modifier keys. Apply it to remove modifiers.
[codeblock]
var keycode = KEY_A | KEY_MASK_SHIFT
keycode = keycode &amp; KEY_CODE_MASK
print(keycode) # KEY_A
[/codeblock]
</constant>
<constant name="KEY_MODIFIER_MASK" value="2130706432" enum="KeyModifierMask" is_bitfield="true">
Modifier key mask.
Bit mask with all modifier bits enabled. Apply it to isolate modifiers.
[codeblock]
var keycode = KEY_A | KEY_MASK_SHIFT
keycode = keycode &amp; KEY_MODIFIER_MASK
print(keycode) # KEY_MASK_SHIFT
[/codeblock]
</constant>
<constant name="KEY_MASK_CMD_OR_CTRL" value="16777216" enum="KeyModifierMask" is_bitfield="true">
Automatically remapped to [constant KEY_META] on macOS and [constant KEY_CTRL] on other platforms, this mask is never set in the actual events, and should be used for key mapping only.
Expand Down