feat(Core/Scripting): Add OnPlayerBeforeGetLevelForXPGain hook#25295
Open
r-o-b-o-t-o wants to merge 7 commits intoazerothcore:masterfrom
Open
feat(Core/Scripting): Add OnPlayerBeforeGetLevelForXPGain hook#25295r-o-b-o-t-o wants to merge 7 commits intoazerothcore:masterfrom
OnPlayerBeforeGetLevelForXPGain hook#25295r-o-b-o-t-o wants to merge 7 commits intoazerothcore:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new PlayerScript hook (OnPlayerBeforeGetLevelForXPGain) to allow scripts to override the effective player level used when computing XP, and wires the hook into kill, quest, and exploration XP calculations.
Changes:
- Introduces
OnPlayerBeforeGetLevelForXPGain(Player const*, uint8& level)inPlayerScript/ScriptMgr. - Calls the hook during kill XP (
Acore::XP::Gain), quest reward XP (Player::CalculateQuestRewardXP), and exploration XP (Player::CheckAreaExploreAndOutdoor). - Integrates the hook into group-kill XP logic via a new
KillRewarder::_GetPlayerLevel()helper.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/server/game/Scripting/ScriptMgr.h | Declares the new ScriptMgr hook entry point. |
| src/server/game/Scripting/ScriptDefines/PlayerScript.h | Adds the new PlayerHook enum value and the virtual PlayerScript method. |
| src/server/game/Scripting/ScriptDefines/PlayerScript.cpp | Implements the ScriptMgr dispatcher for the new hook. |
| src/server/game/Miscellaneous/Formulas.cpp | Applies the hook to kill XP base-gain level selection. |
| src/server/game/Entities/Player/PlayerQuest.cpp | Applies the hook to quest reward XP level selection. |
| src/server/game/Entities/Player/Player.cpp | Applies the hook to exploration XP level selection. |
| src/server/game/Entities/Player/KillRewarder.h | Declares _GetPlayerLevel() helper to centralize adjusted level retrieval. |
| src/server/game/Entities/Player/KillRewarder.cpp | Uses _GetPlayerLevel() throughout group XP computations and rate calculation. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
Author
|
Bossed around by a clanker 😔 |
Member
Author
|
Ah we should probably wait for #25161 to be merged before going through with this |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes Proposed:
OnPlayerBeforeGetLevelForXPGainhook to thePlayerScriptThis PR proposes changes to:
AI-assisted Pull Requests
Important
While the use of AI tools when preparing pull requests is not prohibited, contributors must clearly disclose when such tools have been used and specify the model involved.
Contributors are also expected to fully understand the changes they are submitting and must be able to explain and justify those changes when requested by maintainers.
Issues Addressed:
N/A
SOURCE:
The changes have been validated through:
Tests Performed:
This PR has been:
How to Test the Changes:
Known Issues and TODO List:
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.