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

Doc: Clarify comment that SND_05_TRAIN_THROUGH_TUNNEL is only for ste… #8858

Merged
merged 1 commit into from Mar 14, 2021

Conversation

2TallTyler
Copy link
Member

…am engines

Motivation / Problem

Per #8857:

In the file src/sound_type.h, there is this sound ID:
SND_05_TRAIN_THROUGH_TUNNEL, ///< 3 == 0x03 Train enters tunnel
This is slightly misleading. I know this sound is ONLY played for steam trains. Any other train type entering a tunnel remains silent. So the description should reflect that.

Description

Change the comment to reflect this fact.

Closes #8857.

Limitations

Long commit title; feel free to change.

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

@TrueBrain TrueBrain merged commit 41baf87 into OpenTTD:master Mar 14, 2021
@2TallTyler 2TallTyler deleted the tunnel_sound branch March 14, 2021 12:17
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.

Clarify that SND_05_TRAIN_THROUGH_TUNNEL is for steam trains only
3 participants