godotengine / godotengine/godot-docs

PopupMenu could use clarification on shortcuts and accelerators

Open
#3,294 0 comments 0 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

1. There's very little in the documentation to clarify the difference between `add_shortcut()`, `set_item_shortcut()`, and `set_item_accelerator()`. ShortCuts seem to be able to bind more actions to them than accelerators, but using `InputEventAction` as `ShortCut.shortcut` will create an extremely verbose description by default.

2. I couldn't find anywhere in the documentation regarding the limitations on "global" scope of shortcuts/accelerators. It seems that PopupMenu might not even be able to do this by itself without living inside a helper control such as `MenuButton`. Making a PopupMenu the child of a standard Button will not activate the shortcut, no matter which control seems to be in focus. This may be by design. If it is, it should be documented appropriately in `PopupMenu` and anywhere else global ShortCuts/accelerators are used. If it's not intended functionality, I'll file an issue in [godotengine/godot](https://github.com/godotengine/godot).

Related to #2760

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.