From aed71ac4db43297582da31528f4c35e8b18f6674 Mon Sep 17 00:00:00 2001 From: Date: Sat, 3 Feb 2018 21:11:38 -0800 Subject: [PATCH] Just some summary tags to explain some functions. --- .../StardewSymphony.cs | 32 ++++++++++++++++--- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/GeneralMods/StardewSymphonyRemastered/StardewSymphonyRemastered/StardewSymphony.cs b/GeneralMods/StardewSymphonyRemastered/StardewSymphonyRemastered/StardewSymphony.cs index 4824ea15..dd73bdb3 100644 --- a/GeneralMods/StardewSymphonyRemastered/StardewSymphonyRemastered/StardewSymphony.cs +++ b/GeneralMods/StardewSymphonyRemastered/StardewSymphonyRemastered/StardewSymphony.cs @@ -17,9 +17,7 @@ namespace StardewSymphonyRemastered /// BIG WIP. Don't use this at all because it does nothing right now. /// TODO: /// 1.Make Xwb packs work - /// 1.5. Make way to load in music packs. /// 2.Make stream files work - /// 2.5. Make Music Manager /// 3.Make interface. /// 4.Make sure stuff doesn't blow up. /// 5.Release @@ -44,6 +42,10 @@ namespace StardewSymphonyRemastered public bool musicPacksInitialized; + /// + /// Entry point for the mod. + /// + /// public override void Entry(IModHelper helper) { DefaultSoundBank = Game1.soundBank; @@ -67,6 +69,11 @@ namespace StardewSymphonyRemastered musicPacksInitialized = false; } + /// + /// Raised every frame. Mainly used just to initiate the music packs. Probably not needed. + /// + /// + /// private void GameEvents_UpdateTick(object sender, EventArgs e) { if (musicPacksInitialized == false) @@ -76,6 +83,9 @@ namespace StardewSymphonyRemastered } } + /// + /// Load in the music packs to the music manager. + /// public void initializeMusicPacks() { //load in all packs here. @@ -83,6 +93,9 @@ namespace StardewSymphonyRemastered loadWAVMusicPacks(); } + /// + /// Create the core directories needed by the mod. + /// public void createDirectories() { if (!Directory.Exists(MusicPath)) Directory.CreateDirectory(MusicPath); @@ -91,6 +104,10 @@ namespace StardewSymphonyRemastered if (!Directory.Exists(TemplateMusicDirectory)) Directory.CreateDirectory(TemplateMusicDirectory); } + + /// + /// Used to create a blank XACT music pack example. + /// public void createBlankXACTTemplate() { string path= Path.Combine(TemplateMusicDirectory, "XACT"); @@ -109,6 +126,9 @@ namespace StardewSymphonyRemastered } } + /// + /// USed to create a blank WAV music pack example. + /// public void createBlankWAVTemplate() { string path = Path.Combine(TemplateMusicDirectory, "WAV"); @@ -133,7 +153,9 @@ namespace StardewSymphonyRemastered } } - + /// + /// Load in the XACT music packs. + /// public static void loadXACTMusicPacks() { string[] listOfDirectories= Directory.GetDirectories(XACTMusicDirectory); @@ -179,7 +201,9 @@ namespace StardewSymphonyRemastered } } - + /// + /// Load in WAV music packs. + /// public static void loadWAVMusicPacks() { string[] listOfDirectories = Directory.GetDirectories(WavMusicDirectory);