feature: boosted creature / reading staticdata from assets / bestiary races rework (#1064)

Author: Zbizu

init.lua

@@ -8,19 +8,20 @@ Services = {
     --websites = "http://localhost/?subtopic=accountmanagement", --./client_entergame "Forgot password and/or email"
 }
 
---[[ Servers_init = {
-    ["http://ip/login.php"] = {
+--[[
+Servers_init = {
+    ["http://127.0.0.1/login.php"] = {
         ["port"] = 80,
-        ["protocol"] = 1332,
+        ["protocol"] = 1320,
         ["httpLogin"] = true
     },
     ["ip.net"] = {
         ["port"] = 7171,
         ["protocol"] = 860,
         ["httpLogin"] = false
     },
-
-} ]]
+}
+]]
 
 g_app.setName("OTClient - Redemption");
 g_app.setCompactName("otclient");

meta.lua

@@ -153,6 +153,14 @@ g_things = {}
 ---@return boolean
 function g_things.loadAppearances(file) end
 
+---@param file string
+---@return boolean
+function g_things.loadStaticData(file) end
+
+---@param file string
+---@return boolean
+function g_things.loadSounds(file) end
+
 ---@param file string
 ---@return boolean
 function g_things.loadDat(file) end
@@ -184,6 +192,14 @@ function g_things.getThingTypes(category) end
 ---@return ThingType[]
 function g_things.findThingTypeByAttr(attr, category) end
 
+---@param raceId integer
+---@return RaceType[]
+function g_things.getRaceData(raceId) end
+
+---@param searchString string
+---@return Vector<RaceType>
+function g_things.getRacesByName(searchString) end
+
 ---* FRAMEWORK_EDITOR
 ---@param id integer
 ---@return ThingType | nil

modules/client_bottommenu/bottommenu.lua

@@ -15,13 +15,23 @@ local eventSchedulerCalendarYearIndex
 local eventSchedulerCalendarMonth
 
 local boostedWindow
-local creature_boosted
-local boss_boosted
+local monsterOutfit
+local monsterImage
+local bossOutfit
+local bossImage
 
 local default_info = {
-    [1] = {image = "images/randomhint", Title = "Random Hint", creature1="images/boost_monster1",creature2= "images/boost_monster2",description = "The customisable status bar includes big health and mana bars and can be placed on the bottom, the top or on the side of your game windows\n\n -\t\t https://github.com/mehah/otclient/wiki "},
-  --  [2] = {image = "image of label", Title = "title", creature1="images of creature",creature2= "images of boos",description = "text in label see tutorial :  https://github.com/mehah/otclient/wiki"},
+    -- hint 1
+    {
+        image = "images/randomhint",
+        Title = "Enabling Boosted Creature Panel",
+        description = "Boosted creatures panel requires configuring a webservice (init.lua) and preloading a client version by either setting one server in Servers_init (init.lua) or by altering entergame.lua.\n\nFor more hints, visit:\t\t https://github.com/mehah/otclient/wiki"
+    },
+
+    -- hint 2
+    -- {image = "image of label", Title = "title", description = "your hint here"},
 }
+
 function init()
     g_ui.importStyle('calendar')
     bottomMenu = g_ui.displayUI('bottommenu')
@@ -42,12 +52,13 @@ function init()
     eventSchedulerCalendarMonth = tonumber(os.date("%m"))
 
     boostedWindow = bottomMenu:recursiveGetChildById('boostedWindow')
-    creature_boosted = boostedWindow:recursiveGetChildById('creature')
-    boss_boosted = boostedWindow:recursiveGetChildById('boss')
+    monsterOutfit = boostedWindow:recursiveGetChildById('creature')
+    bossOutfit = boostedWindow:recursiveGetChildById('boss')
 
 --  if not Services.status and default_info then
     if default_info then
-        local widget = g_ui.createWidget('ShowOffWidget', showOffWindow)
+        local scrollable = showOffWindow:recursiveGetChildById('contentsPanel')
+        local widget = g_ui.createWidget('ShowOffWidget', scrollable)
         local description = widget:recursiveGetChildById('description')
         local image = widget:recursiveGetChildById('image')
 
@@ -57,16 +68,17 @@ function init()
         showOffWindow.title:setText(tr(randomItem.Title))
         image:setImageSource(randomItem.image)
         description:setText(tr(randomItem.description))
-        creature_boosted:setVisible(false)
-        boss_boosted:setVisible(false)
+        monsterOutfit:setVisible(false)
+        bossOutfit:setVisible(false)
+        widget:resize(widget:getWidth(), description:getHeight())
 
-        local creature2 = boostedWindow:recursiveGetChildById('creature2')
-        local boss2 = boostedWindow:recursiveGetChildById('boss2')
+        monsterImage = boostedWindow:recursiveGetChildById('monsterImage')
+        bossImage = boostedWindow:recursiveGetChildById('bossImage')
 
-        creature2:setImageSource(randomItem.creature1)    
-        creature2:setVisible(true) 
-        boss2:setImageSource(randomItem.creature2)
-        boss2:setVisible(true)
+        monsterImage:setImageSource("images/icon-questionmark")
+        monsterImage:setVisible(true)
+        bossImage:setImageSource("images/icon-questionmark")
+        bossImage:setVisible(true)
     end
     if g_game.isOnline() then
         hide()
@@ -496,17 +508,45 @@ function onClickOnNextCalendar()
     reloadEventsSchedulerCurrentPage()
 end
 
-function Booster_creature(data)
-    if modules.game_things.isLoaded() then
-        local creatureraceid = modules.game_cyclopedia.RACE[data.creatureraceid]
-        local bossraceid = modules.game_cyclopedia.RACE_Bosstiary[data.bossraceid]
-        if creatureraceid then
-            creature_boosted:setOutfit({type=creatureraceid.type})
-            creature_boosted:getCreature():setStaticWalking(1000)
-        end
-        if bossraceid then
-            boss_boosted:setOutfit({type=bossraceid.type})
-            boss_boosted:getCreature():setStaticWalking(1000)
-        end
+-- (internal)
+-- set creature/boss to boosted slot
+local function applyToBoostedSlot(raceId, outfitWidget, imageWidget, fileName)
+    -- check if raceId was provided in the JSON response
+    if not raceId then
+        return
+    end
+
+    -- fetch race data
+    local raceData = g_things.getRaceData(raceId)
+
+    -- check if race id is present in the staticdata
+    if raceData.raceId == 0 then
+        local msg = string.format("[%s] Creature with race id %s was not found.", fileName, data.creatureraceid)
+        g_logger.warning(msg)
+        return
     end
+
+    -- apply to selected widget
+    outfitWidget:setOutfit(raceData.outfit)
+    outfitWidget:getCreature():setStaticWalking(1000)
+    outfitWidget:setVisible(true)
+    imageWidget:setVisible(false)
+end
+
+function setBoostedCreatureAndBoss(data)
+    if not modules.game_things.isLoaded() then
+        return
+    end
+
+    -- file name for error reporting
+    local fileName = debug.getinfo(1, "S").source -- current file name - bottommenu.lua
+
+    -- boosted creature
+    -- before bosstiary was introduced, the webservice was sending creature race in 'raceid' field
+    -- after bosstiary was added, it was changed to 'creatureraceid'
+    -- this 'or' statement ensures backwards compatibility
+    applyToBoostedSlot(data.creatureraceid or data.raceid, monsterOutfit, monsterImage, fileName)
+
+    -- boosted boss
+    applyToBoostedSlot(data.bossraceid, bossOutfit, bossImage, fileName)
 end

modules/client_bottommenu/bottommenu.otui

@@ -1,26 +1,28 @@
 ShowOffWidget < UIWidget
-  anchors.fill: parent
+  size: 1020 1000
+  anchors.left: parent.left
+  anchors.top: parent.top
 
   Label
     id: image
     size: 64 64
     anchors.left: parent.left
     anchors.top: parent.top
-    margin-top: 28
     margin-left: 10
     image-auto-resize: true
 
-  Label
+  UITextEdit
     id: description
+    size: 476 0
     anchors.left: image.right
-    anchors.right: parent.right
+    anchors.top: parent.top
     anchors.bottom: parent.bottom
-    anchors.top: image.top
-    margin-top: 10
+    margin-top: 2
     margin-left: 10
-    margin-right: 40
     color: #c0c0c0ff
     text-wrap: true
+    text-auto-resize: true
+    selectable: true
 
 Panel
   id: bottomMenu
@@ -52,7 +54,7 @@ Panel
 
     Label
       id: showOffWindowText
-      !text: tr('Random Hit')
+      !text: tr('Random Hint')
       font: verdana-11px-antialised
       text-offset: 0 2
       text-align: top
@@ -153,6 +155,7 @@ Panel
 
       Creature
         id: creature
+        size: 64 64
         anchors.horizontalCenter: parent.horizontalCenter
         anchors.verticalCenter: parent.verticalCenter
         image-source: ""
@@ -161,7 +164,7 @@ Panel
         border-color: alpha
 
       UIWidget
-        id: creature2
+        id: monsterImage
         anchors.horizontalCenter: parent.horizontalCenter
         anchors.verticalCenter: parent.verticalCenter
         visible: false
@@ -181,6 +184,7 @@ Panel
 
       Creature
         id: boss
+        size: 64 64
         anchors.horizontalCenter: parent.horizontalCenter
         anchors.verticalCenter: parent.verticalCenter
         image-source: ""
@@ -189,7 +193,7 @@ Panel
         border-color: alpha
 
       UIWidget
-        id: boss2
+        id: bossImage
         anchors.horizontalCenter: parent.horizontalCenter
         anchors.verticalCenter: parent.verticalCenter
         visible: false