virtualx-engine/doc/classes/InputEventWithModifiers.xml
Hugo Locurcio b087538119
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-03-16 23:01:02 +01:00

33 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputEventWithModifiers" inherits="InputEvent" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Base class for keys events with modifiers.
</brief_description>
<description>
Contains keys events information with modifiers support like [code]Shift[/code] or [code]Alt[/code]. See [method Node._input].
</description>
<tutorials>
<link>$DOCS_URL/tutorials/inputs/inputevent.html</link>
</tutorials>
<methods>
</methods>
<members>
<member name="alt" type="bool" setter="set_alt" getter="get_alt" default="false">
State of the [code]Alt[/code] modifier.
</member>
<member name="command" type="bool" setter="set_command" getter="get_command" default="false">
State of the [code]Command[/code] modifier.
</member>
<member name="control" type="bool" setter="set_control" getter="get_control" default="false">
State of the [code]Ctrl[/code] modifier.
</member>
<member name="meta" type="bool" setter="set_metakey" getter="get_metakey" default="false">
State of the [code]Meta[/code] modifier.
</member>
<member name="shift" type="bool" setter="set_shift" getter="get_shift" default="false">
State of the [code]Shift[/code] modifier.
</member>
</members>
<constants>
</constants>
</class>