Show overhead icons when certain prayers are active

mbpolan · Oct 25, 2023 · 5ae3eba · 5ae3eba
1 parent b033ac4
commit 5ae3eba
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 0 deletions.
diff --git a/internal/game/game.go b/internal/game/game.go
@@ -2248,6 +2248,13 @@ func (g *Game) handleDeactivatePrayer(pe *playerEntity, prayerID int) {
 	delete(pe.player.ActivePrayers, prayerID)
 }
 
+// handleSetPlayerOverheadIcon sets the overhead icon displayed above the player.
+// Concurrency requirements: (a) game state may be locked and (b) this player should be locked.
+func (g *Game) handleSetPlayerOverheadIcon(pe *playerEntity, iconID int) {
+	pe.player.Appearance.OverheadIconID = iconID
+	pe.appearanceChanged = true
+}
+
 // handlePlayerSwapInventoryItem handles moving an item from one slot to another in a player's inventory.
 // Concurrency requirements: (a) game state may be locked and (b) this player should be locked.
 func (g *Game) handlePlayerSwapInventoryItem(pe *playerEntity, action *MoveInventoryItemAction) {

diff --git a/internal/game/game_script.go b/internal/game/game_script.go
@@ -68,4 +68,6 @@ type ScriptHandler interface {
 	handleActivatePrayer(pe *playerEntity, prayerID, drain int)
 	// handleDeactivatePrayer disables a prayer.
 	handleDeactivatePrayer(pe *playerEntity, prayerID int)
+	// handleSetPlayerOverheadIcon sets the overhead icon displayed above the player.
+	handleSetPlayerOverheadIcon(pe *playerEntity, iconID int)
 }
diff --git a/internal/game/script_manager.go b/internal/game/script_manager.go
@@ -659,6 +659,13 @@ func (s *ScriptManager) registerPlayerModel(l *lua.LState) {
 			s.handler.handleDeactivatePrayer(pe, prayerID)
 			return 0
 		},
+		"overhead_icon": func(state *lua.LState) int {
+			pe := state.CheckUserData(1).Value.(*playerEntity)
+			iconID := state.CheckInt(2)
+
+			s.handler.handleSetPlayerOverheadIcon(pe, iconID)
+			return 0
+		},
 	}))
 }
 

diff --git a/scripts/alib/globals.lua b/scripts/alib/globals.lua
@@ -150,6 +150,17 @@ ACCEPT_AID_NO = "NO"
 MOVE_SPEED_WALK = 0
 MOVE_SPEED_RUN = 1
 
+-- overhead icons
+OVERHEAD_NONE = 0
+OVERHEAD_PROTECT_FROM_MELEE = 1
+OVERHEAD_PROTECT_FROM_MISSILES = 2
+OVERHEAD_PROTECT_FROM_MAGE = 4
+OVERHEAD_RETRIBUTION = 8
+OVERHEAD_SMITE = 16
+OVERHEAD_REDEMPTION = 32
+OVERHEAD_WHITE_SKULL = 64
+OVERHEAD_RED_SKULL = 128
+
 -- identifiers for quest statuses
 QUEST_STATUS_NOT_STARTED = 0
 QUEST_STATUS_IN_PROGRESS = 1

diff --git a/scripts/prayers/protect_from_magic.lua b/scripts/prayers/protect_from_magic.lua
@@ -12,11 +12,13 @@ function prayer_protect_from_magic(player, activate)
         end
 
         -- TODO: add buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_PROTECT_FROM_MAGE)
 
         player:activate_prayer(PRAYER_PROTECT_FROM_MAGE, 12)
         player:interface_setting(setting_id, 1)
     else
         -- TODO: remove buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_NONE)
 
         player:deactivate_prayer(PRAYER_PROTECT_FROM_MAGE)
         player:interface_setting(setting_id, 0)

diff --git a/scripts/prayers/protect_from_melee.lua b/scripts/prayers/protect_from_melee.lua
@@ -12,11 +12,13 @@ function prayer_protect_from_melee(player, activate)
         end
 
         -- TODO: add buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_PROTECT_FROM_MELEE)
 
         player:activate_prayer(PRAYER_PROTECT_FROM_MELEE, 12)
         player:interface_setting(setting_id, 1)
     else
         -- TODO: remove buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_NONE)
 
         player:deactivate_prayer(PRAYER_PROTECT_FROM_MELEE)
         player:interface_setting(setting_id, 0)

diff --git a/scripts/prayers/protect_from_missiles.lua b/scripts/prayers/protect_from_missiles.lua
@@ -12,11 +12,13 @@ function prayer_protect_from_missiles(player, activate)
         end
 
         -- TODO: add buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_PROTECT_FROM_MISSILES)
 
         player:activate_prayer(PRAYER_PROTECT_FROM_MISSILES, 12)
         player:interface_setting(setting_id, 1)
     else
         -- TODO: remove buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_NONE)
 
         player:deactivate_prayer(PRAYER_PROTECT_FROM_MISSILES)
         player:interface_setting(setting_id, 0)

diff --git a/scripts/prayers/redemption.lua b/scripts/prayers/redemption.lua
@@ -18,11 +18,13 @@ function prayer_redemption(player, activate)
         end
 
         -- TODO: add buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_REDEMPTION)
 
         player:activate_prayer(PRAYER_REDEMPTION, 6)
         player:interface_setting(setting_id, 1)
     else
         -- TODO: remove buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_NONE)
 
         player:deactivate_prayer(PRAYER_REDEMPTION)
         player:interface_setting(setting_id, 0)

diff --git a/scripts/prayers/retribution.lua b/scripts/prayers/retribution.lua
@@ -18,11 +18,13 @@ function prayer_retribution(player, activate)
         end
 
         -- TODO: add buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_RETRIBUTION)
 
         player:activate_prayer(PRAYER_RETRIBUTION, 3)
         player:interface_setting(setting_id, 1)
     else
         -- TODO: remove buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_NONE)
 
         player:deactivate_prayer(PRAYER_RETRIBUTION)
         player:interface_setting(setting_id, 0)

diff --git a/scripts/prayers/smite.lua b/scripts/prayers/smite.lua
@@ -18,11 +18,13 @@ function prayer_smite(player, activate)
         end
 
         -- TODO: add buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_SMITE)
 
         player:activate_prayer(PRAYER_SMITE, 18)
         player:interface_setting(setting_id, 1)
     else
         -- TODO: remove buffs, effects, etc.
+        player:overhead_icon(OVERHEAD_NONE)
 
         player:deactivate_prayer(PRAYER_SMITE)
         player:interface_setting(setting_id, 0)