Fix \r\n-style line endings not being properly handled for script errors

[abcdefg30]

Otherwise the \r characters remain on their own (without \n characters) and display as artifacts.

[PunkPun]

This doesn't feel correct. The vast majority of the codebase doesn't have or use \r so removing it here doesn't make sense. It should be removed the moment a string enters our codebase.

[abcdefg30]

This doesn't feel correct. The vast majority of the codebase doesn't have or use \r so removing it here doesn't make sense. It should be removed at the exact flawed implementation

The flawed implementation is this function assuming that all strings use just \n for indicating new lines. I don't think we should abandon the general solution and fix every specific case.

[PunkPun]

it's a correct assumption though. Why would text contain \r ? We go to great lengths to not have any \r in the engine

[Mailaender]

This is in line with

OpenRA/OpenRA.Mods.Common/Widgets/Logic/MissionBrowserLogic.cs

Line 268 in 445b736

var briefing = WidgetUtils.WrapText(missionData.Briefing?.Replace("\\n", "\n"), description.Bounds.Width, descriptionFont);

where a similar correction is done in UI code.

[PunkPun]

If we are going to handle \r, it should either be engine wide or at the source. Not somewhere in the middle like this PR

IMO it should be moved to ScriptErrorLogic.

[penev92]

Ideally it would be moved to somewhere that handles all text that we display in-game.

[PunkPun]

we remove the \r when streaming files & reading yaml. So basically in most places you can't find \r and it doesn't make sense to handle at a UI level

[penev92]

it doesn't make sense to handle at a UI level
The issue is literally that our UI can't handle visualizing it.

On the other hand, it is not ScriptErrorLogic's job to know or think about the presentation layer, UI, how to visualize things, etc.

And yes, the most prominent source of "\r\n" would likely be .NET exceptions, but it could also be any library that we use, any text that is somehow read by the game to be displayed and perhaps even user text pasted into the chat?

[PunkPun]

user text pasted into the chat

Then we should also add \r removal in chat input

[anvilvapre]

I would lean towards PunkPun opinion. Best to strip at input, before start, or support it throughput.

[abcdefg30]

Seems like I got outvoted (here and on Discord), so changed.

[PunkPun]

LGTM, Untested

[Mailaender]

Changelog