search

godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.95k stars 3.22k forks source link

Vector2.reflect() and Vector2.bounce() are unclear #9948

Open tetrapod00 opened 2 months ago

tetrapod00 commented 2 months ago

Your Godot version: 4.3 Issue description: This issue originates from a question in the official discord. Making this issue to track it.

These should probably be clarified somehow, maybe with example vectors. Ideally illustrations could be added, but that is not typical of the docs.

Same issue might apply to Vector3.

A possible solution would be adding some info and a diagram about the difference between reflect and bounce here, then linking to it from the class ref pages if that's allowed.

URL to the documentation page (if already existing): https://docs.godotengine.org/en/stable/classes/class_vector2.html#class-vector2-method-bounce https://docs.godotengine.org/en/stable/classes/class_vector2.html#class-vector2-method-reflect https://docs.godotengine.org/en/stable/tutorials/math/vector_math.html#reflection

clayjohn commented 2 months ago

I think an image would be a big help. I think images are supported in the class ref now, but for a long time they weren't.

Also see the extensive previous discussions: https://github.com/godotengine/godot/issues/11678 https://github.com/godotengine/godot/pull/68392 https://github.com/godotengine/godot/pull/89404

tetrapod00 commented 1 week ago

Possibly also a duplicate of https://github.com/godotengine/godot-docs/issues/8962.