feat(Core/WorldState): implement Battle for Sun's Reach Event

[sogladev]

Changes Proposed:

This PR proposes changes to:

• Core (units, players, creatures, game systems).
• Scripts (bosses, spell scripts, creature scripts).
• Database (SAI, creatures, etc).

Adds handling for 4 phases and 3 subphases to capture the Isle of Quel'Danas through what is known as the Battle for Sun's Reach Event featuring new admin commands, new spawns, gossip, and conditions.

Adds handling of the 3 gates of the Sunwell Plateau.

By default, the phases are fully progressed, meaning the Isle of Quel'danas is in its final stage with all subphases completed. Similarly, all Sunwell Plateau gates are open. This state is stored in acore_character.world_state and can be removed to allow blizzlike progression.

Issues Addressed:

• Closes [Shattrath-Quel'Danas Isle] Shattered Sun Warriors and Marksman path. #20356
• Closes [Quel'Danas Isle] Incorrect NPC model using Chinese client (zhCN or enCN) #10795
• Closes K'iru's Song of Victory - Isle of Quel'Danas Zone Buff #1746

SOURCE:

The changes have been validated through:

• Live research (checked on live servers, e.g Classic WotLK, Retail, etc.)
• Sniffs (remember to share them with the open source community!)
• Video evidence, knowledge databases or other public sources (e.g forums, Wowhead, etc.)
• The changes promoted by this pull request come partially or entirely from another project (cherry-pick). Cherry-picks must be committed using the proper --author tag in order to be accepted, thus crediting the original authors, unless otherwise unable to be found

The Battle for Sun's Reach was a series of four major stages and three sub-stages involved in capturing the Isle of Quel'Danas. Completing daily quests for the Shattered Sun Offensive leads to the completion of the stages. As stages are completed, more NPCs appear and more quests are available.

https://wowpedia.fandom.com/wiki/Battle_for_Sun%27s_Reach

day 1 footage, Phase 0, https://www.youtube.com/watch?v=O9VacGvrCmw

Tests Performed:

This PR has been:

• Tested in-game by the author.
• Tested in-game by other community members/someone else other than the author/has been live on production servers.
• This pull request requires further testing and may have edge cases to be tested.

How to Test the Changes:

• This pull request can be tested by following the reproduction steps provided in the linked issue
• This pull request requires further testing. Provide steps to test your changes. If it requires any specific setup e.g multiple players please specify it as well.

tele to the island
.tele isleofquel
Nasuun Shattrath
.go c 96655

.worldstate sunsreach

Event.Announce = 1 useful to announce game events
.event activelist lists active events

Sun's Reach Reclamation

Setting phases can either be set through commands:

1. Phase can be freely set with phase to progress/deprogress phases.
2. Subphase can be set with subphase. These use a mask. They cannot be unset without a restart. Only activate subphases when their respective phase is active. For example: only activate anvil only once the armory is taken.

Or through reaching a quest count:
.worldstate sunsreach status gives an overview of the phase, subphases and progression status.

Each counter is only incremented and checked on quest turn ins.

A worldconfig option Sunsreach.CounterMax sets the amount of quests that need to be completed to reach. It's calculated as counter1 + counter2 >= countermax if there are multiple counters for an objective. For testing, set this to a low amount like 1-3.

Note that setting a counter through commands will not trigger a phase/subphase. You can set the counter higher than the CounterMax config.

Test list

• Switching phases is possible through quests
• Switching phases is possible through commands
• Flight Path to the island is available for Horde and Alliance

.quest add 11550
Alliance
.go c 2008
Horde
.go c 56866

For each phase:

• Check with Nasuun for gossip progress status after Sanctum is taken.

• Correct gossip texts of quest givers. Their gossip should indicate which phase is active.

• Correct dailies per phase. The quest text should indicate which phase is active.

• Some quest givers should show progress status to the next phase. Check if the percentage is correct

• enemy/friendly spawns are where they should be. No Dawnblade spawns in Shattered Sun territory. Or demons near the armory when armory has been taken.

• no duplicate mob spawns. Indicated if NPCs blend together

• Marksman/Warriors upgrade their gear depending on anvil/harbor status. armory/no anvil, armory/anvil, harbor/no anvil, harbor/anvil. This gear is set on spawn.

• (requires Sanctum) Portal subphase: Portals should be unavailable until Portal dailies from Nasuun (Shattrath) are complete. Once complete, portals spawn in Shattrath and the Island. In Shattrath, there should be NPCs pathing to and entering the portal.

• (requires Armory) Anvil subphase: vendors on the island (Smith) and Shattrath (near portal) should be unavailable until Anvil subphase is complete. Once complete, the anvil spawns.

• (requires Harbor) Alch subphase: vendors on the island (JC+Alch) and Shattrath (near portal) should be unavailable until Alch subphase is complete. Once complete, an alchemy lab spawns on the table.

• (requires All subphases) See if the buff "K'iru's Song of Victory" is only active in Sunwell/MGT/Island

Sunwell Gate Phases

.instance unbind all

Blizzlike gates are opened after a server restart, to simulate make sure to exit SWP and .instance unbind all when updating gate phases.

Test list

• Switching gates is possible through commands

.worldstate sunsreach gate 0
closed
.go ga 50441

.worldstate sunsreach gate 1
open
.go ga 50441
closed
.go ga 50439
enter SWP, gate should be closed

.worldstate sunsreach gate 2
open
.go ga 50441
open
.go ga 50439
closed
.go ga 50440

.worldstate sunsreach gate 3
open
.go ga 50441
open
.go ga 50439
open
.go ga 50440

.worldstate sunsreach phase [0-4]

all subphases,
.worldstate sunsreach subphase 15
spawns, weather, music
.worldstate sunsreach phase [0-4]

• Switching gates is possible through quests
  quests 11551, 11552, 11553
  These should lower the percentage of gates.

Known Issues and TODO List:

• sunwell gates: only 1 gate is closed at a time, expect all gates to be closed and unlocked 1 by 1
• sunwell gates: updating gate phase will open the existing gate but not close the next gate
• Portal subphase: island portal does not spawn NPCs
• sunwell gates: gossip menus/dialog of gate progression are incorrect
• smith: without an anvil spawned she still does her smithing animation

How to Test AzerothCore PRs

When a PR is ready to be tested, it will be marked as [WAITING TO BE TESTED].

You can help by testing PRs and writing your feedback here on the PR's page on GitHub. Follow the instructions here:

http://www.azerothcore.org/wiki/How-to-test-a-PR

REMEMBER: when testing a PR that changes something generic (i.e. a part of code that handles more than one specific thing), the tester should not only check that the PR does its job (e.g. fixing spell XXX) but especially check that the PR does not cause any regression (i.e. introducing new bugs).

For example: if a PR fixes spell X by changing a part of code that handles spells X, Y, and Z, we should not only test X, but we should test Y and Z as well.