refactor: migrate outfits and mounts to Lua

config.lua.dist

@@ -89,7 +89,6 @@ mysqlSock = ""
 -- intervals regardless of other actions such as item (potion) use. This setting
 -- may cause high CPU usage with many players and potentially affect performance!
 -- checkDuplicateStorageKeys checks the values stored in the variables for duplicates.
-allowChangeOutfit = true
 freePremium = false
 maxMessageBuffer = 4
 emoteSpells = false

data/cpplinter.lua

@@ -63,12 +63,13 @@ configManager = {}
 ---@field getBestiary fun(): table
 ---@field getCurrencyItems fun(): table
 ---@field getItemTypeByClientId fun(clientId: number): ItemType
----@field getMountIdByLookType fun(lookType: number): number
 ---@field getParties fun(): table
 ---@field getTowns fun(): table
 ---@field getHouses fun(): table
 ---@field getOutfits fun(sex: number): table
+---@field getOutfitByLookType fun(lookType: number): Outfit_t
 ---@field getMounts fun(): table
+---@field getMountByLookType fun(lookType: number): table
 ---@field getVocations fun(): table
 ---@field getGameState fun(): string
 ---@field setGameState fun(state: string): boolean
@@ -422,12 +423,23 @@ Creature = {}
 ---@field removeOutfitAddon fun(self: Player, outfitId: number, addonId: number)
 ---@field hasOutfit fun(self: Player, outfitId: number, addon?: number): boolean
 ---@field canWearOutfit fun(self: Player, outfitId: number, addonId?: number): boolean
+---@field getCurrentOutfit fun(self: Player): Outfit
+---@field setCurrentOutfit fun(self: Player, outfit: Outfit)
+---@field getDefaultOutfit fun(self: Player): Outfit
+---@field setDefaultOutfit fun(self: Player, outfit: Outfit)
 ---@field sendOutfitWindow fun(self: Player)
----@field sendEditPodium fun(self: Player, item: Item)
+---@field getRandomizeMount fun(self: Player): boolean
+---@field setRandomizeMount fun(self: Player, randomize: boolean)
+---@field getLastMountToggle fun(self: Player): number
+---@field setLastMountToggle fun(self: Player, timestamp: number)
+---@field getCurrentMount fun(self: Player): number
+---@field mount fun(self: Player, mountId: number)
+---@field dismount fun(self: Player)
+---@field sendPodiumWindow fun(self: Player, item: Item)
 ---@field addMount fun(self: Player, mountId: number)
 ---@field removeMount fun(self: Player, mountId: number)
 ---@field hasMount fun(self: Player, mountId: number): boolean
----@field toggleMount fun(self: Player, active: boolean)
+---@field toggleMount fun(self: Player, active: boolean): boolean
 ---@field getPremiumEndsAt fun(self: Player): number
 ---@field setPremiumEndsAt fun(self: Player, timestamp: number)
 ---@field hasBlessing fun(self: Player, blessingId: number): boolean
@@ -1855,14 +1867,13 @@ RELOAD_TYPE_GLOBAL = 5
 RELOAD_TYPE_GLOBALEVENTS = 6
 RELOAD_TYPE_ITEMS = 7
 RELOAD_TYPE_MONSTERS = 8
-RELOAD_TYPE_MOUNTS = 9
-RELOAD_TYPE_MOVEMENTS = 10
-RELOAD_TYPE_NPCS = 11
-RELOAD_TYPE_QUESTS = 12
-RELOAD_TYPE_SCRIPTS = 13
-RELOAD_TYPE_SPELLS = 14
-RELOAD_TYPE_TALKACTIONS = 15
-RELOAD_TYPE_WEAPONS = 16
+RELOAD_TYPE_MOVEMENTS = 9
+RELOAD_TYPE_NPCS = 10
+RELOAD_TYPE_QUESTS = 11
+RELOAD_TYPE_SCRIPTS = 12
+RELOAD_TYPE_SPELLS = 13
+RELOAD_TYPE_TALKACTIONS = 14
+RELOAD_TYPE_WEAPONS = 15
 
 PlayerFlag_CannotUseCombat = 1 * 2 ^ 0
 PlayerFlag_CannotAttackPlayer = 1 * 2 ^ 1
@@ -2039,44 +2050,43 @@ SKILL_LAST = SKILL_FISHING
 ---@type table<string, any>
 configKeys = {
 	-- ConfigKeysBoolean
-	ALLOW_CHANGEOUTFIT = 0,
-	ONE_PLAYER_ON_ACCOUNT = 1,
-	AIMBOT_HOTKEY_ENABLED = 2,
-	REMOVE_RUNE_CHARGES = 3,
-	REMOVE_WEAPON_AMMO = 4,
-	REMOVE_WEAPON_CHARGES = 5,
-	REMOVE_POTION_CHARGES = 6,
-	EXPERIENCE_FROM_PLAYERS = 7,
-	FREE_PREMIUM = 8,
-	REPLACE_KICK_ON_LOGIN = 9,
-	ALLOW_CLONES = 10,
-	ALLOW_WALKTHROUGH = 11,
-	BIND_ONLY_GLOBAL_ADDRESS = 12,
-	OPTIMIZE_DATABASE = 13,
-	MARKET_PREMIUM = 14,
-	EMOTE_SPELLS = 15,
-	STAMINA_SYSTEM = 16,
-	WARN_UNSAFE_SCRIPTS = 17,
-	CONVERT_UNSAFE_SCRIPTS = 18,
-	CLASSIC_EQUIPMENT_SLOTS = 19,
-	CLASSIC_ATTACK_SPEED = 20,
-	SCRIPTS_CONSOLE_LOGS = 21,
-	SERVER_SAVE_NOTIFY_MESSAGE = 22,
-	SERVER_SAVE_CLEAN_MAP = 23,
-	SERVER_SAVE_CLOSE = 24,
-	SERVER_SAVE_SHUTDOWN = 25,
-	ONLINE_OFFLINE_CHARLIST = 26,
-	YELL_ALLOW_PREMIUM = 27,
-	PREMIUM_TO_SEND_PRIVATE = 28,
-	HOUSE_OWNED_BY_ACCOUNT = 29,
-	CLEAN_PROTECTION_ZONES = 30,
-	HOUSE_DOOR_SHOW_PRICE = 31,
-	ONLY_INVITED_CAN_MOVE_HOUSE_ITEMS = 32,
-	REMOVE_ON_DESPAWN = 33,
-	TWO_FACTOR_AUTH = 34,
-	MANASHIELD_BREAKABLE = 35,
-	CHECK_DUPLICATE_STORAGE_KEYS = 36,
-	MONSTER_OVERSPAWN = 37,
+	ONE_PLAYER_ON_ACCOUNT = 0,
+	AIMBOT_HOTKEY_ENABLED = 1,
+	REMOVE_RUNE_CHARGES = 2,
+	REMOVE_WEAPON_AMMO = 3,
+	REMOVE_WEAPON_CHARGES = 4,
+	REMOVE_POTION_CHARGES = 5,
+	EXPERIENCE_FROM_PLAYERS = 6,
+	FREE_PREMIUM = 7,
+	REPLACE_KICK_ON_LOGIN = 8,
+	ALLOW_CLONES = 9,
+	ALLOW_WALKTHROUGH = 10,
+	BIND_ONLY_GLOBAL_ADDRESS = 11,
+	OPTIMIZE_DATABASE = 12,
+	MARKET_PREMIUM = 13,
+	EMOTE_SPELLS = 14,
+	STAMINA_SYSTEM = 15,
+	WARN_UNSAFE_SCRIPTS = 16,
+	CONVERT_UNSAFE_SCRIPTS = 17,
+	CLASSIC_EQUIPMENT_SLOTS = 18,
+	CLASSIC_ATTACK_SPEED = 19,
+	SCRIPTS_CONSOLE_LOGS = 20,
+	SERVER_SAVE_NOTIFY_MESSAGE = 21,
+	SERVER_SAVE_CLEAN_MAP = 22,
+	SERVER_SAVE_CLOSE = 23,
+	SERVER_SAVE_SHUTDOWN = 24,
+	ONLINE_OFFLINE_CHARLIST = 25,
+	YELL_ALLOW_PREMIUM = 26,
+	PREMIUM_TO_SEND_PRIVATE = 27,
+	HOUSE_OWNED_BY_ACCOUNT = 28,
+	CLEAN_PROTECTION_ZONES = 29,
+	HOUSE_DOOR_SHOW_PRICE = 30,
+	ONLY_INVITED_CAN_MOVE_HOUSE_ITEMS = 31,
+	REMOVE_ON_DESPAWN = 32,
+	TWO_FACTOR_AUTH = 33,
+	MANASHIELD_BREAKABLE = 34,
+	CHECK_DUPLICATE_STORAGE_KEYS = 35,
+	MONSTER_OVERSPAWN = 36,
 
 	-- ConfigKeysString
 	MAP_NAME = 0,

data/lib/compat/compat.lua

@@ -1518,17 +1518,6 @@ do
 	end
 end
 
-do
-	local mounts = {}
-	for _, mountData in pairs(Game.getMounts()) do
-		mounts[mountData.clientId] = mountData.name
-	end
-
-	function getMountNameByLookType(lookType)
-		return mounts[lookType]
-	end
-end
-
 function indexToCombatType(idx)
 	return 1 << idx
 end

data/lib/core/network_message.lua

@@ -9,3 +9,21 @@ end
 function NetworkMessage:addBool(value)
 	self:addByte(value and 1 or 0)
 end
+
+function NetworkMessage:addItemId(itemId)
+	local it = ItemType(itemId)
+	self:addU16(it:getClientId())
+end
+
+function NetworkMessage:addOutfit(outfit)
+	self:addU16(outfit.lookType)
+	if outfit.lookType ~= 0 then
+		self:addByte(outfit.lookHead)
+		self:addByte(outfit.lookBody)
+		self:addByte(outfit.lookLegs)
+		self:addByte(outfit.lookFeet)
+		self:addByte(outfit.lookAddons)
+	else
+		self:addItemId(outfit.lookTypeEx)
+	end
+end

data/lib/core/player.lua

@@ -337,22 +337,6 @@ function Player.getTotalMoney(self)
 	return self:getMoney() + self:getBankBalance()
 end
 
-function Player.addAddonToAllOutfits(self, addon)
-	for sex = 0, 1 do
-		local outfits = Game.getOutfits(sex)
-		for outfit = 1, #outfits do
-			self:addOutfitAddon(outfits[outfit].lookType, addon)
-		end
-	end
-end
-
-function Player.addAllMounts(self)
-	local mounts = Game.getMounts()
-	for mount = 1, #mounts do
-		self:addMount(mounts[mount].id)
-	end
-end
-
 function Player.setSpecialContainersAvailable(self, available)
 	local msg = NetworkMessage()
 	msg:addByte(0x2A)

data/lib/core/storages.lua

@@ -2,7 +2,6 @@
 Reserved player storage ranges:
 - 300000 to 301000+ reserved for achievements
 - 20000 to 21000+ reserved for achievement progress
-- 10000000 to 20000000 reserved for outfits and mounts on source
 ]]--
 
 AccountStorageKeys = {
@@ -49,4 +48,10 @@ PlayerStorageKeys = {
 	-- Bestiary:
 	bestiaryKillsBase = 400000,
 	bestiaryTrackerBase = 500000,
+
+	-- Outfits and mounts:
+	currentMount = 60000,
+	randomizeMount = 60001,
+	outfitsBase = 600000,
+	mountsBase = 610000,
 }

data/migrations/37.lua

@@ -1,3 +1,89 @@
+-- must match PlayerStorageKeys in storages.lua, change accordingly if modified
+local CURRENT_MOUNT = 60000
+local RANDOMIZE_MOUNT = 60001
+local OUTFITS_BASE = 600000
+local MOUNTS_BASE = 610000
+
 function onUpdateDatabase()
-	return false
+    print("> Updating database to version 38 (revert outfits/mounts to storages)")
+
+    local tx = DBTransaction()
+    if not tx.begin() then
+        return false
+    end
+
+    local query = DBInsert("INSERT INTO `player_storage` (`player_id`, `key`, `value`) VALUES ")
+
+    do
+        local resultId = db.storeQuery("SELECT `player_id`, `outfit_id`, `addons` FROM `player_outfits`")
+        if resultId then
+            repeat
+                local playerId = result.getNumber(resultId, "player_id")
+                local outfitId = result.getNumber(resultId, "outfit_id")
+                local addons = result.getNumber(resultId, "addons")
+
+                local storageKey = OUTFITS_BASE + outfitId
+                query:addRow(string.format("%d, %d, %d", playerId, storageKey, addons))
+            until not result.next(resultId)
+            result.free(resultId)
+        end
+    end
+
+    do
+        local resultId = db.storeQuery("SELECT `player_id`, `mount_id` FROM `player_mounts`")
+        if resultId then
+            repeat
+                local playerId = result.getNumber(resultId, "player_id")
+                local mountId = result.getNumber(resultId, "mount_id")
+
+                local storageKey = MOUNTS_BASE + mountId
+                query:addRow(string.format("%d, %d, %d", playerId, storageKey, 1))
+            until not result.next(resultId)
+            result.free(resultId)
+        end
+    end
+
+    -- Migrate currentmount and randomizemount from players table
+    do
+        local resultId = db.storeQuery(
+            "SELECT `id`, `currentmount`, `randomizemount` FROM `players` WHERE `currentmount` > 0 OR `randomizemount` > 0")
+        if resultId then
+            repeat
+                local playerId = result.getNumber(resultId, "id")
+                local currentMount = result.getNumber(resultId, "currentmount")
+                local randomizeMount = result.getNumber(resultId, "randomizemount")
+
+                if currentMount > 0 then
+                    query:addRow(string.format("%d, %d, %d", playerId, CURRENT_MOUNT, currentMount))
+                end
+
+                if randomizeMount > 0 then
+                    query:addRow(string.format("%d, %d, %d", playerId, RANDOMIZE_MOUNT, randomizeMount))
+                end
+            until not result.next(resultId)
+            result.free(resultId)
+        end
+    end
+
+    if not query:execute() then
+        tx.rollback()
+        return false
+    end
+
+    if not db.query("DROP TABLE IF EXISTS `player_outfits`") then
+        tx.rollback()
+        return false
+    end
+
+    if not db.query("DROP TABLE IF EXISTS `player_mounts`") then
+        tx.rollback()
+        return false
+    end
+
+    if not db.query("ALTER TABLE `players` DROP COLUMN `currentmount`, DROP COLUMN `randomizemount`") then
+        tx.rollback()
+        return false
+    end
+
+    return tx.commit()
 end

data/migrations/38.lua

@@ -0,0 +1,3 @@
+function onUpdateDatabase()
+	return false
+end

data/scripts/events/player.lua

@@ -100,7 +100,7 @@ function Player:onPodiumRequest(item)
 		return
 	end
 
-	self:sendEditPodium(item)
+	self:sendPodiumWindow(item)
 end
 
 function Player:onPodiumEdit(item, outfit, direction, isVisible)
@@ -122,8 +122,8 @@ function Player:onPodiumEdit(item, outfit, direction, isVisible)
 		end
 
 		-- reset mount if unable to ride
-		local mount = Game.getMountIdByLookType(outfit.lookMount)
-		if not (mount and self:hasMount(mount)) then
+		local mount = Game.getMountByLookType(outfit.lookMount)
+		if not mount or not self:hasMount(mount.lookType) then
 			outfit.lookMount = 0
 		end
 	end