godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/XRController3D.xml

73 lines
3.3 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 20:42:36 +00: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 13:18:53 +00:00
<class name="XRController3D" inherits="XRNode3D" 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 20:42:36 +00:00
<brief_description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
A spatial node representing a spatially-tracked controller.
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 20:42:36 +00:00
</brief_description>
<description>
Docs: Language fixes in ARVR reference
2019-01-16 08:44:35 +00:00
This is a helper spatial node that is linked to the tracking of controllers. It also offers several handy passthroughs to the state of buttons and such on the controllers.
Renaming all ARVR nodes to XR
2020-04-08 14:47:36 +00:00
Controllers are linked by their ID. You can create controller nodes before the controllers are available. If your game always uses two controllers (one for each hand), you can predefine the controllers with ID 1 and 2; they will become active as soon as the controllers are identified. If you expect additional controllers to be used, you should react to the signals and add XRController3D nodes to your scene.
The position of the controller node is automatically updated by the [XRServer]. This makes this node ideal to add child nodes to visualize the controller.
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
As many XR runtimes now use a configurable action map all inputs are named.
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 20:42:36 +00:00
</description>
<tutorials>
Fix tutorial links in XR classes docs
2022-07-22 12:05:31 +00:00
<link title="XR documentation index">$DOCS_URL/tutorials/xr/index.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 20:42:36 +00:00
</tutorials>
<methods>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<method name="get_axis" qualifiers="const">
<return type="Vector2" />
<argument index="0" name="name" type="StringName" />
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 20:42:36 +00:00
<description>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
Returns a [Vector2] for the input with the given [code]name[/code]. This is used for thumbsticks and thumbpads found on many controllers.
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 20:42:36 +00:00
</description>
</method>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<method name="get_tracker_hand" qualifiers="const">
<return type="int" enum="XRPositionalTracker.TrackerHand" />
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 20:42:36 +00:00
<description>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
Returns the hand holding this controller, if known. See [enum XRPositionalTracker.TrackerHand].
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 20:42:36 +00:00
</description>
</method>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<method name="get_value" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="float" />
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<argument index="0" name="name" type="StringName" />
Added a mesh interface to the arvr positional trackers
2019-02-05 10:02:13 +00:00
<description>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
Returns a numeric value for the input with the given [code]name[/code]. This is used for triggers and grip sensors.
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
</description>
</method>
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 20:42:36 +00:00
<method name="is_button_pressed" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<argument index="0" name="name" type="StringName" />
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 20:42:36 +00:00
<description>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
Returns [code]true[/code] if the button with the given [code]name[/code] is pressed.
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 20:42:36 +00:00
</description>
classref: Sync with current source [ci skip]
2017-11-13 08:24:36 +00:00
</method>
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 20:42:36 +00:00
</methods>
<signals>
<signal name="button_pressed">
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<argument index="0" name="name" type="String" />
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 20:42:36 +00:00
<description>
[DOCS] ARVR, AStar, AtlasTexture, Basis
2017-12-07 06:16:27 +00:00
Emitted when a button on this controller is pressed.
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 20:42:36 +00:00
</description>
</signal>
Rename XRController signal button_release to button_released
2020-12-08 08:37:48 +00:00
<signal name="button_released">
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<argument index="0" name="name" type="String" />
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 20:42:36 +00:00
<description>
[DOCS] ARVR, AStar, AtlasTexture, Basis
2017-12-07 06:16:27 +00:00
Emitted when a button on this controller is released.
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 20:42:36 +00:00
</description>
</signal>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
<signal name="input_axis_changed">
<argument index="0" name="name" type="String" />
<argument index="1" name="value" type="Vector2" />
<description>
Emitted when a thumbstick or thumbpad on this controller is moved.
</description>
</signal>
<signal name="input_value_changed">
<argument index="0" name="name" type="String" />
<argument index="1" name="value" type="float" />
Added a mesh interface to the arvr positional trackers
2019-02-05 10:02:13 +00:00
<description>
Rework XR positional trackers
2021-08-29 06:05:11 +00:00
Emitted when a trigger or similar input on this controller changes value.
Added a mesh interface to the arvr positional trackers
2019-02-05 10:02:13 +00:00
</description>
</signal>
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 20:42:36 +00:00
</signals>
</class>