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

Change: Display more useful information in sprite aligner than sprite ID. #12439

Merged
merged 1 commit into from Apr 6, 2024

Conversation

PeterN
Copy link
Member

@PeterN PeterN commented Apr 6, 2024

Motivation / Problem

Sprite IDs are not useful information given they change don't refer to anything outside the loaded game.

They may give (and has given) the false impression that Action A can be used with these IDs, when in fact anything outside of the original baseset is dynamic.

It also isn't very useful to terms of finding out where each sprite is within its file.

image

Description

Instead of showing the internal SpriteID, include the filename and nfo line at minimum, and include action A or action 5 sprite replacement information if applicable.

This splits of Action5Type information so that it is available to newgrf_debug_gui.cpp as well as newgrf.cpp -- this avoids duplicating the information (which my first version did...)

image

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, game_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')

… ID.

Sprite IDs are not useful information given they change don't refer to anything outside the loaded game.

Instead, include the filename and nfo line at minimum, and include action A or action 5 sprite replacement information if applicable.
@PeterN PeterN merged commit 34ba969 into OpenTTD:master Apr 6, 2024
14 checks passed
@PeterN PeterN deleted the sprite-aligner-better-ids branch April 6, 2024 20:16
ladysadie pushed a commit to ladysadie/OpenTTD_WIP that referenced this pull request Apr 10, 2024
… ID. (OpenTTD#12439)

Sprite IDs are not useful information given they change don't refer to anything outside the loaded game.

Instead, include the filename and nfo line at minimum, and include action A or action 5 sprite replacement information if applicable.
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