Code cleanuup

* Apply editconfig changes from DBM-Core * Apply correct indentations to pkgmeta and travis.yml * Cleaned up code in LoadList.lua * Use the correct variables in functions (these were always nil) * Localise table.insert for performance
DeadlyBossMods · Sep 14, 2019 · d4c4e81 · d4c4e81
1 parent 362af32
commit d4c4e81
Show file tree

Hide file tree

Showing 4 changed files with 220 additions and 66 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -10,6 +10,6 @@ insert_final_newline = true
 [*.md]
 trim_trailing_whitespace = false
 
-[*.yml]
+[{*.yml,.pkgmeta}]
 indent_style = space
-indent_size = 4
+indent_size = 2
diff --git a/.pkgmeta b/.pkgmeta
@@ -2,4 +2,4 @@ package-as: DBM-SoundEventsPack
 enable-nolib-creation: no
 
 move-folders:
-    DBM-SoundEventsPack/DBM-SoundEventsPack: DBM-SoundEventsPack
+  DBM-SoundEventsPack/DBM-SoundEventsPack: DBM-SoundEventsPack
diff --git a/.travis.yml b/.travis.yml
@@ -13,8 +13,8 @@ install: luarocks install --local luacheck
 script: /home/travis/.luarocks/bin/luacheck . --no-color -qo "011"
 
 after_success:
-    - curl -s https://raw.githubusercontent.com/BigWigsMods/packager/master/release.sh | bash; if [[ $? != 0 ]]; then TRAVIS_TEST_RESULT=1; fi
-    - curl -s https://raw.githubusercontent.com/BigWigsMods/packager/master/release.sh | bash -s -- -g 1.13.2; if [[ $? != 0 ]]; then TRAVIS_TEST_RESULT=1; fi
+  - curl -s https://raw.githubusercontent.com/BigWigsMods/packager/master/release.sh | bash; if [[ $? != 0 ]]; then TRAVIS_TEST_RESULT=1; fi
+  - curl -s https://raw.githubusercontent.com/BigWigsMods/packager/master/release.sh | bash -s -- -g 1.13.2; if [[ $? != 0 ]]; then TRAVIS_TEST_RESULT=1; fi
 
 notifications:
   email:

diff --git a/DBM-SoundEventsPack/LoadList.lua b/DBM-SoundEventsPack/LoadList.lua
@@ -1,73 +1,227 @@
+local insert = table.insert
 local inserted1, inserted2, inserted3 = false, false, false
---Try to use unique function names so diff user packs don't overwrite eachother, Generally I just use MP, VP, DF + Unique Addon Name
---Function names are defined in TOC. A pack does not need to contain all 3 sound types. You are welcome to make just specific ones, just make sure TOC is correct
-function DBMVPSoundEventsPack()--Register Victory sounds to DBM.Victory table
-	if inserted then return end
-	tinsert(DBM.Victory, {text = "Zelda OoT: Chest",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Chest_Opening_and_Getting_Item.ogg"})
-	tinsert(DBM.Victory, {text = "Gooshers: win",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\goosherswin.ogg"})
-	tinsert(DBM.Victory, {text = "Sonic: Stage Cleared",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\sonic.ogg"})
-	tinsert(DBM.Victory, {text = "FF: Fanfare",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_FinalFantasy.ogg"})
-	tinsert(DBM.Victory, {text = "FF: Fanfare Long",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_FinalFantasyLong.ogg"})
-	tinsert(DBM.Victory, {text = "FF: Fanfare Classic",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_FinalFantasyClassic.ogg"})
-	tinsert(DBM.Victory, {text = "SMB: Stage Clear",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioBros.ogg"})
-	tinsert(DBM.Victory, {text = "SMB: Stage Clear 2",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioBrosDungeon.ogg"})
-	tinsert(DBM.Victory, {text = "SMB3: Stage Clear",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioBros3.ogg"})
-	tinsert(DBM.Victory, {text = "SMRPG: Victory",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioRPG.ogg"})
-	tinsert(DBM.Victory, {text = "SMW: Victory",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioWorld.ogg"})
+
+-- Try to use unique function names so diff user packs don't overwrite eachother, Generally I just use MP, VP, DF + Unique Addon Name
+-- Function names are defined in TOC. A pack does not need to contain all 3 sound types. You are welcome to make just specific ones, just make sure TOC is correct
+
+function DBMVPSoundEventsPack() -- Register Victory sounds to DBM.Victory table
+	if inserted1 then
+		return
+	end
+	insert(DBM.Victory, {
+		text	= "Zelda OoT: Chest",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Chest_Opening_and_Getting_Item.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "Gooshers: win",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\goosherswin.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "Sonic: Stage Cleared",
+		value = "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\sonic.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "FF: Fanfare",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_FinalFantasy.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "FF: Fanfare Long",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_FinalFantasyLong.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "FF: Fanfare Classic",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_FinalFantasyClassic.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "SMB: Stage Clear",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioBros.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "SMB: Stage Clear 2",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioBrosDungeon.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "SMB3: Stage Clear",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioBros3.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "SMRPG: Victory",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioRPG.ogg"
+	})
+	insert(DBM.Victory, {
+		text	= "SMW: Victory",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Victory\\Victory_SuperMarioWorld.ogg"
+	})
 	inserted1 = true
 end
-function DBMDPSoundEventsPack()--Register Defeat sounds to DBM.Defeat Table
-	if inserted then return end
-	tinsert(DBM.Defeat, {text = "Alex Death",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\alexdeath.ogg"})
-	tinsert(DBM.Defeat, {text = "Death 1",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\death1.ogg"})
-	tinsert(DBM.Defeat, {text = "Death 2",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\death2.ogg"})
-	tinsert(DBM.Defeat, {text = "Drama",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\drama.ogg"})
-	tinsert(DBM.Defeat, {text = "Etpm",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\etpm.ogg"})
-	tinsert(DBM.Defeat, {text = "Gooshers: fail",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\gooshersfail.ogg"})
-	tinsert(DBM.Defeat, {text = "IOUS",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\IOUS.ogg"})
-	tinsert(DBM.Defeat, {text = "Keyboard Cat",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\KeyboardCat.ogg"})
-	tinsert(DBM.Defeat, {text = "SMB: Death",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\mariodie.ogg"})
-	tinsert(DBM.Defeat, {text = "SMB3: Death",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\mariodie2.ogg"})
-	tinsert(DBM.Defeat, {text = "SMW: Game Over",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\SuperMarioWorld.ogg"})
-	tinsert(DBM.Defeat, {text = "Oh No",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\ohno.ogg"})
-	tinsert(DBM.Defeat, {text = "PacMan: Death",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\pacmandie.ogg"})
-	tinsert(DBM.Defeat, {text = "Price Is Right",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\PriceIsRight.ogg"})
-	tinsert(DBM.Defeat, {text = "Sonic: Game Over",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\sonic.ogg"})
-	tinsert(DBM.Defeat, {text = "Whoa",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\whoa.ogg"})
-	tinsert(DBM.Defeat, {text = "Whoops",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\whoops.ogg"})
-	tinsert(DBM.Defeat, {text = "Link: Death",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\zelda.ogg"})
-	tinsert(DBM.Defeat, {text = "Twiggl: Stop It",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\stop_it1.ogg"})
+
+function DBMDPSoundEventsPack() -- Register Defeat sounds to DBM.Defeat Table
+	if inserted2 then
+		return
+	end
+	insert(DBM.Defeat, {
+		text	= "Alex Death",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\alexdeath.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Death 1",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\death1.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Death 2",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\death2.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Drama",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\drama.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Etpm",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\etpm.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Gooshers: fail",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\gooshersfail.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "IOUS",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\IOUS.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Keyboard Cat",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\KeyboardCat.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "SMB: Death",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\mariodie.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "SMB3: Death",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\mariodie2.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "SMW: Game Over",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\SuperMarioWorld.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Oh No",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\ohno.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "PacMan: Death",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\pacmandie.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Price Is Right",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\PriceIsRight.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Sonic: Game Over",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\sonic.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Whoa",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\whoa.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Whoops",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\whoops.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Link: Death",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\zelda.ogg"
+	})
+	insert(DBM.Defeat, {
+		text	= "Twiggl: Stop It",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Defeat\\stop_it1.ogg"
+	})
 	inserted2 = true
 end
-function DBMMPSoundEventsPack()--Register Music to DBM.Music Table
-	if inserted then return end
-	--All Music Table
-	tinsert(DBM.Music, {text = "FFVII: Boss Battle",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_FinalFantasy.ogg"})
-	tinsert(DBM.Music, {text = "FFX: Boss Battle",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_FinalFantasyX.ogg"})
-	tinsert(DBM.Music, {text = "SMB: Stage",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioBros.ogg"})
-	tinsert(DBM.Music, {text = "SMB3: Stage",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioBros3.ogg"})
-	tinsert(DBM.Music, {text = "SMRPG: Boss Battle",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioRPG_Boss.ogg"})
-	tinsert(DBM.Music, {text = "SMW: Stage",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioWorld.ogg"})
-	tinsert(DBM.Music, {text = "Super Metroid: Ridley",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMetroidRidley.ogg"})
-	tinsert(DBM.Music, {text = "WingCommander",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_WingCommander.ogg"})
-	tinsert(DBM.Music, {text = "Blakbyrd",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Blackbyrd.ogg"})
---	tinsert(DBM.Music, {text = "CatDany: Turtle",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\turtle_water.ogg"})
+
+function DBMMPSoundEventsPack() -- Register Music to DBM.Music Table
+	if inserted3 then
+		return
+	end
+	-- All Music Table
+	insert(DBM.Music, {
+		text	= "FFVII: Boss Battle",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_FinalFantasy.ogg"
+	})
+	insert(DBM.Music, {
+		text	= "FFX: Boss Battle",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_FinalFantasyX.ogg"
+	})
+	insert(DBM.Music, {
+		text	= "SMB: Stage",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioBros.ogg"
+	})
+	insert(DBM.Music, {
+		text	= "SMB3: Stage",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioBros3.ogg"
+	})
+	insert(DBM.Music, {
+		text	= "SMRPG: Boss Battle",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioRPG_Boss.ogg"
+	})
+	insert(DBM.Music, {
+		text	= "SMW: Stage",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioWorld.ogg"
+	})
+	insert(DBM.Music, {
+		text	= "Super Metroid: Ridley",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMetroidRidley.ogg"
+	})
+	insert(DBM.Music, {
+		text	= "WingCommander",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_WingCommander.ogg"
+	})
+	insert(DBM.Music, {
+		text	= "Blakbyrd",
+		value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Blackbyrd.ogg"
+	})
 
-	--Dungeon BGM Table
+	-- Dungeon BGM Table
 	if DBM.DungeonMusic then
-		tinsert(DBM.DungeonMusic, {text = "SMB: Stage",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioBros.ogg"})
-		tinsert(DBM.DungeonMusic, {text = "SMB3: Stage",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioBros3.ogg"})
-		tinsert(DBM.DungeonMusic, {text = "SMW: Stage",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioWorld.ogg"})
-		tinsert(DBM.DungeonMusic, {text = "Blakbyrd",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Blackbyrd.ogg"})
+		insert(DBM.DungeonMusic, {
+			text	= "SMB: Stage",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioBros.ogg"
+		})
+		insert(DBM.DungeonMusic, {
+			text	= "SMB3: Stage",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioBros3.ogg"
+		})
+		insert(DBM.DungeonMusic, {
+			text	= "SMW: Stage",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioWorld.ogg"
+		})
+		insert(DBM.DungeonMusic, {
+			text	= "Blakbyrd",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Blackbyrd.ogg"
+		})
 	end
-	--Boss BGM Table
+
+	-- Boss BGM Table
 	if DBM.BattleMusic then
-		tinsert(DBM.BattleMusic, {text = "FFVII: Boss Battle",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_FinalFantasy.ogg"})
-		tinsert(DBM.BattleMusic, {text = "FFX: Boss Battle",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_FinalFantasyX.ogg"})
-		tinsert(DBM.BattleMusic, {text = "SMRPG: Boss Battle",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioRPG_Boss.ogg"})
-		tinsert(DBM.BattleMusic, {text = "Super Metroid: Ridley",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMetroidRidley.ogg"})
-		tinsert(DBM.BattleMusic, {text = "WingCommander",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_WingCommander.ogg"})
---		tinsert(DBM.BattleMusic, {text = "CatDany: Turtle",	value = "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\turtle_water.ogg"})
+		insert(DBM.BattleMusic, {
+			text	= "FFVII: Boss Battle",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_FinalFantasy.ogg"
+		})
+		insert(DBM.BattleMusic, {
+			text	= "FFX: Boss Battle",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_FinalFantasyX.ogg"
+		})
+		insert(DBM.BattleMusic, {
+			text	= "SMRPG: Boss Battle",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMarioRPG_Boss.ogg"
+		})
+		insert(DBM.BattleMusic, {
+			text	= "Super Metroid: Ridley",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_SuperMetroidRidley.ogg"
+		})
+		insert(DBM.BattleMusic, {
+			text	= "WingCommander",
+			value	= "Interface\\AddOns\\DBM-SoundEventsPack\\Music\\Music_WingCommander.ogg"
+		})
 	end
 	inserted3 = true
 end