asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

InputEventWithModifiers: Improve docs of 'command' and 'meta'

Browse source 
Ported forward from 3.x
This commit is contained in:
FlashViper 2022-08-04 21:53:57 -06:00 committed by Rémi Verschelde
parent 583c0c4897
commit c60853e01f
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/InputEventWithModifiers.xml
View file

@ -14,13 +14,15 @@
State of the [kbd]Alt[/kbd] modifier. State of the [kbd]Alt[/kbd] modifier.
</member> </member>
<member name="command_pressed" type="bool" setter="set_command_pressed" getter="is_command_pressed" default="false"> <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>
<member name="ctrl_pressed" type="bool" setter="set_ctrl_pressed" getter="is_ctrl_pressed" default="false"> <member name="ctrl_pressed" type="bool" setter="set_ctrl_pressed" getter="is_ctrl_pressed" default="false">
State of the [kbd]Ctrl[/kbd] modifier. State of the [kbd]Ctrl[/kbd] modifier.
</member> </member>
<member name="meta_pressed" type="bool" setter="set_meta_pressed" getter="is_meta_pressed" default="false"> <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>
<member name="shift_pressed" type="bool" setter="set_shift_pressed" getter="is_shift_pressed" default="false"> <member name="shift_pressed" type="bool" setter="set_shift_pressed" getter="is_shift_pressed" default="false">
State of the [kbd]Shift[/kbd] modifier. State of the [kbd]Shift[/kbd] modifier.