diff options
| author | Zak Grumbles <zakgrumbles@gmail.com> | 2020-09-24 22:06:55 -0500 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2022-07-17 11:29:59 +0200 |
| commit | 349c750b18acf770ef6f0e43643c8a37a3beb450 (patch) | |
| tree | 8f86becac6551c70dd384b77474158f9a8de3a71 /doc | |
| parent | 3953c1aa73bb0b4e96b3861dc83a380e7ce37da4 (diff) | |
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.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Camera3D.xml | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/doc/classes/Camera3D.xml b/doc/classes/Camera3D.xml index 56e5ce1522..468fddcfc1 100644 --- a/doc/classes/Camera3D.xml +++ b/doc/classes/Camera3D.xml @@ -155,6 +155,7 @@ </member> <member name="current" type="bool" setter="set_current" getter="is_current" default="false"> 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. </member> <member name="doppler_tracking" type="int" setter="set_doppler_tracking" getter="get_doppler_tracking" enum="Camera3D.DopplerTracking" default="0"> 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. See [enum DopplerTracking] for possible values. |