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

Codechange: use SetDParam for tooltips #11025

Merged
merged 2 commits into from Jun 17, 2023

Conversation

rubidium42
Copy link
Contributor

Motivation / Problem

The tooltip code has code to manually set parameters for its strings, which yields things like params[1] = (size_t)details.c_str();, but it also allows using SetDParam/SetDParamStr but then has a custom implementation for copying the data.
So why not unify it to SetDParam/SetDParamStr and CopyOutDParam, like the other functions handling string formatting parameters?

Description

Replace the params with SetDParam/SetDParamStr.
Remove the unneeded params parameter.
Replace customer parameter copying with CopyOutDParam.
Reorder arguments to tooltip function, because the close condition is essentially always set whereas the number of parameters is way more often just 0.

Limitations

None.

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')

@rubidium42 rubidium42 merged commit 836541b into OpenTTD:master Jun 17, 2023
18 checks passed
@rubidium42 rubidium42 deleted the dparam-tooltips branch June 17, 2023 09:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants