From 967755980f98c9645ba20df0582fcf4e000ce689 Mon Sep 17 00:00:00 2001 From: Zak Grumbles Date: Thu, 24 Sep 2020 22:06:55 -0500 Subject: [PATCH] Improve documentation for Camera3D's `current` member * Added additional information to the camera documentation to explain how the 'current' attribute behaves when multiple cameras are in a scene. (cherry picked from commit 349c750b18acf770ef6f0e43643c8a37a3beb450) --- doc/classes/Camera.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index cc2d7233603..b87acde907a 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -142,6 +142,7 @@ If [code]true[/code], the ancestor [Viewport] is currently using this camera. + If multiple cameras are in the scene, one will always be made current. For example, if two [Camera3D] nodes are present in the scene and only one is current, setting one camera's [member current] to [code]false[/code] will cause the other camera to be made current. If not [constant DOPPLER_TRACKING_DISABLED], this camera will simulate the [url=https://en.wikipedia.org/wiki/Doppler_effect]Doppler effect[/url] for objects changed in particular [code]_process[/code] methods. The Doppler effect is only simulated for [AudioStreamPlayer3D] nodes that have [member AudioStreamPlayer3D.doppler_tracking] set to a value other than [constant AudioStreamPlayer3D.DOPPLER_TRACKING_DISABLED].