From 503b8892af094f4d878a73ba2d553e4ee68ea4f7 Mon Sep 17 00:00:00 2001 From: Logan Detrick Date: Thu, 13 Mar 2025 22:36:16 -0700 Subject: [PATCH] Clarify XRController input name is defined by XRInterface and explain for OpenXR --- doc/classes/XRController3D.xml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/classes/XRController3D.xml b/doc/classes/XRController3D.xml index 508752e0ae..d322b13795 100644 --- a/doc/classes/XRController3D.xml +++ b/doc/classes/XRController3D.xml @@ -7,7 +7,7 @@ This is a helper 3D 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. 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. - As many XR runtimes now use a configurable action map all inputs are named. + The current [XRInterface] defines the names of inputs. In the case of OpenXR, these are the names of actions in the current action set from the OpenXR action map. $DOCS_URL/tutorials/xr/index.html @@ -18,6 +18,7 @@ Returns a numeric value for the input with the given [param name]. This is used for triggers and grip sensors. + [b]Note:[/b] The current [XRInterface] defines the [param name] for each input. In the case of OpenXR, these are the names of actions in the current action set. @@ -25,6 +26,7 @@ Returns a [Variant] for the input with the given [param name]. This works for any input type, the variant will be typed according to the actions configuration. + [b]Note:[/b] The current [XRInterface] defines the [param name] for each input. In the case of OpenXR, these are the names of actions in the current action set. @@ -38,6 +40,7 @@ Returns a [Vector2] for the input with the given [param name]. This is used for thumbsticks and thumbpads found on many controllers. + [b]Note:[/b] The current [XRInterface] defines the [param name] for each input. In the case of OpenXR, these are the names of actions in the current action set. @@ -45,6 +48,7 @@ Returns [code]true[/code] if the button with the given [param name] is pressed. + [b]Note:[/b] The current [XRInterface] defines the [param name] for each input. In the case of OpenXR, these are the names of actions in the current action set.