Various tweaks to Camera2D's documentation #55699
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A summary of the tweaked descriptions: * "get_camera_position()" is explains what the camera position is, and mitigates the confusion between this method and Node2D.position; * "get_camera_screen_center()" links to the "get_camera_position" method; * "reset_smoothing()" links to the "smoothing_enabled" propriety; * "drag_horizontal_offset" and "drag_vertical_offset" link to their respective _enabled_ properties; * "limit_smoothed" links to the "smoothing_enabled" propriety; * "rotating" clarifies that the camera _view_ rotates when enabled. Partially closes godotengine/godot-docs#5417, as some of the issues described are no longer present in 4.0, or are not fully solved in this PR. Further tweaks are welcome, as I'm afraid this could be a too verbose. A few of these could be split into their PR if necessary.
mhilbrunner
approved these changes
Dec 15, 2021
|
Thank you, and congrats on your first contribution to Godot! 🎉 |
mhilbrunner
added
the
cherrypick:3.x
|
Note: we may want to cherry-pick this, not 100% sure if all properties are the same though. |
|
Cherry-picked for 3.5. |
akien-mga
removed
the
cherrypick:3.x
|
I'm afraid I still don't understand the
What target? Where can I set/define what this target is? What is meant by "view" here? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A summary of the tweaked descriptions:
get_camera_position()explains what the "camera position" is, and mitigates the confusion between this method andNode2D.position;get_camera_screen_center()links toget_camera_position();reset_smoothing()links tosmoothing_enabled;drag_horizontal_offsetanddrag_vertical_offsetlink to their respectiveenabledproperties;limit_smoothedlinks to thesmoothing_enabledpropriety;rotatingclarifies that the camera view rotates when enabled.Partially closes godotengine/godot-docs#5417, as some of the issues described are no longer present in 4.0, or are not fully solved in this PR.
Further adjustments are greatly appreciated, as I'm afraid this could be too verbose. A few of these could be split into their PR if necessary.