feat: Latency-adaptive camera (Beta)

meta.lua

@@ -2713,7 +2713,7 @@ function Tile:isFullyOpaque() end
 function Tile:isLookPossible() end
 
 ---@return boolean
-function Tile:hasCreature() end
+function Tile:hasCreatures() end
 
 ---@return boolean
 function Tile:isEmpty() end

modules/game_features/features.lua

@@ -9,6 +9,7 @@ controller:registerEvents(g_game, {
 
         g_game.enableFeature(GameAllowPreWalk)
         g_game.enableFeature(GameFormatCreatureName)
+        g_game.enableFeature(GameLatencyAdaptiveCamera)
 
         if version >= 750 then
             g_game.enableFeature(GameSoul)

modules/game_walk/walk.lua

@@ -2,8 +2,31 @@ local smartWalkDirs = {}
 local smartWalkDir = nil
 local walkEvent = nil
 local lastTurn = 0
-local lastCancelWalkTime = 0
 local nextWalkDir = nil
+local lastCancelWalkTime = 0
+
+
+local keys = {
+    { "Up",      North },
+    { "Right",   East },
+    { "Down",    South },
+    { "Left",    West },
+    { "Numpad8", North },
+    { "Numpad9", NorthEast },
+    { "Numpad6", East },
+    { "Numpad3", SouthEast },
+    { "Numpad2", South },
+    { "Numpad1", SouthWest },
+    { "Numpad4", West },
+    { "Numpad7", NorthWest },
+}
+
+local turnKeys = {
+    { "Ctrl+Up",    North },
+    { "Ctrl+Right", East },
+    { "Ctrl+Down",  South },
+    { "Ctrl+Left",  West },
+}
 
 WalkController = Controller:new()
 
@@ -37,23 +60,32 @@ end
 --- Makes the player walk in the given direction.
 local function walk(dir)
     local player = g_game.getLocalPlayer()
-    if not player or g_game.isDead() or player:isDead() or player:isWalkLocked() then
-        cancelWalkEvent()
+    if not player or g_game.isDead() or player:isDead() then
         return
     end
 
-    if not player:canWalk(dir) then
-        nextWalkDir = dir
+    if player:isWalkLocked() then
+        nextWalkDir = nil
         return
     end
 
     if g_game.isFollowing() then
         g_game.cancelFollow()
     end
 
-    if player:isAutoWalking() then
-        player:stopAutoWalk()
+    local isAutoWalking = player:isAutoWalking()
+    if isAutoWalking or player:isServerWalking() then
         g_game.stop()
+        if isAutoWalking then
+            player:stopAutoWalk()
+        end
+        player:lockWalk(player:getStepDuration() + 50)
+        return
+    end
+
+    if not player:canWalk() then
+        nextWalkDir = dir
+        return
     end
 
     nextWalkDir = nil
@@ -75,20 +107,16 @@ local function walk(dir)
 end
 
 --- Adds a walk event with an optional delay.
-local function addWalkEvent(dir, delay)
-    if os.time() - lastCancelWalkTime > 10 then
+local function addWalkEvent(dir)
+    if os.time() - lastCancelWalkTime > 20 then
         cancelWalkEvent()
         lastCancelWalkTime = os.time()
     end
-
-    local function walkCallback()
-        if g_keyboard.getModifiers() ~= KeyboardNoModifier then
-            return
+    walkEvent = addEvent(function()
+        if g_keyboard.getModifiers() == KeyboardNoModifier then
+            walk(smartWalkDir or dir)
         end
-        walk(smartWalkDir or dir)
-    end
-
-    walkEvent = delay == 0 and addEvent(walkCallback) or scheduleEvent(walkCallback, delay or 5)
+    end)
 end
 
 --- Initiates a smart walk in the given direction.
@@ -138,8 +166,8 @@ local function turn(dir, repeated)
 
     cancelWalkEvent()
 
-    local TURN_DELAY_REPEATED = 1000
-    local TURN_DELAY_DEFAULT = 200
+    local TURN_DELAY_REPEATED = 150
+    local TURN_DELAY_DEFAULT = 50
 
     local delay = repeated and TURN_DELAY_REPEATED or TURN_DELAY_DEFAULT
 
@@ -155,35 +183,13 @@ end
 local function bindKeys()
     modules.game_interface.getRootPanel():setAutoRepeatDelay(200)
 
-    local keys = {
-        { "Up",      North },
-        { "Right",   East },
-        { "Down",    South },
-        { "Left",    West },
-        { "Numpad8", North },
-        { "Numpad9", NorthEast },
-        { "Numpad6", East },
-        { "Numpad3", SouthEast },
-        { "Numpad2", South },
-        { "Numpad1", SouthWest },
-        { "Numpad4", West },
-        { "Numpad7", NorthWest },
-    }
-
-    for _, keyDir in ipairs(keys) do
-        bindWalkKey(keyDir[1], keyDir[2])
-    end
-
-    local turnKeys = {
-        { "Ctrl+Up",    North },
-        { "Ctrl+Right", East },
-        { "Ctrl+Down",  South },
-        { "Ctrl+Left",  West },
-    }
+    for _, keyDir in ipairs(keys) do bindWalkKey(keyDir[1], keyDir[2]) end
+    for _, keyDir in ipairs(turnKeys) do bindTurnKey(keyDir[1], keyDir[2]) end
+end
 
-    for _, keyDir in ipairs(turnKeys) do
-        bindTurnKey(keyDir[1], keyDir[2])
-    end
+local function unbindKeys()
+    for _, keyDir in ipairs(keys) do unbindWalkKey(keyDir[1]) end
+    for _, keyDir in ipairs(turnKeys) do unbindTurnKey(keyDir[1]) end
 end
 
 --- Handles player teleportation events.
@@ -192,10 +198,12 @@ local function onTeleport(player, newPos, oldPos)
         return
     end
 
-    local offsetX, offsetY, offsetZ = Position.offsetX(newPos, oldPos), Position.offsetY(newPos, oldPos),
-        Position.offsetZ(newPos, oldPos)
+    local offsetX, offsetY, offsetZ =
+        Position.offsetX(newPos, oldPos), Position.offsetY(newPos, oldPos), Position.offsetZ(newPos, oldPos)
+
     local TELEPORT_DELAY = g_settings.getNumber("walkTeleportDelay")
     local STAIRS_DELAY = g_settings.getNumber("walkStairsDelay")
+
     local delay = (offsetX >= 3 or offsetY >= 3 or offsetZ >= 2) and TELEPORT_DELAY or STAIRS_DELAY
     player:lockWalk(delay)
 end
@@ -211,6 +219,9 @@ local function onWalkFinish(player)
     end
 end
 
+local function onAutoWalk(player)
+end
+
 --- Handles cancellation of a walking event.
 local function onCancelWalk(player)
     player:lockWalk(50)
@@ -221,16 +232,22 @@ function WalkController:onInit()
     bindKeys()
 end
 
+function WalkController:onTerminate()
+    unbindKeys()
+end
+
 --- Sets up game-related events for the WalkController.
 function WalkController:onGameStart()
     self:registerEvents(g_game, {
         onGameStart = onGameStart,
         onTeleport = onTeleport,
+        onAutoWalk = onAutoWalk
     })
 
     self:registerEvents(LocalPlayer, {
         onCancelWalk = onCancelWalk,
         onWalkFinish = onWalkFinish,
+        onAutoWalk = onAutoWalk
     })
 
     modules.game_interface.getRootPanel().onFocusChange = stopSmartWalk

modules/gamelib/const.lua

@@ -216,6 +216,7 @@ GameAllowCustomBotScripts = 120
 GameColorizedLootValue = 121
 GameAllowPreWalk = 122
 GamePlayerFamiliars = 123
+GameLatencyAdaptiveCamera = 124
 
 TextColors = {
     red = '#f55e5e',    -- '#c83200'

src/client/const.h

@@ -552,6 +552,7 @@ namespace Otc
         GameColorizedLootValue = 121,
         GameAllowPreWalk = 122,
         GamePlayerFamiliars = 123,
+        GameLatencyAdaptiveCamera = 124,
         LastGameFeature
     };
 

src/client/creature.cpp

@@ -133,7 +133,7 @@ void Creature::drawInformation(const MapPosInfo& mapRect, const Point& dest, con
         DEFAULT_COLOR(96, 96, 96),
         NPC_COLOR(0x66, 0xcc, 0xff);
 
-    if (isDead() || !canBeSeen() || !(drawFlags & Otc::DrawCreatureInfo) || !mapRect.isInRange(m_position))
+    if (isDead() || !canBeSeen() || !(drawFlags & Otc::DrawCreatureInfo) || !mapRect.isInRange(getPosition()))
         return;
 
     if (g_gameConfig.isDrawingInformationByWidget()) {
@@ -628,7 +628,8 @@ void Creature::updateWalkingTile()
 
     if (newWalkingTile) {
         newWalkingTile->addWalkingCreature(self);
-        g_map.notificateTileUpdate(newWalkingTile->getPosition(), self, Otc::OPERATION_CLEAN);
+        if (isLocalPlayer())
+            g_map.notificateTileUpdate(newWalkingTile->getPosition(), self, Otc::OPERATION_CLEAN);
     }
 
     m_walkingTile = newWalkingTile;
@@ -642,6 +643,7 @@ void Creature::nextWalkUpdate()
 
     // do the update
     updateWalk();
+    onWalking();
 
     if (!m_walking) return;
 
@@ -918,9 +920,11 @@ uint16_t Creature::getStepDuration(const bool ignoreDiagonal, const Otc::Directi
         return 0;
 
     const auto& tilePos = dir == Otc::InvalidDirection ?
-        m_lastStepToPosition : m_position.translatedToDirection(dir);
+        m_lastStepToPosition : getPosition().translatedToDirection(dir);
 
-    const auto& tile = g_map.getTile(tilePos.isValid() ? tilePos : m_position);
+    const auto& tile = g_map.getTile(tilePos.isValid() ? tilePos : getPosition());
+
+    const int serverBeat = g_game.getServerBeat();
 
     int groundSpeed = 0;
     if (tile) groundSpeed = tile->getGroundSpeed();
@@ -937,7 +941,6 @@ uint16_t Creature::getStepDuration(const bool ignoreDiagonal, const Otc::Directi
         } else stepDuration /= m_speed;
 
         if (g_gameConfig.isForcingNewWalkingFormula() || g_game.getClientVersion() >= 860) {
-            const int serverBeat = g_game.getServerBeat();
             stepDuration = ((stepDuration + serverBeat - 1) / serverBeat) * serverBeat;
         }
 
@@ -951,7 +954,17 @@ uint16_t Creature::getStepDuration(const bool ignoreDiagonal, const Otc::Directi
                 : 2);
     }
 
-    return ignoreDiagonal ? m_stepCache.duration : m_stepCache.getDuration(m_lastStepDirection);
+    auto duration = ignoreDiagonal ? m_stepCache.duration : m_stepCache.getDuration(m_lastStepDirection);
+
+    if (isLocalPlayer() && g_game.getFeature(Otc::GameLatencyAdaptiveCamera) && static_self_cast<LocalPlayer>()->isPreWalking()) {
+        if (m_lastMapDuration == -1)
+            m_lastMapDuration = ((g_game.mapUpdatedAt() + 9) / 10) * 10;
+
+        // stabilizes camera transition with server response time to keep movement fluid.
+        duration = std::max<int>(duration, m_lastMapDuration);
+    }
+
+    return duration;
 }
 
 Point Creature::getDisplacement() const

src/client/creature.h

@@ -187,6 +187,7 @@ minHeight,
 
 protected:
     virtual void terminateWalk();
+    virtual void onWalking() {};
     void updateWalkOffset(uint8_t totalPixelsWalked);
     void updateWalk();
 
@@ -202,7 +203,8 @@ minHeight,
     Otc::Direction m_direction{ Otc::South };
 
     Timer m_walkTimer;
-    Position m_lastStepToPosition;
+
+    int16_t m_lastMapDuration = -1;
 
 private:
     void nextWalkUpdate();
@@ -245,6 +247,7 @@ minHeight,
     CachedText m_name;
     CachedStep m_stepCache;
 
+    Position m_lastStepToPosition;
     Position m_lastStepFromPosition;
     Position m_oldPosition;
 

src/client/game.cpp

@@ -55,7 +55,8 @@ void Game::resetGameStates()
     m_serverBeat = 50;
     m_seq = 0;
     m_ping = -1;
-    m_walkTicks = 0;
+    m_mapUpdatedAt = 0;
+    m_mapUpdateTimer = { true, Timer{} };
     setCanReportBugs(false);
     m_fightMode = Otc::FightBalanced;
     m_chaseMode = Otc::DontChase;
@@ -671,12 +672,12 @@ void Game::autoWalk(const std::vector<Otc::Direction>& dirs, const Position& sta
 
     const Otc::Direction direction = *dirs.begin();
     if (const auto& toTile = g_map.getTile(startPos.translatedToDirection(direction))) {
-        if (startPos == m_localPlayer->m_lastPrewalkDestination && toTile->isWalkable() && m_localPlayer->canWalk(direction, true)) {
+        if (m_localPlayer->isPreWalking() && startPos == m_localPlayer->getPosition() && toTile->isWalkable() && !m_localPlayer->isWalking() && m_localPlayer->canWalk(true)) {
             m_localPlayer->preWalk(direction);
         }
     }
 
-    g_lua.callGlobalField("g_game", "onAutoWalk", dirs);
+    g_lua.callGlobalField("g_game", "onAutoWalk", m_localPlayer, dirs);
     m_protocolGame->sendAutoWalk(dirs);
 }
 
@@ -685,8 +686,10 @@ void Game::forceWalk(const Otc::Direction direction)
     if (!canPerformGameAction())
         return;
 
-    m_walkTimer.restart();
-    m_walkTicks = -1;
+    if (m_mapUpdateTimer.first || m_localPlayer->m_preWalks.size() == 1) {
+        m_mapUpdateTimer.second.restart();
+        m_mapUpdateTimer.first = false;
+    }
 
     switch (direction) {
         case Otc::North: