Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve ScriptText validation error messages and prevent circular references #10545

Merged
merged 2 commits into from Mar 5, 2023

Conversation

glx22
Copy link
Contributor

@glx22 glx22 commented Mar 5, 2023

Closes #10542

Motivation / Problem

As mentioned in #10542, ScriptText validation error messages are quite generic.
Also while testing the new messages I had a silly test idea which triggered a nice infinite recursion.

Description

Give more details in the error message to help script authors.
Introduce a mechanism to prevent circular references in ScriptText.

Limitations

Checklist for review

Some things are not automated, and forgotten often. This list is a reminder for the reviewers.

  • The bug fix is important enough to be backported? (label: 'backport requested')
  • This PR touches english.txt or translations? Check the guidelines
  • This PR affects the save game format? (label 'savegame upgrade')
  • This PR affects the GS/AI API? (label 'needs review: Script API')
    • ai_changelog.hpp, gs_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')

@glx22 glx22 added backport requested This PR should be backport to current release (RC / stable) needs review: Script API Review requested from GS/AI expert labels Mar 5, 2023
@2TallTyler 2TallTyler added backport requested This PR should be backport to current release (RC / stable) and removed backport requested This PR should be backport to current release (RC / stable) labels Mar 5, 2023
@glx22 glx22 merged commit ce8cde3 into OpenTTD:master Mar 5, 2023
@glx22 glx22 deleted the script_text_messages branch March 5, 2023 21:24
@glx22 glx22 removed the backport requested This PR should be backport to current release (RC / stable) label Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs review: Script API Review requested from GS/AI expert
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: BusyBee crashes on a new map since 991a797e098e22b8b3a0adaead757d691d80fca4
3 participants