fix: small adjustments and corrections to the core (opentibiabr#2524)

- Previously, players were not being removed from the room upon killing
the boss, as the relevant script was confined to rlmap only. This update
ensures its functionality across any datapack.
- Hirelings are now accessible beyond rlmap environments.
- Addressed an issue with the loading of VIP days library.
- Relocated the large sea shell asset to the core.
- Implemented VIP status check and associated actions.
- Transferred weapons scripts to the core.

data-otservbr-global/lib/others/load.lua

@@ -1,2 +1 @@
 dofile(DATA_DIRECTORY .. "/lib/others/dawnport.lua")
-dofile(DATA_DIRECTORY .. "/lib/others/vip_system.lua")

data/libs/functions/load.lua

@@ -1,14 +1,15 @@
 -- Load core functions
 dofile(CORE_DIRECTORY .. "/libs/functions/bit.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/bitwise_flags.lua")
+dofile(CORE_DIRECTORY .. "/libs/functions/boss_lever.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/combat.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/constants.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/container.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/creature.lua")
-dofile(CORE_DIRECTORY .. "/libs/functions/functions.lua")
-dofile(CORE_DIRECTORY .. "/libs/functions/gematelier.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/fs.lua")
+dofile(CORE_DIRECTORY .. "/libs/functions/functions.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/game.lua")
+dofile(CORE_DIRECTORY .. "/libs/functions/gematelier.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/item.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/itemtype.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/lever.lua")
@@ -20,14 +21,13 @@ dofile(CORE_DIRECTORY .. "/libs/functions/player.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/position.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/pronouns.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/quests.lua")
+dofile(CORE_DIRECTORY .. "/libs/functions/queue.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/revscriptsys.lua")
+dofile(CORE_DIRECTORY .. "/libs/functions/set.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/spawn.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/spectators.lua")
-dofile(CORE_DIRECTORY .. "/libs/functions/bosslever.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/string.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/tables.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/teleport.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/tile.lua")
 dofile(CORE_DIRECTORY .. "/libs/functions/vocation.lua")
-dofile(CORE_DIRECTORY .. "/libs/functions/set.lua")
-dofile(CORE_DIRECTORY .. "/libs/functions/queue.lua")

data/libs/systems/load.lua

@@ -9,4 +9,5 @@ dofile(CORE_DIRECTORY .. "/libs/systems/hazard.lua")
 dofile(CORE_DIRECTORY .. "/libs/systems/hireling.lua")
 dofile(CORE_DIRECTORY .. "/libs/systems/raids.lua")
 dofile(CORE_DIRECTORY .. "/libs/systems/reward_boss.lua")
+dofile(CORE_DIRECTORY .. "/libs/systems/vip.lua")
 dofile(CORE_DIRECTORY .. "/libs/systems/zones.lua")

data-otservbr-global/lib/others/vip_system.lua → data/libs/systems/vip.lua

@@ -1,16 +1,10 @@
 local config = {
-	activationMessage = "You have received %s VIP days.",
-	activationMessageType = MESSAGE_EVENT_ADVANCE,
-
-	expirationMessage = "Your VIP days ran out.",
-	expirationMessageType = MESSAGE_ADMINISTRATOR,
-
 	outfits = {},
 	mounts = {},
 }
 
 function Player.onRemoveVip(self)
-	self:sendTextMessage(config.expirationMessageType, config.expirationMessage)
+	self:sendTextMessage(MESSAGE_ADMINISTRATOR, "Your VIP status has expired. All VIP benefits have been removed.")
 
 	for _, outfit in ipairs(config.outfits) do
 		self:removeOutfit(outfit)
@@ -21,13 +15,14 @@ function Player.onRemoveVip(self)
 	end
 
 	local playerOutfit = self:getOutfit()
-	if table.contains(config.outfits, self:getOutfit().lookType) then
+	if table.contains(config.outfits, playerOutfit.lookType) then
 		if self:getSex() == PLAYERSEX_FEMALE then
 			playerOutfit.lookType = 136
 		else
 			playerOutfit.lookType = 128
 		end
 		playerOutfit.lookAddons = 0
+
 		self:setOutfit(playerOutfit)
 	end
 
@@ -36,7 +31,7 @@ end
 
 function Player.onAddVip(self, days, silent)
 	if not silent then
-		self:sendTextMessage(config.activationMessageType, string.format(config.activationMessage, days))
+		self:sendTextMessage(MESSAGE_EVENT_ADVANCE, string.format("You have been granted %s days of VIP status.", days))
 	end
 
 	for _, outfit in ipairs(config.outfits) do
@@ -52,16 +47,15 @@ end
 
 function CheckPremiumAndPrint(player, msgType)
 	if player:getVipDays() == 0xFFFF then
-		player:sendTextMessage(msgType, "You have infinite amount of VIP days left.")
+		player:sendTextMessage(msgType, "You have an unlimited VIP status.")
 		return true
 	end
 
 	local playerVipTime = player:getVipTime()
 	if playerVipTime < os.time() then
-		local msg = "You do not have VIP on your account."
-		player:sendTextMessage(msgType, msg)
+		player:sendTextMessage(msgType, "Your VIP status is currently inactive.")
 		return true
 	end
 
-	player:sendTextMessage(msgType, string.format("You have %s of VIP time left.", getFormattedTimeRemaining(playerVipTime)))
+	player:sendTextMessage(msgType, string.format("You have %s of VIP time remaining.", getFormattedTimeRemaining(playerVipTime)))
 end

data-otservbr-global/scripts/actions/other/hirelinglamp.lua → data/scripts/actions/items/hireling_lamp.lua

@@ -2,8 +2,9 @@ local hirelingLamp = Action()
 
 function hirelingLamp.onUse(player, item, fromPosition, target, toPosition, isHotkey)
 	local spawnPosition = player:getPosition()
-	local hireling_id = item:getCustomAttribute("Hireling")
+	local hirelingId = item:getCustomAttribute("Hireling")
 	local house = spawnPosition and spawnPosition:getTile() and spawnPosition:getTile():getHouse() or nil
+
 	if not house then
 		player:getPosition():sendMagicEffect(CONST_ME_POFF)
 		player:sendTextMessage(MESSAGE_FAILURE, "You may use this only inside a house.")
@@ -22,10 +23,10 @@ function hirelingLamp.onUse(player, item, fromPosition, target, toPosition, isHo
 		return false
 	end
 
-	local hireling = getHirelingById(hireling_id)
+	local hireling = getHirelingById(hirelingId)
 	if not hireling then
 		player:sendTextMessage(MESSAGE_EVENT_ADVANCE, "There was an error creating the hireling and it has been deleted, please, contact server admin.")
-		logger.warn("[hirelingLamp.onUse] Player {} is using hireling with id {} not exist in the database", player:getName(), hireling_id)
+		logger.warn("[hirelingLamp.onUse] Player {} is using hireling with id {} not exist in the database", player:getName(), hirelingId)
 		logger.error("Deleted the lamp")
 		item:remove(1)
 		return true

data/scripts/actions/objects/large_seashell.lua

@@ -0,0 +1,30 @@
+local largeSeashell = Action()
+
+function largeSeashell.onUse(player, item, fromPosition, target, toPosition, isHotkey)
+	if player:hasExhaustion("delay-large-seashell") then
+		player:say("You have already opened a shell today.", TALKTYPE_MONSTER_SAY, false, player, item:getPosition())
+		return true
+	end
+
+	local chance = math.random(100)
+	local message = "Nothing is inside."
+
+	if chance <= 16 then
+		doTargetCombatHealth(0, player, COMBAT_PHYSICALDAMAGE, -200, -200, CONST_ME_NONE)
+		message = "Ouch! You squeezed your fingers."
+	elseif chance > 16 and chance <= 64 then
+		Game.createItem(math.random(281, 282), 1, player:getPosition())
+		message = "You found a beautiful pearl."
+		player:addAchievementProgress("Shell Seeker", 100)
+	end
+
+	player:setExhaustion("delay-large-seashell", 20 * 60 * 60)
+	player:say(message, TALKTYPE_MONSTER_SAY, false, player, item:getPosition())
+	item:transform(198)
+	item:decay()
+	item:getPosition():sendMagicEffect(CONST_ME_BUBBLES)
+	return true
+end
+
+largeSeashell:id(197)
+largeSeashell:register()

data-otservbr-global/scripts/globalevents/others/bosslever_death.lua → data/scripts/creaturescripts/monster/boss_lever_death.lua

@@ -1,22 +1,28 @@
 local onBossDeath = CreatureEvent("BossLeverOnDeath")
+
 function onBossDeath.onDeath(creature)
 	if not creature then
 		return true
 	end
+
 	local name = creature:getName()
 	local key = "boss." .. toKey(name)
 	local zone = Zone(key)
+
 	if not zone then
 		return true
 	end
+
 	local bossLever = BossLever[name]
 	if not bossLever then
 		return true
 	end
+
 	if bossLever.timeoutEvent then
 		stopEvent(bossLever.timeoutEvent)
 		bossLever.timeoutEvent = nil
 	end
+
 	if bossLever.timeAfterKill > 0 then
 		zone:sendTextMessage(MESSAGE_EVENT_ADVANCE, "The " .. name .. " has been defeated. You have " .. bossLever.timeAfterKill .. " seconds to leave the room.")
 		bossLever.timeoutEvent = addEvent(function(zn)
@@ -26,4 +32,5 @@ function onBossDeath.onDeath(creature)
 	end
 	return true
 end
+
 onBossDeath:register()

data-otservbr-global/scripts/creaturescripts/others/adventure_blessing_login.lua → data/scripts/creaturescripts/player/adventure_blessing_login.lua

@@ -1,6 +1,7 @@
 dofile(CORE_DIRECTORY .. "/modules/scripts/blessings/blessings.lua")
 
 local adventurerBlessingLogin = CreatureEvent("AdventurerBlessingLogin")
+
 function adventurerBlessingLogin.onLogin(player)
 	return Blessings.doAdventurerBlessing(player)
 end