godot/doc/classes/InputEventWithModifiers.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventWithModifiers" inherits="InputEventFromWindow" version="4.0">
	<brief_description>
		Base class for keys events with modifiers.
	</brief_description>
	<description>
		Contains keys events information with modifiers support like [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See [method Node._input].
	</description>
	<tutorials>
		<link title="InputEvent">$DOCS_URL/tutorials/inputs/inputevent.html</link>
	</tutorials>
	<members>
		<member name="alt_pressed" type="bool" setter="set_alt_pressed" getter="is_alt_pressed" default="false">
			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.
		</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.
		</member>
		<member name="shift_pressed" type="bool" setter="set_shift_pressed" getter="is_shift_pressed" default="false">
			State of the [kbd]Shift[/kbd] modifier.
		</member>
		<member name="store_command" type="bool" setter="set_store_command" getter="is_storing_command" default="true">
			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.
			This aids with cross-platform compatibility when developing e.g. on Windows for macOS, or vice-versa.
		</member>
	</members>
</class>
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-13 04:42:36 +08:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-31 00:22:57 +08:00			`<class name="InputEventWithModifiers" inherits="InputEventFromWindow" version="4.0">`
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-13 04:42:36 +08:00			`<brief_description>`
[DOCS] InputEvent* 2017-10-16 06:07:13 +08: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-13 04:42:36 +08:00			`</brief_description>`
			`<description>`
Improve shortcut formatting in docs 2020-03-10 18:41:36 +08: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-13 04:42:36 +08:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:43:07 +08: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-13 04:42:36 +08:00			`</tutorials>`
			`<members>`
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods 2021-04-25 04:33:50 +08: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 18:41:36 +08: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-13 04:42:36 +08:00			`</member>`
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods 2021-04-25 04:33:50 +08: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 18:41:36 +08: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-13 04:42:36 +08:00			`</member>`
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods 2021-04-25 04:33:50 +08: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 18:41:36 +08: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-13 04:42:36 +08:00			`</member>`
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods 2021-04-25 04:33:50 +08: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 18:41:36 +08: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-13 04:42:36 +08:00			`</member>`
Rename "Control" key to "Ctrl" and add "_pressed" suffix to all InputEventWithModifiers properties/methods 2021-04-25 04:33:50 +08: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 18:41:36 +08: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-13 04:42:36 +08: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-28 22:23:51 +08: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-25 04:33:50 +08: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-28 22:23:51 +08: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-13 04:42:36 +08:00			`</members>`
			`</class>`