godotengine / godotengine/godot-docs

Improve `Viewport.follow_viewport_enabled` description to be less confusing

Open
#10,217 2 comments 2 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:** 4.3

**Issue description:**
The description for `follow_viewport_enabled` is currently as follows:
> If enabled, the CanvasLayer will use the viewport's transform, so it will move when camera moves instead of being anchored in a fixed position on the screen.

This seems rather confusing, as both options described sound equivalent. "Moving when the camera moves" sounds like it will remain visually in the same place on the screen, but the alternative is "being anchored in a fixed position on the screen".

I will put together a little project to test this and determine what it actually does in practice, but my current guess is that "anchored in a fixed position *on the screen*" should be replaced by something like "anchored in a fixed position *in the world*"?

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/classes/class_canvaslayer.html#class-canvaslayer-property-follow-viewport-enabled

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.