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 documentation to Sprite2D and Sprite3D nodes to clarify that the offset.y values have opposite axes #10731

Open
Proggle opened this issue Mar 2, 2025 · 0 comments
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository enhancement topic:2d topic:3d

Comments

@Proggle
Copy link

Proggle commented Mar 2, 2025

Your Godot version:
v4.3.stable.official [77dcf97d8]
Issue description:

The offset parameters in Sprite2D and Sprite3D objects have no documentation to indicate they have opposite y axes

To replicate:

Make a Sprite2D, and assign an image
Increase the 'offset.y' value of the Sprite2D. The pivot stays in the same place, but the Sprite2D image moves down.

Make a Sprite3D, and assign an image
Increase the 'offset.y' value of the Sprite3D. The pivot stays in the same place, but the Sprite3D image moves up.

Documentation for the two is identical: "The texture's drawing offset."

This is needlessly confusing, but I doubt it can be changed in the actual engine without breaking a lot of games. However, to save needless time and confusion it ought to be mentioned in the documentation that these identical properties have opposite effects.

@tetrapod00 tetrapod00 added enhancement area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository topic:2d topic:3d labels Mar 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:class reference Issues and PRs about the class reference, which should be addressed on the Godot engine repository enhancement topic:2d topic:3d
Projects
None yet
Development

No branches or pull requests

2 participants