Skip to content

fix: wave method naming and add force pause support#784

Open
ArdaKaramanx wants to merge 8 commits intoExMod-Team:masterfrom
ArdaKaramanx:master
Open

fix: wave method naming and add force pause support#784
ArdaKaramanx wants to merge 8 commits intoExMod-Team:masterfrom
ArdaKaramanx:master

Conversation

@ArdaKaramanx
Copy link
Copy Markdown

Description

Describe the changes
Refactored wave management methods to better reflect their actual behavior and added proper pause control functionality:

  • Renamed the old PauseWaves() method to ClearWaves() since it was clearing waves instead of pausing them.
  • Implemented a new ForcePauseWaves(bool) method to properly pause and resume time-based waves.
  • Fixed incorrect XML documentation to match the real behavior of these methods.

What is the current behavior? (You can also link to an open issue here)

  • Previously PauseWaves() was incorrectly named and removed waves instead of pausing them. There was no proper way to pause wave timers without removing them from the system.

What is the new behavior? (if this is a feature change)

  • ClearWaves() now correctly represents wave removal.
  • New ForcePauseWaves(bool) allows force pausing and resuming wave timers.
  • Documentation now correctly reflects method behavior.

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

  • Possibly. If any plugins relied on the old PauseWaves() behavior they may need to update their code to use ClearWaves() instead.

Other information:

  • Improves API clarity and provides better control over wave timing behavior.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentations

Submission checklist

  • I have checked the project can be compiled
  • I have tested my changes and it worked as expected

Patches (if there are any changes related to Harmony patches)

  • I have checked no IL patching errors in the console

Other

  • Still requires more testing

@ArdaKaramanx
Copy link
Copy Markdown
Author

This is my first time posting a PR; please let me know if there are any issues.

ArdaKaramanx and others added 2 commits March 27, 2026 02:29
Co-authored-by: Yamato <66829532+louis1706@users.noreply.github.com>
Co-authored-by: Yamato <66829532+louis1706@users.noreply.github.com>
@ArdaKaramanx
Copy link
Copy Markdown
Author

Fixed

@ArdaKaramanx
Copy link
Copy Markdown
Author

In addition, changes need to be made to the other Pausewave codes as well

ClaerWaves() Name fix ClearWaves()
PauseWave(SpawnableFaction,bool) Add
ClearWave(SpawnableFaction) renamed
@ArdaKaramanx
Copy link
Copy Markdown
Author

ClaerWaves() Name fix ClearWaves()
PauseWave(SpawnableFaction,bool) Add
ClearWave(SpawnableFaction) renamed

Copy link
Copy Markdown

@Someone-193 Someone-193 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay so there are breaking changes in this PR (not a major problem, it just means some peoples plugins will stop working next update, because either a method was renamed or a parameter was added, etc... changes like those). What this means for you is that if you want your PR merged into master (your current target branch) for next update, you'll have to get rid of all the breaking changes (so no methods get modified, only fully new ones get added). Or you could switch the target of this PR to dev, and wait for it to be merged for Exiled 10 (which will take a while to be made, but you can have breaking changes). The choice is yours

PauseWave(SpawnableFaction,bool) Renamed ForcePauseWave(SpawnableFaction,bool)
PauseWaves(bool) Renamed ForcePauseWaves(bool)
PauseWaves(List<SpawnableFaction>) Renamed ForcePauseWaves(List<SpawnableFaction>)
@ArdaKaramanx ArdaKaramanx requested a review from louis1706 March 28, 2026 22:09
@ArdaKaramanx
Copy link
Copy Markdown
Author

The suggestions have been reviewed and the changes have been implemented; they are awaiting approval

@ArdaKaramanx ArdaKaramanx changed the title Fix wave method naming and add force pause support fix: wave method naming and add force pause support Mar 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants