General lack of clarity for Camera2D properties and methods. #5417
Labels
area:class reference
Issues and PRs about the class reference, which should be addressed on the Godot engine repository
enhancement
Your Godot version:
v3.4.stable
Issue description:
Some sections of Camera2D's documentation seem to be written too vaguely. Its properties depend on each other, yet these refer to each other inconsistently in their own descriptions. It doesn't help that some Camera2D's property names can be somewhat confusing, further hurting the readability of the documentation.
General list of issues:
A specific list of examples:
smoothing_enabled
androtating
's description ("camera smoothly moves towards the target" and "the camera rotates with the target", respectively);rotation
properties;smoothing_enabled
is set to false";get_camera_screen_center ( )
, despite both returning similar values upon first glance;current
property that serves a similar purpose;smoothing_enabled
is set to false".Some of these examples are down to opinion, but the main issue is a lack of consistency. The Camera2D node has some minor, cumulative complexities that should be explained more clearly.
URL to the documentation page (if already existing):
https://docs.godotengine.org/en/stable/classes/class_camera2d.html?#class-camera2d-property-current
The text was updated successfully, but these errors were encountered: