Specify max_slides must be greater than 0
#101776
Conversation
AThousandShips
changed the title
max_slides must be greater than 0
doc/classes/CharacterBody2D.xml
Outdated
| @@ -166,7 +166,7 @@ | |||
| If [code]false[/code], the body will slide on floor's slopes when [member velocity] applies a downward force. | |||
| </member> | |||
| <member name="max_slides" type="int" setter="set_max_slides" getter="get_max_slides" default="4"> | |||
| Maximum number of times the body can change direction before it stops when calling [method move_and_slide]. | |||
| Maximum number of times the body can change direction before it stops when calling [method move_and_slide]. Must be > 0. | |||
There was a problem hiding this comment.
| Maximum number of times the body can change direction before it stops when calling [method move_and_slide]. Must be > 0. | |
| Maximum number of times the body can change direction before it stops when calling [method move_and_slide]. Must be greater than zero. |
For both
There was a problem hiding this comment.
Your wording is better, I'll update the PR soon, as I'm away from my machine ATM.
|
Note that setting the value to anything less than 1 triggers an error, so this isn't invisible |
True, but more visibility can't hurt, as I missed it at first. |
|
Remember to squash commits together into a single commit: https://docs.godotengine.org/en/stable/contributing/workflow/pr_workflow.html#the-interactive-rebase |
|
@Calinou Sorry, do I do that locally, or is it done on GitHub? Sorry, this is my first PR to a big project, so I'm not sure - I feel a bit raw doing all this for such a small tweak. |
This is a change to the docs, highlighting a potential gotcha that wasted a few hours of my time. Hopefully, this helps someone else.