godotengine / godotengine/godot-docs

CharacterBody doc should be consistent on mentionning move_and_slide or not

Open
#10,681 1 comment 1 reaction 0 assignees View on GitHub
area:class reference topic:physics
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

**Your Godot version:** 4.3

**Issue description:** A simple consistency issue which might make the documentation a little confusing : Some properties of _CharacterBody_ specify that they only modify the behavior of `move_and_slide`, and some don't, although they also do.

The documentation should either **never** specify that it affects `move_and_slide` as it is implicit, and eventually have a general mention that all x properties refers to `move_and_slide`, or **always** specify it refers to `move_and_slide`.

Otherwise, it makes it confusing, one could think the non specified properties do also affect `move_and_collide`.

**URL to the documentation page (if already existing):**

CharacterBody3D
- [floor_block_on_wall](https://docs.godotengine.org/en/stable/classes/class_characterbody3d.html#class-characterbody3d-property-floor-block-on-wall)
- [floor_constant_speed](https://docs.godotengine.org/en/stable/classes/class_characterbody3d.html#class-characterbody3d-property-floor-constant-speed) (although it's kind of implict with the requirement for `floor_snap_length`)
- [slide_on_ceiling](https://docs.godotengine.org/en/stable/classes/class_characterbody3d.html#class-characterbody3d-property-floor-constant-speed)
- [wall_min_slide_angle](https://docs.godotengine.org/en/stable/classes/class_characterbody3d.html#class-characterbody3d-property-wall-min-slide-angle)

CharacterBody2D
- [floor_block_on_wall](https://docs.godotengine.org/en/stable/classes/class_characterbody2d.html#class-characterbody2d-property-floor-block-on-wall)
- [floor_constant_speed](https://docs.godotengine.org/en/stable/classes/class_characterbody2d.html#class-characterbody2d-property-floor-constant-speed) (-- same remark as for `CharacterBody3D` --)
- [slide_on_ceiling](https://docs.godotengine.org/en/stable/classes/class_characterbody2d.html#class-characterbody2d-property-floor-constant-speed)
- [wall_min_slide_angle](https://docs.godotengine.org/en/stable/classes/class_characterbody2d.html#class-characterbody2d-property-wall-min-slide-angle)

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.