Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add consistent cross-links between Project Settings and runtime equivalents #9944

Open
1 of 42 tasks
tetrapod00 opened this issue Sep 11, 2024 · 0 comments
Open
1 of 42 tasks

Comments

@tetrapod00
Copy link
Contributor

tetrapod00 commented Sep 11, 2024

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
  • 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant