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.

Sign up for GitHub

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

Jump to bottom

Fix #12509: Timer period modifications may violate invariants of TimerManager::base_timer_sorter std::set sorting #12546

Merged
merged 2 commits into from
Apr 25, 2024
Merged

Fix #12509: Timer period modifications may violate invariants of TimerManager::base_timer_sorter std::set sorting #12546

merged 2 commits into from
Apr 25, 2024

Conversation

JGRennison
Copy link
Contributor

Motivation / Problem

#12509

Description

Add a priority field to TimerGameTick::TPeriod, such that saveload period changes to _new_competitor_timeout do not result in changes to the timer manager container sort order.

TimeoutTimer::Reset(const TPeriod timeout) and IntervalTimer::SetInterval now correctly maintain the manager container sort order invariants.

Limitations

N/A

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

@JGRennison
Codechange: Add a priority field to TimerGameTick::TPeriod
2848d64 
Use this as the primary sort key for TimerGameTick::TPeriod,
to avoid container sort order changes on timer period saveload.
See: OpenTTD#12509
@JGRennison
Fix OpenTTD#12509: Maintain timer sort invariants when changing period
a3c8592
@rubidium42 rubidium42 added the backport requested This PR should be backport to current release (RC / stable) label Apr 23, 2024
@rubidium42 rubidium42 merged commit 9b747a1 into OpenTTD:master Apr 25, 2024
15 checks passed
@PeterN PeterN mentioned this pull request Apr 30, 2024
Merged
@PeterN PeterN added backported This PR is backported to a current release (RC / stable) and removed backport requested This PR should be backport to current release (RC / stable) labels Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rubidium42 rubidium42 rubidium42 approved these changes

Assignees
No one assigned
Labels
backported This PR is backported to a current release (RC / stable)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@JGRennison @rubidium42 @PeterN