Terraria.ModLoader.ModLoader Class Reference

This serves as the central class which loads mods. It contains many static fields and methods related to mods and their contents. More...

Collaboration diagram for Terraria.ModLoader.ModLoader:

Static Public Member Functions
static bool	FileExists (string name)
static byte[]	GetFileBytes (string name)
static string[]	GetLoadedMods ()
static Mod	GetMod (string name)
	Gets the instance of the Mod with the specified name. More...
static Mod	GetMod (int index)
static Music	GetMusic (string name)
static SoundEffect	GetSound (string name)
static Texture2D	GetTexture (string name)
static bool	IsSignedBy (TmodFile mod, string xmlPublicKey)
static bool	MusicExists (string name)
static bool	SoundExists (string name)
static bool	TextureExists (string name)

Static Public Attributes
static readonly int	beta = 0
static readonly string	branchName = ""
static readonly string	compressedPlatformRepresentation = Platform.IsWindows ? "w" : (Platform.IsLinux ? "l" : "m")
static string	CompressedPlatformRepresentation => (Platform.IsWindows ? "w" : (Platform.IsLinux ? "l" : "m")) + (InstallVerifier.IsGoG ? "g" : "s") + (FrameworkVersion.Framework == Framework.NetFramework ? "n" : (FrameworkVersion.Framework == Framework.Mono ? "o" : "u"))
static Version	LastLaunchedTModLoaderVersion
static readonly bool	linux = Platform.IsLinux
static Mod[]	LoadedMods => Mods
static readonly bool	mac = Platform.IsOSX
static int	ModCount => Mods.Length
static string	ModPath => ModOrganizer.modPath
static bool	ShowFirstLaunchWelcomeMessage
static readonly Version	version = new Version(0, 11, 8, 4)
static readonly string	versionedName
static readonly string	versionTag
static readonly bool	windows = Platform.IsWindows

Properties
static Mod[]	Mods [get, private set]

Static Private Member Functions
static void	DisplayLoadError (string msg, Exception e, bool fatal, bool continueIsRetry=false)
static void	do_Unload ()
static void	DotNet45Check ()
static void	Load (CancellationToken token=default)
static bool	Unload ()
static void	WarnModsStillLoaded ()

Static Private Attributes
static HashSet< string >	_enabledMods
	A cached list of enabled mods (not necessarily currently loaded or even installed), mirroring the enabled.json file. More...
static bool	_needsSavingEnabledMods
static bool	_pauseSavingEnabledMods
static bool	isLoading = false
static readonly IDictionary< string, Mod >	modsByName = new Dictionary<string, Mod>(StringComparer.OrdinalIgnoreCase)
static string	steamID64 = ""
static WeakReference[]	weakModReferences = new WeakReference[0]

Detailed Description

This serves as the central class which loads mods. It contains many static fields and methods related to mods and their contents.

Definition at line 28 of file ModLoader.cs.

Member Function Documentation

static void Terraria.ModLoader.ModLoader.DisplayLoadError ( string  msg, Exception  e, bool  fatal, bool  continueIsRetry = false  )

staticprivate

Definition at line 272 of file ModLoader.cs.

References Terraria.ModLoader.Console, and Terraria.ModLoader.Environment.

        {
            msg += "\n\n" + (e.Data.Contains("hideStackTrace") ? e.Message : e.ToString());

            if (Main.dedServ) {
                Console.ForegroundColor = ConsoleColor.Red;
                Console.WriteLine(msg);
                Console.ResetColor();

                if (fatal) {
                    Console.WriteLine("Press any key to exit...");
                    Console.ReadKey();
                    Environment.Exit(-1);
                }
                else {
                    Reload();
                }
            }
            else {
                Interface.errorMessage.Show(msg,
                    gotoMenu: fatal ? -1 : Interface.reloadModsID,
                    webHelpURL: e.HelpLink,
                    continueIsRetry: continueIsRetry,
                    showSkip: !fatal);
            }
        }

static void Terraria.ModLoader.ModLoader.do_Unload ( )

staticprivate

Definition at line 244 of file ModLoader.cs.

References Terraria.ModLoader.Console.

        {
            Logging.tML.Info("Unloading mods");
            if (Main.dedServ) {
                Console.WriteLine("Unloading mods...");
            }
            else {
                Interface.loadMods.SetLoadStage("tModLoader.MSUnloading", Mods.Length);
            }

            ModContent.UnloadModContent();
            Mods = new Mod[0];
            modsByName.Clear();
            ModContent.Unload();

            MemoryTracking.Clear();
            Thread.MemoryBarrier();
            GC.Collect();
        }

static void Terraria.ModLoader.ModLoader.DotNet45Check ( )

staticprivate

Definition at line 196 of file ModLoader.cs.

References Terraria.ModLoader.Console, Terraria.ModLoader.Environment, Terraria.ModLoader.FrameworkVersion.Framework, and Terraria.ModLoader.FrameworkVersion.Version.

        {
            if (FrameworkVersion.Framework != Framework.NetFramework || FrameworkVersion.Version >= new Version(4, 5))
                return;

            var msg = Language.GetTextValue("tModLoader.LoadErrorDotNet45Required");
#if CLIENT
            Interface.MessageBoxShow(msg);
            Process.Start("https://dotnet.microsoft.com/download/dotnet-framework");
#else
            Console.ForegroundColor = ConsoleColor.Red;
            Console.WriteLine(msg);
            Console.ResetColor();
            Console.WriteLine("Press any key to exit...");
            Console.ReadKey();
#endif
            Environment.Exit(-1);
        }

static bool Terraria.ModLoader.ModLoader.FileExists ( string  name )

static

static byte [] Terraria.ModLoader.ModLoader.GetFileBytes ( string  name )

static

static string [] Terraria.ModLoader.ModLoader.GetLoadedMods ( )

static

static Mod Terraria.ModLoader.ModLoader.GetMod ( string  name )

static

Gets the instance of the Mod with the specified name.

Definition at line 90 of file ModLoader.cs.

Referenced by Terraria.ModLoader.ModNet.DownloadNextMod(), Terraria.ModLoader.ModContent.FileExists(), Terraria.ModLoader.ModContent.GetFileBytes(), Terraria.ModLoader.ModContent.GetMusic(), Terraria.ModLoader.ModContent.GetSound(), Terraria.ModLoader.ModContent.GetTexture(), Terraria.ModLoader.IO.ItemIO.Load(), Terraria.ModLoader.IO.ItemIO.LoadLegacy(), Terraria.ModLoader.ErrorLogger.Log(), Terraria.ModLoader.CommandManager.Matches(), Terraria.ModLoader.ModContent.MusicExists(), Terraria.ModLoader.ModContent.OpenRead(), Terraria.ModLoader.PlayerHooks.ReceiveCustomBiomes(), Terraria.ModLoader.ModContent.SoundExists(), and Terraria.ModLoader.ModContent.TextureExists().

        {
            modsByName.TryGetValue(name, out Mod m);
            return m;
        }

Here is the caller graph for this function:

static Mod Terraria.ModLoader.ModLoader.GetMod ( int  index )

static

static Music Terraria.ModLoader.ModLoader.GetMusic ( string  name )

static

static SoundEffect Terraria.ModLoader.ModLoader.GetSound ( string  name )

static

static Texture2D Terraria.ModLoader.ModLoader.GetTexture ( string  name )

static

static bool Terraria.ModLoader.ModLoader.IsSignedBy ( TmodFile  mod, string  xmlPublicKey  )

static

Definition at line 300 of file ModLoader.cs.

        {
            var f = new RSAPKCS1SignatureDeformatter();
            var v = AsymmetricAlgorithm.Create("RSA");
            f.SetHashAlgorithm("SHA1");
            v.FromXmlString(xmlPublicKey);
            f.SetKey(v);
            return f.VerifySignature(mod.hash, mod.signature);
        }

static void Terraria.ModLoader.ModLoader.Load ( CancellationToken  token = default )

staticprivate

Definition at line 120 of file ModLoader.cs.

        {
            try {
                if (isLoading)
                    throw new Exception("Load called twice");
                isLoading = true;

                if (!Unload())
                    return;

                var modInstances = ModOrganizer.LoadMods(token);

                weakModReferences = modInstances.Select(x => new WeakReference(x)).ToArray();
                modInstances.Insert(0, new ModLoaderMod());
                Mods = modInstances.ToArray();
                foreach (var mod in Mods)
                    modsByName[mod.Name] = mod;

                ModContent.Load(token);

                if (OnSuccessfulLoad != null) {
                    OnSuccessfulLoad();
                }
                else {
                    Main.menuMode = 0;
                }
            }
            catch when (token.IsCancellationRequested) {
                // cancel needs to reload with ModLoaderMod and all others skipped
                skipLoad = true;
                OnSuccessfulLoad += () => Main.menuMode = Interface.modsMenuID;

                isLoading = false;
                Load(); // don't provide a token, loading just ModLoaderMod should be quick
            }
            catch (Exception e) {
                var responsibleMods = new List<string>();
                if (e.Data.Contains("mod"))
                    responsibleMods.Add((string)e.Data["mod"]);
                if (e.Data.Contains("mods"))
                    responsibleMods.AddRange((IEnumerable<string>)e.Data["mods"]);
                responsibleMods.Remove("ModLoader");

                if (responsibleMods.Count == 0 && AssemblyManager.FirstModInStackTrace(new StackTrace(e), out var stackMod))
                    responsibleMods.Add(stackMod);

                var msg = Language.GetTextValue("tModLoader.LoadError", string.Join(", ", responsibleMods));
                if (responsibleMods.Count == 1) {
                    var mod = ModOrganizer.FindMods().FirstOrDefault(m => m.Name == responsibleMods[0]); //use First rather than Single, incase of "Two mods with the same name" error message from ModOrganizer (#639)
                    if (mod != null && mod.tModLoaderVersion != version)
                        msg += "\n" + Language.GetTextValue("tModLoader.LoadErrorVersionMessage", mod.tModLoaderVersion, versionedName);
                }
                if (responsibleMods.Count > 0)
                    msg += "\n" + Language.GetTextValue("tModLoader.LoadErrorDisabled");
                else
                    msg += "\n" + Language.GetTextValue("tModLoader.LoadErrorCulpritUnknown");

                if (e is ReflectionTypeLoadException reflectionTypeLoadException)
                    msg += "\n\n" + string.Join("\n", reflectionTypeLoadException.LoaderExceptions.Select(x => x.Message));

                Logging.tML.Error(msg, e);

                foreach (var mod in responsibleMods)
                    DisableMod(mod);

                isLoading = false; // disable loading flag, because server will just instantly retry reload
                DisplayLoadError(msg, e, e.Data.Contains("fatal"), responsibleMods.Count == 0);
            }
            finally {
                isLoading = false;
                OnSuccessfulLoad = null;
                skipLoad = false;
                ModNet.NetReloadActive = false;
            }
        }

static bool Terraria.ModLoader.ModLoader.MusicExists ( string  name )

static

static bool Terraria.ModLoader.ModLoader.SoundExists ( string  name )

static

static bool Terraria.ModLoader.ModLoader.TextureExists ( string  name )

static

static bool Terraria.ModLoader.ModLoader.Unload ( )

staticprivate

Definition at line 223 of file ModLoader.cs.

        {
            try {
                // have to move unload logic to a separate method so the stack frame is cleared. Otherwise unloading can capture mod instances in local variables, even with memory barriers (thanks compiler weirdness)
                do_Unload();
                WarnModsStillLoaded();
                return true;
            }
            catch (Exception e) {
                var msg = Language.GetTextValue("tModLoader.UnloadError");

                if (e.Data.Contains("mod"))
                    msg += "\n" + Language.GetTextValue("tModLoader.DefensiveUnload", e.Data["mod"]);

                Logging.tML.Fatal(msg, e);
                DisplayLoadError(msg, e, true);

                return false;
            }
        }

static void Terraria.ModLoader.ModLoader.WarnModsStillLoaded ( )

staticprivate

Definition at line 265 of file ModLoader.cs.

        {
            badUnloaders = weakModReferences.Where(r => r.IsAlive).Select(r => ((Mod)r.Target).Name).ToList();
            foreach (var modName in badUnloaders)
                Logging.tML.WarnFormat("{0} not fully unloaded during unload.", modName);
        }

Member Data Documentation

HashSet<string> Terraria.ModLoader.ModLoader._enabledMods

staticprivate

A cached list of enabled mods (not necessarily currently loaded or even installed), mirroring the enabled.json file.

Definition at line 324 of file ModLoader.cs.

bool Terraria.ModLoader.ModLoader._needsSavingEnabledMods

staticprivate

Definition at line 311 of file ModLoader.cs.

bool Terraria.ModLoader.ModLoader._pauseSavingEnabledMods

staticprivate

Definition at line 310 of file ModLoader.cs.

readonly int Terraria.ModLoader.ModLoader.beta = 0

static

Definition at line 38 of file ModLoader.cs.

readonly string Terraria.ModLoader.ModLoader.branchName = ""

static

Definition at line 36 of file ModLoader.cs.

readonly string Terraria.ModLoader.ModLoader.compressedPlatformRepresentation = Platform.IsWindows ? "w" : (Platform.IsLinux ? "l" : "m")

static

Definition at line 57 of file ModLoader.cs.

string Terraria.ModLoader.ModLoader.CompressedPlatformRepresentation => (Platform.IsWindows ? "w" : (Platform.IsLinux ? "l" : "m")) + (InstallVerifier.IsGoG ? "g" : "s") + (FrameworkVersion.Framework == Framework.NetFramework ? "n" : (FrameworkVersion.Framework == Framework.Mono ? "o" : "u"))

static

Definition at line 59 of file ModLoader.cs.

bool Terraria.ModLoader.ModLoader.isLoading = false

staticprivate

Definition at line 119 of file ModLoader.cs.

Version Terraria.ModLoader.ModLoader.LastLaunchedTModLoaderVersion

static

Definition at line 32 of file ModLoader.cs.

readonly bool Terraria.ModLoader.ModLoader.linux = Platform.IsLinux

static

Definition at line 52 of file ModLoader.cs.

Mod [] Terraria.ModLoader.ModLoader.LoadedMods => Mods

static

Definition at line 99 of file ModLoader.cs.

readonly bool Terraria.ModLoader.ModLoader.mac = Platform.IsOSX

static

Definition at line 54 of file ModLoader.cs.

int Terraria.ModLoader.ModLoader.ModCount => Mods.Length

static

Definition at line 102 of file ModLoader.cs.

string Terraria.ModLoader.ModLoader.ModPath => ModOrganizer.modPath

static

Definition at line 61 of file ModLoader.cs.

readonly IDictionary<string, Mod> Terraria.ModLoader.ModLoader.modsByName = new Dictionary<string, Mod>(StringComparer.OrdinalIgnoreCase)

staticprivate

Definition at line 63 of file ModLoader.cs.

bool Terraria.ModLoader.ModLoader.ShowFirstLaunchWelcomeMessage

static

Definition at line 34 of file ModLoader.cs.

string Terraria.ModLoader.ModLoader.steamID64 = ""

staticprivate

Definition at line 69 of file ModLoader.cs.

readonly Version Terraria.ModLoader.ModLoader.version = new Version(0, 11, 8, 4)

static

Definition at line 30 of file ModLoader.cs.

readonly string Terraria.ModLoader.ModLoader.versionedName

static

Initial value:

= $"tModLoader v{version}" +
                                                      (branchName.Length == 0 ? "" : $" {branchName}") +
                                                      (beta == 0 ? "" : $" Beta {beta}")

Definition at line 41 of file ModLoader.cs.

readonly string Terraria.ModLoader.ModLoader.versionTag

static

Initial value:

= $"v{version}" +
                                                    (branchName.Length == 0 ? "" : $"-{branchName.ToLower()}") +
                                                    (beta == 0 ? "" : $"-beta{beta}")

Definition at line 45 of file ModLoader.cs.

WeakReference [] Terraria.ModLoader.ModLoader.weakModReferences = new WeakReference[0]

staticprivate

Definition at line 64 of file ModLoader.cs.

readonly bool Terraria.ModLoader.ModLoader.windows = Platform.IsWindows

static

Definition at line 50 of file ModLoader.cs.

Property Documentation

Mod [] Terraria.ModLoader.ModLoader.Mods

staticgetprivate set

Definition at line 85 of file ModLoader.cs.

Referenced by Terraria.ModLoader.BuffLoader.GetBuff(), Terraria.ModLoader.IO.TagSerializer< T, S >.GetType(), Terraria.ModLoader.ModContent.LoadModContent(), Terraria.ModLoader.ModNet.OnModsDownloaded(), Terraria.ModLoader.Mod.PreSaveAndQuit(), Terraria.ModLoader.ModNet.ReadNetIDs(), Terraria.ModLoader.ModContent.RefreshModLanguage(), Terraria.ModLoader.ModNet.SendServerConfigs(), Terraria.ModLoader.ModContent.SetLocalizedText(), and Terraria.ModLoader.ModContent.SetupRecipes().