Skip to content

feat(Core/Scripting): Add OnPlayerBeforeGetLevelForXPGain hook#25295

Open
r-o-b-o-t-o wants to merge 7 commits intoazerothcore:masterfrom
r-o-b-o-t-o:feat/playerhook-before-get-level-for-xp-gain
Open

feat(Core/Scripting): Add OnPlayerBeforeGetLevelForXPGain hook#25295
r-o-b-o-t-o wants to merge 7 commits intoazerothcore:masterfrom
r-o-b-o-t-o:feat/playerhook-before-get-level-for-xp-gain

Conversation

@r-o-b-o-t-o
Copy link
Copy Markdown
Member

@r-o-b-o-t-o r-o-b-o-t-o commented Mar 29, 2026

Changes Proposed:

  • Adds a OnPlayerBeforeGetLevelForXPGain hook to the PlayerScript
  • This hook is called when XP is calculated for the player, and is used to modify the player level used in the XP formulas
  • Called when calculating kill, quest, and exploration XP

This PR proposes changes to:

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

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.

  • AI tools (e.g. ChatGPT, Claude, or similar) were used entirely or partially in preparing this pull request. Please specify which tools were used, if any.

Issues Addressed:

N/A

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

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.

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.

@github-actions github-actions bot added CORE Related to the core file-cpp Used to trigger the matrix build labels Mar 29, 2026
@sudlud sudlud requested a review from Copilot March 29, 2026 13:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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) in PlayerScript/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.

@r-o-b-o-t-o
Copy link
Copy Markdown
Member Author

Bossed around by a clanker 😔

@r-o-b-o-t-o
Copy link
Copy Markdown
Member Author

Ah we should probably wait for #25161 to be merged before going through with this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CORE Related to the core file-cpp Used to trigger the matrix build Ready to be Reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants