Assign and change a desktop hotkey
The global Windows shortcut toggles Interactive / ClickThrough while Transparent, including outside game focus. It does nothing while Opaque; presentation and opacity remain unchanged.
Register a shortcut each launch
Follow the host-readiness flow in Quick Start, then:
- Call Set Desktop Toggle Hotkey on the Desktop Game Window Subsystem.
- Choose Key, Ctrl, Alt, and Shift. The modifier flags default to false.
- Check Return Value with Switch on EDGTResult. Only
Successpermits Transparent presentation.
Ctrl + Alt + Z is an example, not a default. Display the registered shortcut before allowing ClickThrough.
Choose supported keys
Use A–Z, top-row 0–9, or mapped keyboard keys such as F1–F11 and navigation keys. Empty/unmapped keys, mouse/gamepad inputs, modifier-only keys, and F12 return Unsupported. There is no Windows-key modifier or guaranteed punctuation/layout-specific mapping.
Replace the shortcut during play
Call the same setter with the new binding:
| Result | Meaning |
|---|---|
Success | New binding registered. |
HotkeyUnavailable | Windows refused registration, possibly because another application owns it. |
Unsupported | Unsupported key. |
NotActive | Host is not active. |
A failed rebind preserves the previous shortcut. Get Desktop Toggle Hotkey returns the registered Key/modifiers and Out Hotkey String, such as Ctrl+Alt+Z, for your UI. If no binding is active, it returns false and an empty string. On a failed rebind, capture Get Last Desktop Window Error immediately and offer another chord.
Rebinding preserves presentation and input. Holding a chord does not repeatedly toggle.
The plugin does not save hotkeys. Save preferences in your game, then register after startup; saved values can collide next launch. See Troubleshooting.