diff options
| author | FlashViper <61369148+FlashViper@users.noreply.github.com> | 2022-08-04 21:53:57 -0600 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-08-29 12:42:19 +0200 |
| commit | c60853e01f92b473338dd44b0106f9d31f7e8a0e (patch) | |
| tree | 03c962083d4856c0c795e7a3d151311ec2a668e9 | |
| parent | 583c0c4897ca7ba669ab78d397fc894b718613ce (diff) | |
| download | redot-engine-c60853e01f92b473338dd44b0106f9d31f7e8a0e.tar.gz | |
InputEventWithModifiers: Improve docs of 'command' and 'meta'
Ported forward from 3.x
| -rw-r--r-- | doc/classes/InputEventWithModifiers.xml | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/InputEventWithModifiers.xml b/doc/classes/InputEventWithModifiers.xml index ff2e6409c9..b4a276f6ac 100644 --- a/doc/classes/InputEventWithModifiers.xml +++ b/doc/classes/InputEventWithModifiers.xml @@ -14,13 +14,15 @@ State of the [kbd]Alt[/kbd] modifier. </member> <member name="command_pressed" type="bool" setter="set_command_pressed" getter="is_command_pressed" default="false"> - State of the [kbd]Cmd[/kbd] modifier. + State of the [kbd]Cmd[/kbd] modifier. On macOS, this is equivalent to [member meta_pressed]. On other platforms, this is equivalent to [member ctrl_pressed]. + This modifier should be preferred to [member ctrl_pressed] or [member meta_pressed] for system shortcuts, as it maintains better cross-platform compatibility. </member> <member name="ctrl_pressed" type="bool" setter="set_ctrl_pressed" getter="is_ctrl_pressed" default="false"> State of the [kbd]Ctrl[/kbd] modifier. </member> <member name="meta_pressed" type="bool" setter="set_meta_pressed" getter="is_meta_pressed" default="false"> - State of the [kbd]Meta[/kbd] modifier. + State of the [kbd]Meta[/kbd] modifier. On Windows and Linux, this represents the Windows key (sometimes called "meta" or "super" on Linux). On macOS, this represents the Command key, and is equivalent to [member command_pressed]. + For better cross-system compatibility, use [member command_pressed] instead. </member> <member name="shift_pressed" type="bool" setter="set_shift_pressed" getter="is_shift_pressed" default="false"> State of the [kbd]Shift[/kbd] modifier. |