Credits/Shop: Add hooks for credit related events.

CHANGELOG.md

@@ -8,9 +8,15 @@ All notable changes to TTT2 will be documented here. Inspired by [keep a changel
 
 - Added hook ENTITY:ClientUse(), which is triggered clientside if an entity is used
   - Return true to prevent also using this on the server for clientside only usecases
+- Added hook `GM:TTT2OnGiveFoundCredits()`, which is triggered serverside when a player has been given credits for searching a corpse.
+- Added hook `GM:TTT2ReceivedKillCredits()`, which is called when a player recieves credits for a kill.
+- Added hook `GM:TTT2ReceivedTeamAwardCredits()`, which is called when a player recieves credits as a team award.
+- Added hook `GM:TTT2TransferedCredits()`, which is called when a player has successfully transfered a credit to another player.
 
 ### Changed
 
+- TryRerollShop calls `TTT2OrderedEquipment` hook.
+
 ### Fixed
 
 ## [v0.13.1b](https://github.com/TTT-2/TTT2/tree/v0.13.1b) (2024-02-27)

gamemodes/terrortown/gamemode/server/sv_corpse.lua

@@ -732,3 +732,12 @@ function GM:TTT2ModifyRagdollVelocity(deadply, rag, velocity) end
 -- @hook
 -- @realm server
 function GM:TTTOnCorpseCreated(rag, deadply) end
+
+---
+-- Called after a player has been given credits for searching a corpse.
+-- @param Player ply The player that searched the corpse
+-- @param Entity rag The ragdoll that was searched
+-- @param number credits The amount of credits that were given
+-- @hook
+-- @realm server
+function GM:TTT2OnGiveFoundCredits(ply, rag, credits) end

gamemodes/terrortown/gamemode/server/sv_player_ext.lua

@@ -1891,3 +1891,20 @@ function GM:TTT2SetDefaultCredits(ply) end
 -- @hook
 -- @realm server
 function GM:TTT2ModifyDefaultTraitorCredits(ply, credits) end
+
+---
+-- Hook that is called when a player recieves credits for a kill.
+-- @param Player ply The player who killed another player
+-- @param Player victim The player who was killed
+-- @param number credits The amount of credits the player received
+-- @hook
+-- @realm server
+function GM:TTT2ReceivedKillCredits(ply, victim, credits) end
+
+---
+-- Hook that is called when a player recieves credits as a team award.
+-- @param Player ply The player who was awarded the credits
+-- @param number credits The amount of credits the player received
+-- @hook
+-- @realm server
+function GM:TTT2ReceivedTeamAwardCredits(ply, credits) end

gamemodes/terrortown/gamemode/server/sv_shop.lua

@@ -185,6 +185,16 @@ concommand.Add("ttt_cheat_credits", CheatCredits, nil, nil, FCVAR_CHEAT)
 -- @realm server
 function GM:TTT2CanTransferCredits(sender, recipient, credits_per_xfer) end
 
+---
+-- Called when a player has successfully transfered a credit to another player.
+-- @param Player sender Player that has sent the credits.
+-- @param Player recipient Player that has received the credits.
+-- @param number credits Amount of credits that have been transferred.
+-- @param boolean isRecipientDead If the recipient is dead or not.
+-- @hook
+-- @realm server
+function GM:TTT2TransferedCredits(sender, recipient, credits, isRecipientDead) end
+
 local function TransferCredits(ply, cmd, args)
     if #args ~= 2 then
         return

gamemodes/terrortown/gamemode/shared/sh_shop.lua

@@ -376,6 +376,10 @@ function shop.TryRerollShop(ply)
     else
         ply:SubtractCredits(GetGlobalInt("ttt2_random_shop_reroll_cost"))
         shop.ForceRerollShop(ply)
+        ---
+        -- @realm server
+        -- stylua: ignore
+        hook.Run("TTT2OrderedEquipment", ply, "reroll_shop", false, GetGlobalInt("ttt2_random_shop_reroll_cost"), false)
     end
 
     return true
@@ -427,13 +431,21 @@ function shop.TransferCredits(ply, targetPlyId64, credits)
 
         if target:IsTerror() and target:Alive() then
             target:AddCredits(credits)
+            ---
+            -- @realm server
+            -- stylua: ignore
+            hook.Run("TTT2TransferedCredits", ply, target, credits, false)
         else
             -- The would be recipient is dead, which the sender may not know.
             -- Instead attempt to send the credits to the target's corpse, where they can be picked up.
             local rag = target:FindCorpse()
 
             if IsValid(rag) then
                 CORPSE.SetCredits(rag, CORPSE.GetCredits(rag, 0) + credits)
+                ---
+                -- @realm server
+                -- stylua: ignore
+                hook.Run("TTT2TransferedCredits", ply, target, credits, false)
             end
         end
 

lua/ttt2/libraries/credits.lua

@@ -48,6 +48,12 @@ function credits.HandleKillCreditsAward(victim, attacker)
         local creditsAmount = GetConVar("ttt_credits_award_kill"):GetInt()
 
         attacker:AddCredits(creditsAmount)
+
+        ---
+        -- @realm server
+        -- stylua: ignore
+        hook.Run("TTT2ReceivedKillCredits", victim, attacker, creditsAmount)
+
         LANG.Msg(
             attacker,
             "credit_kill",
@@ -143,6 +149,12 @@ function credits.HandleKillCreditsAward(victim, attacker)
 
             -- now reward their player for their good game
             plyToAward:AddCredits(creditsAmount)
+
+            ---
+            -- @realm server
+            -- stylua: ignore
+            hook.Run("TTT2ReceivedTeamAwardCredits", plyToAward, creditsAmount)
+
             LANG.Msg(plyToAward, "credit_all", { num = creditsAmount }, MSG_MSTACK_ROLE)
         end
     end