From 01d1089a46915004d2a6297e8e6929dd34fb8916 Mon Sep 17 00:00:00 2001
From: Imbris <imbrisf@gmail.com>
Date: Thu, 29 Jul 2021 03:08:43 -0400
Subject: [PATCH] Add comment to physics and replace magic number in climbing
 boost with a named constant, fixes #1002

---
 common/src/states/climb.rs | 9 ++++++---
 common/systems/src/phys.rs | 2 ++
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/common/src/states/climb.rs b/common/src/states/climb.rs
index 71d87e84ec..9719790b56 100644
--- a/common/src/states/climb.rs
+++ b/common/src/states/climb.rs
@@ -68,10 +68,13 @@ impl CharacterBehavior for Data {
                 .then(|| data.body.jump_impulse())
                 .flatten()
             {
+                // How strong the climb boost is relative to a normal jump
+                const CLIMB_BOOST_JUMP_FACTOR: f32 = 0.5;
                 // They've climbed atop something, give them a boost
-                update
-                    .local_events
-                    .push_front(LocalEvent::Jump(data.entity, 0.5 * impulse / data.mass.0));
+                update.local_events.push_front(LocalEvent::Jump(
+                    data.entity,
+                    CLIMB_BOOST_JUMP_FACTOR * impulse / data.mass.0,
+                ));
             };
             update.character = CharacterState::Idle {};
             return update;
diff --git a/common/systems/src/phys.rs b/common/systems/src/phys.rs
index 39a5e62fb0..8c8104a1ce 100644
--- a/common/systems/src/phys.rs
+++ b/common/systems/src/phys.rs
@@ -668,6 +668,8 @@ impl<'a> PhysicsData<'a> {
         )
             .join()
         {
+            // Note: updating ori with the rest of the cache values above was attempted but
+            // it did not work (investigate root cause?)
             previous_phys_cache.ori = ori.to_quat();
         }
         drop(guard);