godotengine / godotengine/godot-docs

Add visuals to explain Vector methods

Open
#8,962 2 comments 4 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:** v4.2.1

**Issue description:**
Godot has some methods in the Vector API with uncommon names: e.g. `Slide`, `Bounce`, and `Reflect`. I have had to explain these methods to both new and experienced developers.

There have already been discussions and PRs about the need to clarify these methods in the docs:
#8286
#7664
https://github.com/godotengine/godot/pull/68392
https://github.com/godotengine/godot/pull/83691
https://github.com/godotengine/godot/issues/11678

There's enough confusion around these methods that adding graphics to the Vector docs is probably justified. It would be nice to point beginners to the docs whenever someone asks about these methods rather than pull out the MS Paint diagram :)

**URL to the documentation page (if already existing):**
https://docs.godotengine.org/en/stable/classes/class_vector2.html
https://docs.godotengine.org/en/stable/classes/class_vector3.html

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.