godotengine / godotengine/godot-docs

Add consistent cross-links between Project Settings and runtime equivalents

Open
#9,944 0 comments 0 reactions 0 assignees View on GitHub
area:class reference enhancement tracker
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:**
Many (most?) project settings have equivalents that can be changed at runtime in various classes. It would be good to consistently cross-link in both directions. Cross-linking from the project settings is especially important, as searching the project settings is easy but it's not always clear which class has the runtime equivalent.

If standard phrasing can be used, that's even better.

I'll be doing this in bits and pieces. There are a *lot* of settings to get through, so if anyone else wants to help with this, this issue should be a tracker, split by class or project settings section.

Sections completed:
- [ ] Application
- [ ] Display
- [ ] Animation
- [ ] Audio
- [ ] Editor
- [ ] Physics
- [ ] Debug
- [ ] Compression
- [ ] **Rendering**
- [ ] `rendering/occlusion_culling`
- [ ] `rendering/rendering_device`
- [ ] `rendering/textures`
- [ ] `rendering/gl_compatibility`
- [ ] `rendering/renderer`
- [ ] `rendering/driver`
- [ ] `rendering/limits`
- [ ] `rendering/lights_and_shadows`
- [ ] `rendering/2d`
- [ ] `rendering/shader_compiler`
- [ ] `rendering/reflections`
- [ ] `rendering/global_illumination`
- [ ] `rendering/shading`
- [ ] `rendering/camera`
- [ ] `rendering/environment`
- [x] `rendering/anti_aliasing` - runtime settings in Viewport, RenderingServer
- [ ] `rendering/scaling_3d`
- [ ] `rendering/lightmapping`
- [ ] `rendering/viewport`
- [ ] `rendering/mesh_lod`
- [ ] `rendering/vrs`
- [ ] Internationalization
- [ ] GUI
- [ ] Collada
- [ ] Network
- [ ] Threading
- [ ] XR
- [ ] Memory
- [ ] Input Devices
- [ ] Layer Names
- [ ] FileSystem
- [ ] Navigation
- [ ] Dotnet

**URL to the documentation page (if already existing):**
Examples:
`Default Clear Color`: Project settings links to runtime, but runtime does not link to project settings:
https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-rendering-environment-defaults-default-clear-color
https://docs.godotengine.org/en/stable/classes/class_renderingserver.html#class-renderingserver-method-set-default-clear-color
`Max FPS`: already has good cross-links:
https://docs.godotengine.org/en/stable/classes/class_projectsettings.html#class-projectsettings-property-application-run-max-fps
https://docs.godotengine.org/en/stable/classes/class_engine.html#class-engine-property-max-fps

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.