godotengine / godotengine/godot-docs

Add note to SphereMesh's radius pointing to the height property

Open
#11,490 1 comment 0 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:**
4.5.1.stable

**Issue description:**
When using `SphereShape3D`, the `radius` property relates to the radius of the whole sphere.
When using `SphereMesh` however, the `radius` property relates to the radius of the sphere's equator. The `height` property handles, well the sphere's height.

As you may have guessed, when creating a sphere programmatically, my mesh was squished, since I'd handled my `SphereMesh` the way I'd handle a `SphereShape3D`

I wanted to add a small line to `SphereMesh.radius`'s description: "See also [member height]", or "[b]Note:[/b] to get a regular sphere, radius must be equal to half of [member height]".

Before making a PR with this change, I wanted first to run it by someone with more experience to know if it would be appreciated, or rather be deemed as unnecessary.

**URL to the documentation page (if already existing):**
[SphereMesh](https://docs.godotengine.org/en/stable/classes/class_spheremesh.html)
[SphereShape3D](https://docs.godotengine.org/en/stable/classes/class_sphereshape3d.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.