Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-31 13:41:03 +00:00
Code Issues Projects Releases Packages Wiki Activity
godot/doc/classes/InputEventWithModifiers.xml

34 lines
1.9 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-02-14 14:18:53 +01:00
<class name="InputEventWithModifiers" inherits="InputEventFromWindow" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<brief_description>
[DOCS] InputEvent*
2017-10-16 00:07:13 +02:00
Base class for keys events with modifiers.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</brief_description>
<description>
Improve shortcut formatting in docs
2020-03-10 13:41:36 +03:00
Contains keys events information with modifiers support like [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See [method Node._input].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 10:43:07 +01:00
<link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</tutorials>
<members>
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods
2021-04-24 14:33:50 -06:00
<member name="alt_pressed" type="bool" setter="set_alt_pressed" getter="is_alt_pressed" default="false">
Improve shortcut formatting in docs
2020-03-10 13:41:36 +03:00
State of the [kbd]Alt[/kbd] modifier.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</member>
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods
2021-04-24 14:33:50 -06:00
<member name="command_pressed" type="bool" setter="set_command_pressed" getter="is_command_pressed" default="false">
Improve shortcut formatting in docs
2020-03-10 13:41:36 +03:00
State of the [kbd]Cmd[/kbd] modifier.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</member>
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods
2021-04-24 14:33:50 -06:00
<member name="ctrl_pressed" type="bool" setter="set_ctrl_pressed" getter="is_ctrl_pressed" default="false">
Improve shortcut formatting in docs
2020-03-10 13:41:36 +03:00
State of the [kbd]Ctrl[/kbd] modifier.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</member>
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods
2021-04-24 14:33:50 -06:00
<member name="meta_pressed" type="bool" setter="set_meta_pressed" getter="is_meta_pressed" default="false">
Improve shortcut formatting in docs
2020-03-10 13:41:36 +03:00
State of the [kbd]Meta[/kbd] modifier.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</member>
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods
2021-04-24 14:33:50 -06:00
<member name="shift_pressed" type="bool" setter="set_shift_pressed" getter="is_shift_pressed" default="false">
Improve shortcut formatting in docs
2020-03-10 13:41:36 +03:00
State of the [kbd]Shift[/kbd] modifier.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</member>
Made serialization of Command toggleable when saving InputEvents. Made serialization of Command optional. If command is serialized, Control (On Win/Linux) or Meta (on Mac) are not. Example use case: You are on Windows and you set a shortcut to be Control + E. This would serialize as Command=true and Control=true. If you then run this project on Mac, you would need to press Command AND Control to activate the shortcut - which is not what is intended. Now, you can set store_command to true, and it will only serialize to Command = true (no Control serialized). On Windows, this means Control. On Mac, it means only command.
2020-09-29 00:23:51 +10:00
<member name="store_command" type="bool" setter="set_store_command" getter="is_storing_command" default="true">
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods
2021-04-24 14:33:50 -06:00
If [code]true[/code], pressing [kbd]Cmd[/kbd] on macOS or [kbd]Ctrl[/kbd] on all other platforms will both be serialized as [member command_pressed]. If [code]false[/code], those same keys will be serialized as [member meta_pressed] on macOS and [member ctrl_pressed] on all other platforms.
Made serialization of Command toggleable when saving InputEvents. Made serialization of Command optional. If command is serialized, Control (On Win/Linux) or Meta (on Mac) are not. Example use case: You are on Windows and you set a shortcut to be Control + E. This would serialize as Command=true and Control=true. If you then run this project on Mac, you would need to press Command AND Control to activate the shortcut - which is not what is intended. Now, you can set store_command to true, and it will only serialize to Command = true (no Control serialized). On Windows, this means Control. On Mac, it means only command.
2020-09-29 00:23:51 +10:00
This aids with cross-platform compatibility when developing e.g. on Windows for macOS, or vice-versa.
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
</members>
</class>
Reference in a new issue Copy permalink