Godot: Button text ignores breakline (\n)

[purpleorangegames]

If I set a text with a breakline like "Hello\nthere" and set this text to the Button text and tooltip, the breakline works on the tooltip but is ignored on the text.

[StraToN]

I confirm this if the texts are set by GDScript.
But when setting tooltip's text "Hello\nthere" directly in the editor, no breakline appears in the tooltip.

[purpleorangegames]

@StraToN I really just tested this on GDScript.
Are saying that when using the Editor neither the text button nor the tooltip breaks the line?

[StraToN]

@purpleorangegames Exactly.

[reduz]

tooltip should have line break, but button does not. The code in Label should be somehow abstracted to work in other controls.

[StraToN]

@reduz ok then we should only focus on having line breaks working for tooltips (using both editor setting or GDscript)

[purpleorangegames]

I agree that buttons should not have line breaks unless it's a button for a game.
I have seen plenty of game buttons specially in smartphone games that use linebreaks but it's not something major, would be nice to have but I can live without it and use a custom solution.

[StraToN]

How should line breaks be managed if they were working in Buttons? I guess the button's height should be updated according to the text, right?

[purpleorangegames]

I guess it should, to match the behavior of automatically adjusting the width with the text length.
Although I don't like it very much, I prefer the button to have a fixed size no matter the text, so I can manually adjust it if needed. It is a nice feature if set as optional.
The text is already set as centered and shouldn't change.
What we wouldn't need here is word wrap, as it could cause a lot of confusion and also it should be used in places where you have a lot text being displayed which isn't the case of a button.

Actually, for me the only change necessary would be to the break line code to work.

[StraToN]

If nobody resolves this until Tuesday, I'll have a look for fixing this.

[StraToN]

Some precisions after further investigations.
As @reduz said, line breaks in Buttons' captions won't work for the moment. I will leave this apart.

Concerning tooltips, there are 2 ways to set them: in the editor, and by GDScript.

• in the editor, line breaks work, but you actually need to effectively break the line in the text editor of the tooltip (see image 1).
  

Inserting "\n" will thus print "\n" (image 2)

• By GDScript, the only way is to set the tooltip with:

extends Button

func _ready():
    set_tooltip("Hello\nthere")
    pass

So this actually works correctly already, I see nothing more to do.

[akien-mga]

As #4327 shows, there's also a related issue with \t not working in Labels (and presumably also in Buttons and Tooltips as debugged here).

[q00u]

So is there _still_ no way to have two lines of text on a button?

[Undid-Iridium]

I have looked into the issue (Very Recently) and have a solution to it (Unless someone states otherwise/comes up with a better one). I will be uploading it later tonight/tomorrow (Forking + Pull Request)/(Need to read Documentation). It will do as requested, and can handle both \n and (Potentially \t, more like 4 spaces currently since \t is Designed to create spaces until the next predefined column, in which, it's going to stay 4 spaces unless someone wants a more modular solution). Furthermore, the formatting regarding the pre-runtime in the tool-tip box, and the run-time correct formatting will remain separate. I can upload a gif to demonstrate. If you want more escape characters added please comment them here. Thanks.

[asheraryam]

Proposed solution: https://github.com/godotengine/godot/pull/24048

[Aaron-Fleisher]

This can be done with a Button->Label hierarchy (make sure to set Label's layout to Full Rect)

[q00u]

That seems to put text over a button, but doesn't inherit the buttons enabled/disabled behavior. Unless I'm missing something.

It's NOT the same thing as having a line-break on the button itself.

[Undid-Iridium]

So.. Was it more like this? I was not sure if I understood the problem correctly. (I only started looking into issues a week ago, and started this one a day or two ago. So I followed the gif posted earlier and tried to understand the problem through that.)

From what I understood the point was that there would be pre-runtime formatting such as \n and \t that could be written in tooltip to reduce amount of spacing required. Thereafter the tooltip text would be formatted correctly during run-time. If I am wrong then yeah label would suffice.

[Aaron-Fleisher]

That seems to put text over a button, but doesn't inherit the buttons enabled/disabled behavior. Unless I'm missing something.

It's NOT the same thing as having a line-break on the button itself.

Yeah, that's true. Was just showing the power of the UI System (extremely underrated) in Godot. To achieve the same effect visually

[MEBonham]

This thread makes it look like this issue got fixed, but I'm still experiencing it.

[StraToN]

@MEBonham PR #24374 could help but is not merged yet (conflicts).

[Sslaxx]

Bump. Is this still an issue, can anyone reproduce this with 3.2.2?

[Calinou]

@Sslaxx I can still reproduce this in 3.2.2, even when setting the button's text by code.

[rmasp98]

Is anyone working on this? It looks like #24374 had the right idea but just never got merged. I am happy to pick this up

[Calinou]

@rmasp98 Thanks for your interest in contributing! Since there's no open pull request for it, feel free to work on a fix for this :slightly_smiling_face:

[rmasp98]

I was wrong. That pull request doesn't fix buttons, which I think is the only thing that is still broken. I guess the solution, is probably in how the button text is rendered. I may need a little help in finding where in the code this happens

[Waridley]

I just got this working with \n, just need to make sure I'm not missing any corner cases, and will probably try to make sure it works with \r\n and other line break character combinations as well before submitting a PR.

[rmasp98]

Umm ok... I guess I will chuck the stuff I have been working on away then

[Waridley]

@rmasp98 Sorry, didn't mean to step on your toes. I actually just did it for my own use before even checking this thread. And I've only implemented it for buttons, no other controls, so if you're still trying to clean up that stale PR for the others, go for it.

[Waridley]

Also it's entirely possible your method is better than mine. Wouldn't hurt to see another solution.