rename memory/main.py variables

Author: shenef

battle/boss.py

@@ -556,8 +556,8 @@ def gui():
                 aeon_turn = True
 
     screen.await_turn()
-    nextHP = memory.main.get_battle_hp()[0]
-    lastHP = nextHP
+    next_hp = memory.main.get_battle_hp()[0]
+    lastHP = next_hp
     turn1 = False
     nextTurn = 20
     lastTurn = 20
@@ -566,7 +566,7 @@ def gui():
         pass
     while memory.main.battle_active():
         if memory.main.turn_ready() and memory.main.get_battle_char_turn() == 8:
-            nextHP = memory.main.get_battle_hp()[0]
+            next_hp = memory.main.get_battle_hp()[0]
             lastTurn = nextTurn
             nextTurn = memory.main.get_next_turn()
             if went and kimahriCrit:
@@ -582,14 +582,14 @@ def gui():
             elif lastTurn == 8:  # Valefor takes two turns in a row
                 logger.debug("------Two turns in a row")
                 battle.main.aeon_shield()
-            elif nextHP > lastHP - 40 and not nextHP == lastHP:
+            elif next_hp > lastHP - 40 and not next_hp == lastHP:
                 # Gravity spell was used
                 logger.debug("------Gravity was used")
                 battle.main.aeon_shield()
             else:
                 logger.debug("------Attack was just used. Now boost.")
                 battle.main.aeon_boost()
-            lastHP = nextHP
+            lastHP = next_hp
         elif memory.main.turn_ready() and memory.main.get_battle_char_turn() == 1:
             logger.warning("Yuna turn, something went wrong.")
         elif memory.main.turn_ready() and memory.main.get_battle_char_turn() == 2:
@@ -1757,15 +1757,15 @@ def yu_yevon():
                 else:
                     battle.main.defend()
             elif zombieAttack:  # Throw P.down to end game
-                itemNum = battle.main.yu_yevon_item()
-                if itemNum == 99:
+                item_num = battle.main.yu_yevon_item()
+                if item_num == 99:
                     battle.main.attack("none")
                 else:
                     while memory.main.battle_menu_cursor() != 1:
                         xbox.tap_down()
                     while memory.main.main_battle_menu():
                         xbox.tap_b()
-                    item_pos = memory.main.get_throw_items_slot(itemNum)
+                    item_pos = memory.main.get_throw_items_slot(item_num)
                     battle.main._navigate_to_position(item_pos)
                     while memory.main.other_battle_menu():
                         xbox.tap_b()

blitz.py

@@ -66,8 +66,8 @@ def select_shot_type():
 
 
 def targeted_player():
-    retVal = memory.main.blitz_target_player() - 2
-    return retVal
+    ret_val = memory.main.blitz_target_player() - 2
+    return ret_val
 
 
 def active_clock():
@@ -79,9 +79,9 @@ def aurochs_control():
 
 
 def controlling_player():
-    retVal = memory.main.blitz_current_player() - 2
-    if retVal < 200:
-        return retVal
+    ret_val = memory.main.blitz_current_player() - 2
+    if ret_val < 200:
+        return ret_val
     return 1
 
 
@@ -1078,9 +1078,9 @@ def blitz_main(forceBlitzWin):
                     prep_half()
                 else:
                     storyline(forceBlitzWin)
-        except Exception as xVal:
+        except Exception as x_val:
             print("Caught exception in blitz memory.main.:")
-            print(xVal)
+            print(x_val)
 
     print("Blitz game has completed.")
     # Set the blitzWin flag for the rest of the run.

config.yaml.example

@@ -26,7 +26,7 @@ vars:
   perfectAeonKills    : False  # Before YuYevon, True is slower but more swag.
   attemptDjose        : False  # Try Djose skip? (not likely to succeed)
   legacySoundtrack    : True   # use the original Soundtrack instead of arranged
-  doNotSkipCutscenes  : False  #            - Missing documentation -
+  do_not_skip_cutscenes  : False  #            - Missing documentation -
 
   # Accessibility for blind
   skip_cutscene_flag  : True   #            - Missing documentation -

logs.py

@@ -3,9 +3,9 @@
 import memory.main
 
 try:
-    from memory.main import baseValue
+    from memory.main import base_value
 except Exception:
-    baseValue = 0x0
+    base_value = 0x0
 game = "FFX_"
 ext = ".txt"
 fileName = "none"
@@ -177,7 +177,7 @@ def __init__(
         if self.isPointer:
             self.ptrOffset = ptrOffsetRef
         self.varType = typeRef
-        self.key = baseValue + 0x003988A5
+        self.key = base_value + 0x003988A5
 
         self.set_last_value()
 
@@ -323,15 +323,15 @@ def mem_change_list():
 
 
 def mem_change_handle():
-    retArray = [0]
+    ret_array = [0]
     firstEle = True
     memRefList = mem_change_list()
 
     while len(baseArray) != 0:
         if firstEle:
             firstEle = False
             variables = memRefList.pop()
-            retArray[0] = MemChangeMonitor(
+            ret_array[0] = MemChangeMonitor(
                 baseOffsetRef=variables[0],
                 isPointerRef=variables[1],
                 ptrOffsetRef=variables[2],
@@ -340,7 +340,7 @@ def mem_change_handle():
             )
         else:
             variables = memRefList.pop()
-            retArray.append(
+            ret_array.append(
                 MemChangeMonitor(
                     baseOffsetRef=variables[0],
                     isPointerRef=variables[1],
@@ -349,7 +349,7 @@ def mem_change_handle():
                     childReport=variables[4],
                 )
             )
-    return retArray
+    return ret_array
 
 
 def time_stamp():

memory/get.py

@@ -8,14 +8,14 @@
 
 PROCESS_QUERY_INFORMATION = 0x0400
 MAX_PATH = 260
-baseValue = 0
+base_value = 0
 
 
 class LocProcess(Process):
     def __init__(self, *args, **kwargs):
         super(LocProcess, self).__init__(*args, **kwargs)
 
-    def readBytes(self, lp_base_address: int, size: int = 4):
+    def read_bytes(self, lp_base_address: int, size: int = 4):
         """
         See the original ReadWriteMemory values for details on how this works. This version allows us to pass
         the number of bytes to be retrieved instead of a static 4-byte size. Default is 4 for reverse-compatibility
@@ -41,7 +41,7 @@ def readBytes(self, lp_base_address: int, size: int = 4):
             }
             ReadWriteMemoryError(error)
 
-    def writeBytes(self, lp_base_address: int, value: int, size: int = 4) -> bool:
+    def write_bytes(self, lp_base_address: int, value: int, size: int = 4) -> bool:
         """
         Same as above, write a passed number of bytes instead of static 4 bytes. Default is 4 for reverse-compatibility
         """
@@ -114,9 +114,9 @@ def get_process_by_name(self, process_name: str | bytes) -> "Process":
 
 
 def cutscene_id():
-    global baseValue
-    key = baseValue + 0xD27C88
-    cutscene_alt = process.readBytes(key, 4)
+    global base_value
+    key = base_value + 0xD27C88
+    cutscene_alt = process.read_bytes(key, 4)
     storyline_prog = memory.main.get_story_progress()
     dialogue = memory.main.diag_progress_flag()
     return (cutscene_alt, storyline_prog, dialogue)