COMPLY WITH STYLE GUIDE OR ELSE! INFRACTION.

Sometimes I just like to read code and clean it up, you know?

.gitignore

@@ -9,3 +9,4 @@ releases
 SoulsyHUD_v*
 /vcpkg_installed
 **/unused
+compile_flags.txt

src/controller/control.rs

@@ -9,7 +9,7 @@
 //! Functions of note: `handle_key_event()`, `handle_item_equipped()`, and
 //! `timer_expired()`.
 //!
-//! I apologies for what a mess this is. It grew organically and the feature
+//! I apologize for what a mess this is. It grew organically and the feature
 //! set is itself complex.
 
 use std::collections::HashMap;
@@ -43,7 +43,7 @@ pub fn get() -> std::sync::MutexGuard<'static, Controller> {
 pub struct Controller {
     /// Our currently-active cycles.
     pub cycles: CycleData,
-    /// the hud item cache
+    /// The hud item cache.
     pub cache: ItemCache,
     /// The items the HUD should show right now.
     visible: HashMap<HudElement, HudItem>,

src/game/utility.cpp

@@ -139,15 +139,15 @@ namespace game
 
 	// ---------- potions
 
-	void consumePotion(const RE::TESForm* potion_form, RE::PlayerCharacter*& player)
+	void consumePotion(const RE::TESForm* potionForm, RE::PlayerCharacter*& thePlayer)
 	{
 		logger::trace("consumePotion called; form_id={}; potion='{}';"sv,
-			util::string_util::int_to_hex(potion_form->formID),
-			potion_form->GetName());
+			util::string_util::int_to_hex(potionForm->formID),
+			potionForm->GetName());
 
 		RE::TESBoundObject* obj  = nullptr;
 		RE::ExtraDataList* extra = nullptr;
-		auto remaining           = boundObjectForForm(potion_form, player, obj, extra);
+		auto remaining           = boundObjectForForm(potionForm, thePlayer, obj, extra);
 
 		if (!obj || remaining == 0)
 		{
@@ -165,19 +165,19 @@ namespace game
 			return;
 		}
 
-		auto* alchemy_item = obj->As<RE::AlchemyItem>();
-		if (alchemy_item->IsPoison())
+		auto* alchemyItem = obj->As<RE::AlchemyItem>();
+		if (alchemyItem->IsPoison())
 		{
-			poison_weapon(player, alchemy_item, extra, remaining);
+			poisonWeapon(thePlayer, alchemyItem, extra, remaining);
 			return;
 		}
 
 		auto* task = SKSE::GetTaskInterface();
 		if (!task) { return; }
-		task->AddTask([=]() { RE::ActorEquipManager::GetSingleton()->EquipObject(player, alchemy_item, extra); });
+		task->AddTask([=]() { RE::ActorEquipManager::GetSingleton()->EquipObject(thePlayer, alchemyItem); });
 	}
 
-	void poison_weapon(RE::PlayerCharacter*& player,
+	void poisonWeapon(RE::PlayerCharacter*& player,
 		RE::AlchemyItem*& poison,
 		RE::ExtraDataList* extra,
 		uint32_t remaining)
@@ -208,16 +208,16 @@ namespace game
 
 	// ---------- sounds
 
-	void playSound(RE::BGSSoundDescriptor* a_sound_descriptor, RE::PlayerCharacter*& a_player)
+	void playSound(RE::BGSSoundDescriptor* soundDescriptor, RE::PlayerCharacter*& thePlayer)
 	{
-		auto* audio_manager = RE::BSAudioManager::GetSingleton();
-		if (audio_manager && a_sound_descriptor)
+		auto* audio = RE::BSAudioManager::GetSingleton();
+		if (audio && soundDescriptor)
 		{
-			RE::BSSoundHandle sound_handle;
-			audio_manager->BuildSoundDataFromDescriptor(sound_handle, a_sound_descriptor);
-			sound_handle.SetObjectToFollow(a_player->Get3D());
-			sound_handle.SetVolume(1.0);
-			sound_handle.Play();
+			RE::BSSoundHandle soundHandle;
+			audio->BuildSoundDataFromDescriptor(soundHandle, soundDescriptor);
+			soundHandle.SetObjectToFollow(thePlayer->Get3D());
+			soundHandle.SetVolume(1.0);
+			soundHandle.Play();
 			// logger::trace("played sound"sv);
 		}
 	}

src/game/utility.h

@@ -18,7 +18,7 @@ namespace game
 
 	void consumePotion(const RE::TESForm* a_form, RE::PlayerCharacter*& a_player);
 	void consumeBestOption(RE::ActorValue a_actor_value);
-	void poison_weapon(RE::PlayerCharacter*& a_player,
+	void poisonWeapon(RE::PlayerCharacter*& a_player,
 		RE::AlchemyItem*& a_poison,
 		RE::ExtraDataList* extra,
 		uint32_t remaining);