From a0a44578aa9db5c43d09e7787bae6cf0c32b1907 Mon Sep 17 00:00:00 2001 From: Micky Date: Sun, 21 Jan 2024 15:50:27 +0100 Subject: [PATCH] Tweak XROrigin3D documentation (cherry picked from commit 552403d581f0b254f9722c9af37494230d6141d1) --- doc/classes/XROrigin3D.xml | 9 ++++----- doc/classes/XRServer.xml | 2 +- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/doc/classes/XROrigin3D.xml b/doc/classes/XROrigin3D.xml index b7fc3a2752c..f3ddd140033 100644 --- a/doc/classes/XROrigin3D.xml +++ b/doc/classes/XROrigin3D.xml @@ -5,20 +5,19 @@ This is a special node within the AR/VR system that maps the physical location of the center of our tracking space to the virtual location within our game world. - There should be only one of these nodes in your scene and you must have one. All the XRCamera3D, XRController3D and XRAnchor3D nodes should be direct children of this node for spatial tracking to work correctly. + Multiple origin points can be added to the scene tree, but only one can used at a time. All the [XRCamera3D], [XRController3D], and [XRAnchor3D] nodes should be direct children of this node for spatial tracking to work correctly. It is the position of this node that you update when your character needs to move through your game world while we're not moving in the real world. Movement in the real world is always in relation to this origin point. - For example, if your character is driving a car, the XROrigin3D node should be a child node of this car. Or, if you're implementing a teleport system to move your character, you should change the position of this node. + For example, if your character is driving a car, the [XROrigin3D] node should be a child node of this car. Or, if you're implementing a teleport system to move your character, you should change the position of this node. $DOCS_URL/tutorials/xr/index.html - Is this XROrigin3D node the current origin used by the [XRServer]? + If [code]true[/code], this origin node is currently being used by the [XRServer]. Only one origin point can be used at a time. - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. - [b]Note:[/b] This method is a passthrough to the [XRServer] itself. + The scale of the game world compared to the real world. This is the same as [member XRServer.world_scale]. By default, most AR/VR platforms assume that 1 game unit corresponds to 1 real world meter. diff --git a/doc/classes/XRServer.xml b/doc/classes/XRServer.xml index 802d7ef2a98..0a2d5e2e96d 100644 --- a/doc/classes/XRServer.xml +++ b/doc/classes/XRServer.xml @@ -113,7 +113,7 @@ [b]Note:[/b] This property is managed by the current [XROrigin3D] node. It is exposed for access from GDExtensions. - Allows you to adjust the scale to your game's units. Most AR/VR platforms assume a scale of 1 game world unit = 1 real world meter. + The scale of the game world compared to the real world. By default, most AR/VR platforms assume that 1 game unit corresponds to 1 real world meter.