tModLoader v2023.01
A mod to make and play Terraria mods
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...

Static Public Member Functions

static Mod GetMod (string name)
 Gets the instance of the Mod with the specified name. This will throw an exception if the mod cannot be found. More...
 
static bool HasMod (string name)
 Safely checks whether or not a mod with the specified internal name is currently loaded. More...
 
static bool IsSignedBy (TmodFile mod, string xmlPublicKey)
 
static bool TryGetMod (string name, out Mod result)
 Safely attempts to get the instance of the Mod with the specified name. More...
 

Static Public Attributes

static bool AlphaWelcomed
 
static bool DownloadedDependenciesOnStartup
 
static string LastLaunchedTModLoaderAlphaSha
 
static Version LastLaunchedTModLoaderVersion
 
static Version LastPreviewFreezeNotificationSeen
 
static bool PreviewFreezeNotification
 
static bool SeenFirstLaunchModderWelcomeMessage
 
static bool ShowFirstLaunchWelcomeMessage
 
static bool ShowWhatsNew
 
static bool WarnedFamilyShare
 

Properties

static string CompressedPlatformRepresentation [get]
 
static string ModPath [get]
 
static Mod[] Mods = new Mod[0] [get]
 
static string versionedName [get]
 

Detailed Description

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

Member Function Documentation

◆ GetMod()

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

Gets the instance of the Mod with the specified name. This will throw an exception if the mod cannot be found.

Exceptions
KeyNotFoundException

◆ HasMod()

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

Safely checks whether or not a mod with the specified internal name is currently loaded.

Returns
Whether or not a mod with the provided internal name has been found.

◆ TryGetMod()

static bool Terraria.ModLoader.ModLoader.TryGetMod ( string  name,
out Mod  result 
)
static

Safely attempts to get the instance of the Mod with the specified name.

Returns
Whether or not the requested instance has been found.