Net improvement cleanup (#249)

* time freeze attachment nodes were 1 frame off. added get_move_direction() and set_move_direction(). fixed 1 letter-off Personal menu area name. un-auto'd my code

* no more pvp ghosts. fixed lava tile. entities cannot get Hit() directly when iframes

* Prevent mods from unsafely manipulating data in other lua states

* Handshake before reading packets in download scene

* Fix possible crash from late type check

* texturetypes.h -> resourcepaths.h. freeze status effect

* Allow components to be made for more entity types

* Add is_counterable for lua

* status queue prioritized drag statuses before other deferred hitbox data. shaking fx is requeued if not in time freeze due to drag or applied earlier otherwise.

* blind status added. tweaked airshoe rule in CanMoveTo(). Optional 'head' point in blind status used otherwise it is calculated from player height

* black player shader bug fixed for now. Forced card preview size limit on chip art. Emotion window UI flicker speed adjusted. Fixed counters not appearing. Removed more auto's.

* audio cache tries to clear now too. frame_time_t stopwatch replacement for swoosh::Timer which uses seconds. ESC key in battle must have app in focus to trigger. Tweaked some problems detecting and displaying combos and counter info text.

* sending correct hand over network in pvp. Skipping input processing on updates that serve to refresh the screen. Frame time objects replace swoosh timers.

* added player guide PDF to source project. Tweaked handling player input's in mob battle scene and network battle scene.

* fixed true breaking code for freeze status. made sure extra damage was subtracted from the entity's health. updated sound font.

* removed lingering code

* Initial logging and changes, timeout 20 seconds instead of 5, plus other misc. Some of these need to be undone later.

* More logging for inputs, fix for inputs not being processed correctly during time freeze.

* Game now defines a Version, used in window title. Version sent in DownloadScene handshake, aborts if version mismatch detected. Remove net logging from InputManager.

* Starting DownloadScene creates new log file in logs directory, Bump version number.

* Claim that netplay battlescene is synced during start. This may
 help sync softlocks on scene start and shouldn't desync because inputs are not being sent yet. Bump version.

* TimeFreezeBattleState now resets the currState in its OnEnd. Some extra logging. Version increase.

* Update .gitignore

* Fix decross desync on next turn start.  More logging around states starting and ending. CustomBarProgress is now reset in CardSelectBattleState::onStart instead of the CombatBattleState.  Version bump.

The desync fixed was one where being decrossed during the turn and then not choosing a form on the following card select would cause the remote player to think you changed forms to the form at -1, which would animate and desync.

SetCustomBarProgress call moved in order to prevent progress from resetting during transitions between combat and transformation state during combat, ,such as through decross. Transformation state should not be added as a subcombat state, so this makes more sense.

* char to int to help ARM64 compile

* Remove some extra logging, add newline at end of some files that were missing one

* Remove excess logging

* Remove Logger::StartNewLog and filesystem import

---------

Co-authored-by: TheMaverickProgrammer <[email protected]>
Co-authored-by: Arthur Cosentino <[email protected]>

Author: 3 people

.gitignore

@@ -388,4 +388,4 @@ _deps
 /log.txt
 
 # ini files
-*.ini 
+*.ini 

BattleNetwork/battlescene/States/bnBattleStartBattleState.cpp

@@ -19,7 +19,8 @@ void BattleStartBattleState::onStart(const BattleSceneState* _)
   GetScene().IncrementTurnCount();
 
   // only reveal first player's UI widget to them
-  auto ui = GetScene().GetLocalPlayer()->GetFirstComponent<PlayerSelectedCardsUI>();
+  std::shared_ptr<Player> localPlayer = GetScene().GetLocalPlayer();
+  std::shared_ptr<PlayerSelectedCardsUI> ui = localPlayer->GetFirstComponent<PlayerSelectedCardsUI>();
 
   if (ui) {
     ui->Reveal();

BattleNetwork/battlescene/States/bnBattleTextIntroState.cpp

@@ -47,12 +47,12 @@ void BattleTextIntroState::onEnd(const BattleSceneState*)
 
 void BattleTextIntroState::onUpdate(double elapsed)
 {
-  timer.update(sf::seconds(static_cast<float>(elapsed)));
+  timer.tick();
 }
 
 void BattleTextIntroState::onDraw(sf::RenderTexture& surface)
 {
-  frame_time_t start = from_milliseconds(timer.getElapsed().asMilliseconds());
+  frame_time_t start = timer.elapsed();
 
   if (start >= startupDelay) {
     double delta = (start - startupDelay).asSeconds().value;
@@ -67,5 +67,5 @@ void BattleTextIntroState::onDraw(sf::RenderTexture& surface)
 }
 
 bool BattleTextIntroState::IsFinished() {
-  return timer.getElapsed().asSeconds() >= (startupDelay + preBattleLength).asSeconds().value;
+  return timer.elapsed() >= startupDelay + preBattleLength;
 }

BattleNetwork/battlescene/States/bnBattleTextIntroState.h

@@ -16,7 +16,7 @@ struct BattleTextIntroState : public BattleSceneState {
   frame_time_t preBattleLength{ frames(60) }; 
   frame_time_t startupDelay{ frames(0) }; /*!< Animation delay*/
   Text battleStart; /*!< e.g. "Battle Start" graphic */
-  swoosh::Timer timer; /*!< How long the start graphic should stay on screen */
+  frame_time_stopwatch_t timer; /*!< How long the start graphic should stay on screen */
   sf::Vector2f battleStartPos; /*!< Position of battle pre/post graphic on screen */
   BattleTextIntroState();
   virtual ~BattleTextIntroState();

BattleNetwork/battlescene/States/bnCardSelectBattleState.cpp

@@ -63,10 +63,14 @@ std::shared_ptr<std::vector<Battle::Card>> CardSelectBattleState::GetCardPtrList
 
 void CardSelectBattleState::onStart(const BattleSceneState*)
 {
-  CardSelectionCust& cardCust = GetScene().GetCardSelectWidget();
+  BattleSceneBase& scene = GetScene();
+  CardSelectionCust& cardCust = scene.GetCardSelectWidget();
 
   Audio().Play(AudioType::CUSTOM_SCREEN_OPEN);
 
+  // Reset bar and related flags
+  scene.SetCustomBarProgress(0.0);
+
   // Load the next cards
   cardCust.ResetState();
   cardCust.GetNextCards();
@@ -79,17 +83,19 @@ void CardSelectBattleState::onStart(const BattleSceneState*)
 
 void CardSelectBattleState::onUpdate(double elapsed)
 {
+  BattleSceneBase& scene = GetScene();
+  Camera& camera = scene.GetCamera();
   CardSelectionCust& cardCust = GetScene().GetCardSelectWidget();
 
   if (!cardCust.IsInView() && currState == state::slidein) {
     cardCust.Move(sf::Vector2f(MODAL_SLIDE_PX_PER_SEC * (float)elapsed, 0));
-    GetScene().GetCamera().MoveCamera(sf::Vector2f(240.f, 134.f), sf::seconds(0.1f));
+    camera.MoveCamera(sf::Vector2f(240.f, 134.f), sf::seconds(0.1f));
     return;
   }
 
   if (!cardCust.IsOutOfView() && currState == state::slideout) {
     cardCust.Move(sf::Vector2f(-MODAL_SLIDE_PX_PER_SEC * (float)elapsed, 0));
-    GetScene().GetCamera().MoveCamera(sf::Vector2f(240.f, 160.f), sf::seconds(0.1f));
+    camera.MoveCamera(sf::Vector2f(240.f, 160.f), sf::seconds(0.1f));
     return;
   }
 
@@ -189,18 +195,25 @@ void CardSelectBattleState::onUpdate(double elapsed)
           Audio().Play(AudioType::CHIP_CONFIRM, AudioPriority::high);
 
           // If the list is untouched, we do not re-assign the cards
-          bool hasNewHand = cardCust.HasNewHand();
+          hasNewChips = cardCust.HasNewHand();
           std::vector<Battle::Card> newCards = cardCust.GetCards();
 
-          std::shared_ptr<Player> player = GetScene().GetLocalPlayer();
+          std::shared_ptr<Player> player = scene.GetLocalPlayer();
           std::shared_ptr<PlayerSelectedCardsUI> ui = player->GetFirstComponent<PlayerSelectedCardsUI>();
 
-          if (ui && hasNewHand) {
-            *cards = newCards;
-            GetScene().FilterSupportCards(player, *cards);
-            ui->LoadCards(*cards);
-            ui->Hide();
-            hasNewChips = true;
+          if (ui) {
+            if (hasNewChips) {
+              *cards = newCards;
+              // inform scene implementations of the new hand
+              scene.OnSelectNewCards(player, *cards);
+              scene.FilterSupportCards(player, *cards);
+              ui->LoadCards(*cards);
+              ui->Hide();
+            }
+            else {
+              // Send off the remaining hands to any scene implementations that need it
+              scene.OnSelectNewCards(player, ui->GetRemainingCards());
+            }
           }
 
           CheckFormChanges();
@@ -219,7 +232,7 @@ void CardSelectBattleState::onUpdate(double elapsed)
           Audio().Play(AudioType::CHIP_ERROR, AudioPriority::lowest);
         }
       }
-      else if (Input().Has(InputEvents::pressed_cancel) || sf::Mouse::isButtonPressed(sf::Mouse::Button::Right)) {
+      else if (Input().Has(InputEvents::pressed_cancel)) {
         cardCust.CursorCancel() ? Audio().Play(AudioType::CHIP_CANCEL, AudioPriority::highest) : 1;
       }
       else if (Input().Has(InputEvents::held_option)) {

BattleNetwork/battlescene/States/bnCardSelectBattleState.h

@@ -27,7 +27,7 @@ class CardSelectBattleState final : public BattleSceneState {
   bool pvpMode{ false };
   bool hasNewChips{ false }; 
   bool formSelected{ false };
-  bool firstTime{ true };
+  bool firstTime{ true }; //!< Show opposing mob's names on the first round
   int currForm{ -1 };
   float streamVolume{ -1.f };
   Font font;

BattleNetwork/battlescene/States/bnCharacterTransformBattleState.cpp

@@ -85,10 +85,9 @@ void CharacterTransformBattleState::UpdateAnimation(double elapsed)
 
     if (shineAnimations[count].GetAnimationString() != "SHINE") {
       shineAnimations[count] << "SHINE";
-
       if (index == -1) {
         // If decross, turn white immediately
-        shineAnimations[count] << Animator::On(1, [=] {      
+        shineAnimations[count] << Animator::On(1, [=] {
           player->SetShader(Shaders().GetShader(ShaderType::WHITE));
         }) << Animator::On(10, onTransform);
       }
@@ -105,8 +104,9 @@ void CharacterTransformBattleState::UpdateAnimation(double elapsed)
 
     } // else, it is already "SHINE" so wait the animation out...
 
-    // update for draw call later
+    // Update animation
     frameElapsed = elapsed;
+    shineAnimations[count].Update(frameElapsed, shine);
 
     count++;
   }
@@ -126,6 +126,7 @@ bool CharacterTransformBattleState::IsFinished() {
 }
 
 void CharacterTransformBattleState::onStart(const BattleSceneState*) {
+  Logger::Log(LogLevel::info, "CharacterTransformBattleState::onStart");
   if (skipBackdrop) {
     currState = state::animate;
   }
@@ -157,6 +158,7 @@ void CharacterTransformBattleState::onUpdate(double elapsed) {
 
 void CharacterTransformBattleState::onEnd(const BattleSceneState*)
 {
+  Logger::Log(LogLevel::info, "CharacterTransformBattleState::onEnd");
   for (auto&& anims : shineAnimations) {
     anims.SetAnimation(""); // ends the shine anim
   }
@@ -169,12 +171,10 @@ void CharacterTransformBattleState::onDraw(sf::RenderTexture& surface)
   BattleSceneBase& scene = GetScene();
 
   size_t count = 0;
+
   for (std::shared_ptr<Player>& player : scene.GetAllPlayers()) {
     auto& [index, complete] = scene.GetPlayerFormData(player);
 
-    Animation& anim = shineAnimations[count];
-    anim.Update(static_cast<float>(frameElapsed), shine);
-
     if (index != -1 && !complete) {
       // re-use the shine graphic for all animating player-types 
       const sf::Vector2f pos = player->getPosition();

BattleNetwork/battlescene/States/bnCharacterTransformBattleState.h

@@ -25,7 +25,6 @@ class CharacterTransformBattleState final : public BattleSceneState {
   bool skipBackdrop{ false };
   sf::Sprite shine;
   std::vector<Animation> shineAnimations;
-
   const bool FadeInBackdrop();
   const bool FadeOutBackdrop();
   void UpdateAnimation(double elapsed);

BattleNetwork/battlescene/States/bnCombatBattleState.cpp

@@ -108,9 +108,6 @@ void CombatBattleState::onStart(const BattleSceneState* last)
     scene.GetField()->ToggleTimeFreeze(false);
 
     hasTimeFreeze = false;
-
-    // reset bar and related flags
-    scene.SetCustomBarProgress(0);
   }
 }
 
@@ -122,9 +119,6 @@ void CombatBattleState::onEnd(const BattleSceneState* next)
   // then reset our combat and custom progress values
   if (this->HandleNextRoundSetup(next)) {
     scene.StopBattleStepTimer();
-
-    // reset bar 
-    scene.SetCustomBarProgress(0);
   }
 
   scene.HighlightTiles(false);
@@ -207,7 +201,7 @@ void CombatBattleState::OnCardActionUsed(std::shared_ptr<CardAction> action, uin
   // Only intercept this event if we are active
   if (scene.GetCurrentState() != this) return;
 
-  Logger::Logf(LogLevel::debug, "CombatBattleState::OnCardActionUsed() on frame #%i", scene.FrameNumber().count());
+  Logger::Logf(LogLevel::debug, "CombatBattleState::OnCardActionUsed() on frame #%i, with gauge progress %f", scene.FrameNumber().count(), this->GetScene().GetCustomBarProgress());
   if (!IsMobCleared()) {
     hasTimeFreeze = action->GetMetaData().timeFreeze;
   }

BattleNetwork/battlescene/States/bnMobIntroBattleState.cpp

@@ -12,41 +12,43 @@ MobIntroBattleState::MobIntroBattleState(Mob* mob):
 
 void MobIntroBattleState::onUpdate(double elapsed)
 {
-  if (!GetScene().IsSceneInFocus()) return;
+  BattleSceneBase& scene = GetScene();
 
-  Field& field = *GetScene().GetField();
+  if (!scene.IsSceneInFocus()) return;
+
+  Field& field = *scene.GetField();
 
   if (mob->NextMobReady()) {
-    auto data = mob->GetNextSpawn();
+    std::unique_ptr<Mob::SpawnData> data = mob->GetNextSpawn();
 
     Agent* cast = dynamic_cast<Agent*>(data->character.get());
 
     // Some entities have AI and need targets
     // TODO: support multiple targets
     if (cast) {
-      cast->SetTarget(GetScene().GetLocalPlayer());
+      cast->SetTarget(scene.GetLocalPlayer());
     }
 
     std::shared_ptr<Character>& enemy = data->character;
 
     enemy->ToggleTimeFreeze(false);
 
-    Battle::Tile* destTile = GetScene().GetField()->GetAt(data->tileX, data->tileY);
+    Battle::Tile* destTile = scene.GetField()->GetAt(data->tileX, data->tileY);
     enemy->SetTeam(destTile->GetTeam());
 
-    GetScene().GetField()->AddEntity(enemy, data->tileX, data->tileY);
+    scene.GetField()->AddEntity(enemy, data->tileX, data->tileY);
 
     if (destTile->GetTeam() == Team::red) {
       friendlies.push_back(enemy);
     }
 
     // Listen for events
-    GetScene().CounterHitListener::Subscribe(*enemy);
-    GetScene().HitListener::Subscribe(*enemy);
-    GetScene().SubscribeToCardActions(*enemy);
+    scene.CounterHitListener::Subscribe(*enemy);
+    scene.HitListener::Subscribe(*enemy);
+    scene.SubscribeToCardActions(*enemy);
   }
 
-  GetScene().GetField()->Update((float)elapsed);
+  scene.GetField()->Update((float)elapsed);
 }
 
 void MobIntroBattleState::onEnd(const BattleSceneState*)