Terraria ModLoader  0.11.4
A framework for Terraria mods
Terraria.ModLoader.Mod Class Reference

Mod is an abstract class that you will override. It serves as a central place from which the mod's contents are stored. It provides methods for you to use or override. More...

+ Collaboration diagram for Terraria.ModLoader.Mod:

Public Member Functions

void AddBackgroundTexture (string texture)
 Adds a texture to the list of background textures and assigns it a background texture slot. More...
 
void AddBossHeadTexture (string texture, int npcType=-1)
 Assigns a head texture that can be used by NPCs on the map. More...
 
void AddBuff (string name, ModBuff buff, string texture)
 Adds a type of buff to the game with the specified internal name and texture. More...
 
void AddCommand (string name, ModCommand mc)
 Manually add a Command during Load More...
 
void AddConfig (string name, ModConfig mc)
 
void AddDust (string name, ModDust dust, string texture="")
 Adds a type of dust to your mod with the specified name. Create an instance of ModDust normally, preferably through the constructor of an overriding class. Leave the texture as an empty string to use the vanilla dust sprite sheet. More...
 
int AddEquipTexture (ModItem item, EquipType type, string name, string texture, string armTexture="", string femaleTexture="")
 Adds an equipment texture of the specified type, internal name, and associated item to your mod. (The item parameter may be null if you don't want to associate an item with the texture.) You can then get the ID for your texture by calling EquipLoader.GetEquipTexture, and using the EquipTexture's Slot property. If the EquipType is EquipType.Body, make sure that you also provide an armTexture and a femaleTexture. Returns the ID / slot that is assigned to the equipment texture. More...
 
int AddEquipTexture (EquipTexture equipTexture, ModItem item, EquipType type, string name, string texture, string armTexture="", string femaleTexture="")
 Adds an equipment texture of the specified type, internal name, and associated item to your mod. This method is different from the other AddEquipTexture in that you can specify the class of the equipment texture, thus allowing you to override EquipmentTexture's hooks. All other parameters are the same as the other AddEquipTexture. More...
 
void AddGlobalBgStyle (string name, GlobalBgStyle globalBgStyle)
 Adds the given global background style with the given name to this mod. More...
 
void AddGlobalBuff (string name, GlobalBuff globalBuff)
 Adds the given GlobalBuff instance to this mod using the provided name. More...
 
void AddGlobalItem (string name, GlobalItem globalItem)
 Adds the given GlobalItem instance to this mod with the provided name. More...
 
void AddGlobalNPC (string name, GlobalNPC globalNPC)
 Adds the given GlobalNPC instance to this mod with the provided name. More...
 
void AddGlobalProjectile (string name, GlobalProjectile globalProjectile)
 Adds the given GlobalProjectile instance to this mod with the provided name. More...
 
void AddGlobalRecipe (string name, GlobalRecipe globalRecipe)
 Manually add a Global Recipe during Load More...
 
void AddGlobalTile (string name, GlobalTile globalTile)
 Adds the given GlobalTile instance to this mod with the provided name. More...
 
void AddGlobalWall (string name, GlobalWall globalWall)
 Adds the given GlobalWall instance to this mod with the provided name. More...
 
void AddGore (string texture, ModGore modGore=null)
 Adds the given texture to the game as a custom gore, with the given custom gore behavior. If no custom gore behavior is provided, the custom gore will have the default vanilla behavior. More...
 
void AddItem (string name, ModItem item)
 Adds a type of item to your mod with the specified internal name. This method should be called in Load. You can obtain an instance of ModItem by overriding it then creating an instance of the subclass. More...
 
void AddModWorld (string name, ModWorld modWorld)
 Adds a ModWorld to this mod with the given name. More...
 
void AddMount (string name, ModMountData mount, string texture, IDictionary< MountTextureType, string > extraTextures=null)
 Adds the given mount to the game with the given name and texture. The extraTextures dictionary should optionally map types of mount textures to the texture paths you want to include. More...
 
void AddMusicBox (int musicSlot, int itemType, int tileType, int tileFrameY=0)
 Allows you to tie a music ID, and item ID, and a tile ID together to form a music box. When music with the given ID is playing, equipped music boxes have a chance to change their ID to the given item type. When an item with the given item type is equipped, it will play the music that has musicSlot as its ID. When a tile with the given type and Y-frame is nearby, if its X-frame is >= 36, it will play the music that has musicSlot as its ID. More...
 
void AddNPC (string name, ModNPC npc)
 Adds a type of NPC to the game with the specified name and texture. Also allows you to give the NPC alternate textures. More...
 
void AddNPCHeadTexture (int npcType, string texture)
 Assigns a head texture to the given town NPC type. More...
 
void AddPlayer (string name, ModPlayer player)
 Adds a type of ModPlayer to this mod. All ModPlayer types will be newly created and attached to each player that is loaded. More...
 
void AddPrefix (string name, ModPrefix prefix)
 Adds a prefix to your mod with the specified internal name. This method should be called in Load. You can obtain an instance of ModPrefix by overriding it then creating an instance of the subclass. More...
 
void AddProjectile (string name, ModProjectile projectile)
 Adds a type of projectile to the game with the specified name. More...
 
virtual void AddRecipeGroups ()
 Override this method to add recipe groups to this mod. You must add recipe groups by calling the RecipeGroup.RegisterGroup method here. A recipe group is a set of items that can be used interchangeably in the same recipe. More...
 
virtual void AddRecipes ()
 Override this method to add recipes to the game. It is recommended that you do so through instances of ModRecipe, since it provides methods that simplify recipe creation. More...
 
void AddSound (SoundType type, string soundPath, ModSound modSound=null)
 Adds the given sound file to the game as the given type of sound and with the given custom sound playing. If no ModSound instance is provided, the custom sound will play in a similar manner as the default vanilla ones. More...
 
void AddSurfaceBgStyle (string name, ModSurfaceBgStyle surfaceBgStyle)
 Adds the given surface background style with the given name to this mod. More...
 
void AddTexture (string name, Texture2D texture)
 Shorthand for calling ModLoader.AddTexture(this.FileName(name), texture). More...
 
void AddTile (string name, ModTile tile, string texture)
 Adds a type of tile to the game with the specified name and texture. More...
 
void AddTileEntity (string name, ModTileEntity entity)
 Manually add a tile entity during Load. More...
 
void AddTranslation (ModTranslation translation)
 Adds a ModTranslation to the game so that you can use Language.GetText to get a LocalizedText. More...
 
void AddUgBgStyle (string name, ModUgBgStyle ugBgStyle)
 Adds the given underground background style with the given name to this mod. More...
 
void AddWall (string name, ModWall wall, string texture)
 Adds a type of wall to the game with the specified name and texture. More...
 
void AddWaterfallStyle (string name, ModWaterfallStyle waterfallStyle, string texture)
 Adds the given waterfall style to the game with the given name and texture path. More...
 
void AddWaterStyle (string name, ModWaterStyle waterStyle, string texture, string blockTexture)
 Adds the given water style to the game with the given name, texture path, and block texture path. More...
 
int BuffType (string name)
 Gets the type of the ModBuff of this mod corresponding to the given name. Returns 0 if no ModBuff with the given name is found. More...
 
int BuffType< T > ()
 Same as the other BuffType, but assumes that the class name and internal name are the same. More...
 
virtual object Call (params object[] args)
 Used for weak inter-mod communication. This allows you to interact with other mods without having to reference their types or namespaces, provided that they have implemented this method. More...
 
virtual void Close ()
 Close is called before Unload, and may be called at any time when mod unloading is imminent (such as when downloading an update, or recompiling) Use this to release any additional file handles, or stop streaming music. Make sure to call base.Close() at the end May be called multiple times before Unload More...
 
ModTranslation CreateTranslation (string key)
 Creates a ModTranslation object that you can use in AddTranslation. More...
 
int DustType (string name)
 Gets the type of the ModDust of this mod with the given name. Returns 0 if no ModDust with the given name is found. More...
 
int DustType< T > ()
 Same as the other DustType, but assumes that the class name and internal name are the same. More...
 
bool EffectExists (string name)
 Used to check if a custom Effect exists More...
 
bool FileExists (string name)
 Shorthand for calling ModLoader.FileExists(this.FileName(name)). Note that file extensions are used here. More...
 
bool FontExists (string name)
 Used to check if a custom SpriteFont exists More...
 
sbyte GetAccessorySlot (string name, EquipType type)
 Same as GetEquipSlot, except returns the number as an sbyte (signed byte) for your convenience. More...
 
int GetBackgroundSlot (string name)
 Gets the texture slot corresponding to the specified texture name. Shorthand for calling BackgroundTextureLoader.GetBackgroundSlot(this.Name + '/' + name). More...
 
ModBuff GetBuff (string name)
 Gets the ModBuff of this mod corresponding to the given name. Returns null if no ModBuff with the given name is found. More...
 
GetBuff< T > ()
 
ModConfig GetConfig (string name)
 
GetConfig< T > ()
 
ModDust GetDust (string name)
 Gets the ModDust of this mod corresponding to the given name. Returns null if no ModDust with the given name is found. More...
 
GetDust< T > ()
 Same as the other GetDust, but assumes that the class name and internal name are the same. More...
 
Effect GetEffect (string name)
 Gets an Effect loaded from the specified path. More...
 
int GetEquipSlot (string name, EquipType type)
 Gets the slot/ID of the equipment texture corresponding to the given name. Returns -1 if no EquipTexture with the given name is found. More...
 
EquipTexture GetEquipTexture (string name, EquipType type)
 Gets the EquipTexture instance corresponding to the name and EquipType. Returns null if no EquipTexture with the given name and EquipType is found. More...
 
byte[] GetFileBytes (string name)
 Retrieve contents of files within the tmod file More...
 
Stream GetFileStream (string name, bool newFileStream=false)
 Retrieve contents of files within the tmod file More...
 
DynamicSpriteFont GetFont (string name)
 Gets a SpriteFont loaded from the specified path. More...
 
GlobalBgStyle GetGlobalBgStyle (string name)
 Returns the global background style corresponding to the given name. More...
 
GetGlobalBgStyle< T > ()
 
GlobalBuff GetGlobalBuff (string name)
 Gets the GlobalBuff with the given name from this mod. More...
 
GetGlobalBuff< T > ()
 
GlobalItem GetGlobalItem (string name)
 Gets the GlobalItem instance with the given name from this mod. More...
 
GetGlobalItem< T > ()
 Same as the other GetGlobalItem, but assumes that the class name and internal name are the same. More...
 
GlobalNPC GetGlobalNPC (string name)
 Gets the GlobalNPC instance with the given name from this mod. More...
 
GetGlobalNPC< T > ()
 
GlobalProjectile GetGlobalProjectile (string name)
 Gets the GlobalProjectile instance with the given name from this mod. More...
 
GetGlobalProjectile< T > ()
 
GlobalRecipe GetGlobalRecipe (string name)
 Gets the global recipe corresponding to the specified name. More...
 
GetGlobalRecipe< T > ()
 
GlobalTile GetGlobalTile (string name)
 Gets the GlobalTile instance with the given name from this mod. More...
 
GetGlobalTile< T > ()
 Same as the other GetGlobalTile, but assumes that the class name and internal name are the same. More...
 
GlobalWall GetGlobalWall (string name)
 Gets the GlobalWall instance with the given name from this mod. More...
 
GetGlobalWall< T > ()
 
int GetGoreSlot (string name)
 Shorthand for calling ModGore.GetGoreSlot(this.Name + '/' + name). More...
 
int GetGoreSlot< T > ()
 Same as the other GetGoreSlot, but assumes that the class name and internal name are the same. More...
 
ModItem GetItem (string name)
 Gets the ModItem instance corresponding to the name. Because this method is in the Mod class, conflicts between mods are avoided. Returns null if no ModItem with the given name is found. More...
 
GetItem< T > ()
 Same as the other GetItem, but assumes that the class name and internal name are the same. More...
 
LegacySoundStyle GetLegacySoundSlot (SoundType type, string name)
 Shorthand for calling SoundLoader.GetLegacySoundSlot(type, this.Name + '/' + name). More...
 
ModWorld GetModWorld (string name)
 Gets the ModWorld instance with the given name from this mod. More...
 
GetModWorld< T > ()
 Same as the other GetModWorld, but assumes that the class name and internal name are the same. More...
 
ModMountData GetMount (string name)
 Gets the ModMountData instance of this mod corresponding to the given name. Returns null if no ModMountData has the given name. More...
 
GetMount< T > ()
 
Music GetMusic (string name)
 Shorthand for calling ModContent.GetMusic(this.FileName(name)). More...
 
ModNPC GetNPC (string name)
 Gets the ModNPC of this mod corresponding to the given name. Returns null if no ModNPC with the given name is found. More...
 
GetNPC< T > ()
 
ModPacket GetPacket (int capacity=256)
 Creates a ModPacket object that you can write to and then send between servers and clients. More...
 
ModPlayer GetPlayer (string name)
 Gets the ModPlayer of this mod corresponding to the given name. Returns null if no ModPlayer with the given name is found. More...
 
GetPlayer< T > ()
 
ModPrefix GetPrefix (string name)
 Gets the ModPrefix instance corresponding to the name. Because this method is in the Mod class, conflicts between mods are avoided. Returns null if no ModPrefix with the given name is found. More...
 
GetPrefix< T > ()
 Same as the other GetPrefix, but assumes that the class name and internal name are the same. More...
 
ModProjectile GetProjectile (string name)
 Gets the ModProjectile of this mod corresponding to the given name. Returns null if no ModProjectile with the given name is found. More...
 
GetProjectile< T > ()
 
SoundEffect GetSound (string name)
 Shorthand for calling ModContent.GetSound(this.FileName(name)). More...
 
int GetSoundSlot (SoundType type, string name)
 Shorthand for calling SoundLoader.GetSoundSlot(type, this.Name + '/' + name). More...
 
ModSurfaceBgStyle GetSurfaceBgStyle (string name)
 Returns the surface background style corresponding to the given name. More...
 
GetSurfaceBgStyle< T > ()
 
int GetSurfaceBgStyleSlot (string name)
 Returns the Slot of the surface background style corresponding to the given name. More...
 
int GetSurfaceBgStyleSlot< T > ()
 
Texture2D GetTexture (string name)
 Shorthand for calling ModContent.GetTexture(this.FileName(name)). More...
 
ModTile GetTile (string name)
 Gets the ModTile of this mod corresponding to the given name. Returns null if no ModTile with the given name is found. More...
 
GetTile< T > ()
 Same as the other GetTile, but assumes that the class name and internal name are the same. More...
 
ModTileEntity GetTileEntity (string name)
 Gets the ModTileEntity of this mod corresponding to the given name. Returns null if no ModTileEntity with the given name is found. More...
 
GetTileEntity< T > ()
 Same as the other GetTileEntity, but assumes that the class name and internal name are the same. More...
 
ModUgBgStyle GetUgBgStyle (string name)
 Returns the underground background style corresponding to the given name. More...
 
GetUgBgStyle< T > ()
 
ModWall GetWall (string name)
 Gets the ModWall of this mod corresponding to the given name. Returns null if no ModWall with the given name is found. More...
 
GetWall< T > ()
 
ModWaterfallStyle GetWaterfallStyle (string name)
 Returns the waterfall style with the given name from this mod. More...
 
GetWaterfallStyle< T > ()
 
int GetWaterfallStyleSlot (string name)
 Returns the waterfall style corresponding to the given name. More...
 
int GetWaterfallStyleSlot< T > ()
 
ModWaterStyle GetWaterStyle (string name)
 Returns the water style with the given name from this mod. More...
 
GetWaterStyle< T > ()
 
virtual void HandlePacket (BinaryReader reader, int whoAmI)
 Called whenever a net message / packet is received from a client (if this is a server) or the server (if this is a client). whoAmI is the ID of whomever sent the packet (equivalent to the Main.myPlayer of the sender), and reader is used to read the binary data of the packet. More...
 
virtual bool HijackGetData (ref byte messageType, ref BinaryReader reader, int playerNumber)
 Allows you to modify net message / packet information that is received before the game can act on it. More...
 
virtual bool HijackSendData (int whoAmI, int msgType, int remoteClient, int ignoreClient, NetworkText text, int number, float number2, float number3, float number4, int number5, int number6, int number7)
 Hijacks the send data method. Only use if you absolutely know what you are doing. If any hooks return true, the message is not sent. More...
 
virtual void HotKeyPressed (string name)
 Called when a hotkey is pressed. Check against the name to verify particular hotkey that was pressed. (Using the ModHotKey is more recommended.) More...
 
int ItemType (string name)
 Gets the internal ID / type of the ModItem corresponding to the name. Returns 0 if no ModItem with the given name is found. More...
 
int ItemType< T > ()
 Same as the other ItemType, but assumes that the class name and internal name are the same. More...
 
virtual void Load ()
 Override this method to add most of your content to your mod. Here you will call other methods such as AddItem. This is guaranteed to be called after all content has been autoloaded. More...
 
virtual bool LoadResource (string path, int length, Func< Stream > getStream)
 Hook for pre-loading resources More...
 
virtual void LoadResourceFromStream (string path, int len, BinaryReader reader)
 
virtual void LoadResources ()
 
virtual void MidUpdateDustTime ()
 Called after Dust got updated, but before Time (day/night, events, etc.) gets updated. More...
 
virtual void MidUpdateGoreProjectile ()
 Called after Gores got updated, but before any Projectiles get updated. More...
 
virtual void MidUpdateInvasionNet ()
 Called after Invasions got updated. The only thing that is updated after this is the Network. More...
 
virtual void MidUpdateItemDust ()
 Called after Items got updated, but before any Dust gets updated. More...
 
virtual void MidUpdateNPCGore ()
 Called after NPCs got updated, but before any Gores get updated. More...
 
virtual void MidUpdatePlayerNPC ()
 Called after Players got updated, but before any NPCs get updated. More...
 
virtual void MidUpdateProjectileItem ()
 Gets called immediately after all Projectiles are updated, but before any Items get updated. More...
 
virtual void MidUpdateTimeWorld ()
 Called after Time got updated, but before the World gets updated. More...
 
virtual void ModifyInterfaceLayers (List< GameInterfaceLayer > layers)
 Allows you to modify the elements of the in-game interface that get drawn. GameInterfaceLayer can be found in the Terraria.UI namespace. Check https://github.com/tModLoader/tModLoader/wiki/Vanilla-Interface-layers-values for vanilla interface layer names More...
 
virtual void ModifyLightingBrightness (ref float scale)
 Allows you to modify overall brightness of lights. Can be used to create effects similiar to what night vision and darkness (de)buffs give you. Values too high or too low might result in glitches. For night vision effect use scale 1.03 More...
 
virtual void ModifySunLightColor (ref Color tileColor, ref Color backgroundColor)
 Allows you to modify color of light the sun emits. More...
 
virtual void ModifyTransformMatrix (ref SpriteViewMatrix Transform)
 Allows you to set the transformation of the screen that is drawn. (Translations, rotations, scales, etc.) More...
 
int MountType (string name)
 Gets the ID of the ModMountData instance corresponding to the given name. Returns 0 if no ModMountData has the given name. More...
 
int MountType< T > ()
 Same as the other MountType, but assumes that the class name and internal name are the same. More...
 
bool MusicExists (string name)
 Shorthand for calling ModLoader.MusicExists(this.FileName(name)). More...
 
int NPCType (string name)
 Gets the type of the ModNPC of this mod with the given name. Returns 0 if no ModNPC with the given name is found. More...
 
int NPCType< T > ()
 Same as the other NPCType, but assumes that the class name and internal name are the same. More...
 
virtual void PostAddRecipes ()
 This provides a hook into the mod-loading process immediately after recipes have been added. You can use this to edit recipes added by other mods. More...
 
virtual void PostDrawFullscreenMap (ref string mouseText)
 Called while the fullscreen map is active. Allows custom drawing to the map. More...
 
virtual void PostDrawInterface (SpriteBatch spriteBatch)
 Called after interface is drawn but right before mouse and mouse hover text is drawn. Allows for drawing interface. More...
 
virtual void PostSetupContent ()
 Allows you to load things in your mod after its content has been setup (arrays have been resized to fit the content, etc). More...
 
virtual void PostUpdateEverything ()
 Called after the Network got updated, this is the last hook that happens in an update. More...
 
virtual void PostUpdateInput ()
 Called after the input keys are polled. Allows for modifying things like scroll wheel if your custom drawing should capture that. More...
 
byte PrefixType (string name)
 Gets the internal ID / type of the ModPrefix corresponding to the name. Returns 0 if no ModPrefix with the given name is found. More...
 
byte PrefixType< T > ()
 Same as the other PrefixType, but assumes that the class name and internal name are the same. More...
 
virtual void PreSaveAndQuit ()
 Called in SP or Client when the Save and Quit button is pressed. One use for this hook is clearing out custom UI slots to return items to the player. More...
 
virtual void PreUpdateEntities ()
 Use this if you want to do something before anything in the World gets updated. Called after UI updates, but before anything in the World (Players, NPCs, Projectiles, Tiles) gets updated. More...
 
int ProjectileType (string name)
 Gets the type of the ModProjectile of this mod with the given name. Returns 0 if no ModProjectile with the given name is found. More...
 
int ProjectileType< T > ()
 Same as the other ProjectileType, but assumes that the class name and internal name are the same. More...
 
ModHotKey RegisterHotKey (string name, string defaultKey)
 Registers a hotkey with a name and defaultKey. Use the returned ModHotKey to detect when buttons are pressed. Do this in a ModPlayer.ProcessTriggers. More...
 
bool SoundExists (string name)
 Shorthand for calling ModLoader.SoundExists(this.FileName(name)). More...
 
bool TextureExists (string name)
 Shorthand for calling ModLoader.TextureExists(this.FileName(name)). More...
 
int TileEntityType (string name)
 Gets the type of the ModTileEntity of this mod with the given name. Returns -1 if no ModTileEntity with the given name is found. More...
 
int TileEntityType< T > ()
 Same as the other TileEntityType, but assumes that the class name and internal name are the same. More...
 
int TileType (string name)
 Gets the type of the ModTile of this mod with the given name. Returns 0 if no ModTile with the given name is found. More...
 
int TileType< T > ()
 Same as the other TileType, but assumes that the class name and internal name are the same. More...
 
virtual void Unload ()
 This is called whenever this mod is unloaded from the game. Use it to undo changes that you've made in Load that aren't automatically handled (for example, modifying the texture of a vanilla item). Mods are guaranteed to be unloaded in the reverse order they were loaded in. More...
 
virtual void UpdateMusic (ref int music, ref MusicPriority priority)
 Allows you to determine what music should currently play. More...
 
virtual void UpdateMusic (ref int music)
 A legacy hook that you should no longer use. Use the version with two parameters instead. More...
 
virtual void UpdateUI (GameTime gameTime)
 Ran every update and suitable for calling Update for UserInterface classes More...
 
int WallType (string name)
 Gets the type of the ModWall of this mod with the given name. Returns 0 if no ModWall with the given name is found. More...
 
int WallType< T > ()
 Same as the other WallType, but assumes that the class name and internal name are the same. More...
 

Public Attributes

bool IsNetSynced => netID >= 0
 
virtual string Name => File.name
 Stores the name of the mod. This name serves as the mod's identification, and also helps with saving everything your mod adds. By default this returns the name of the folder that contains all your code and stuff. More...
 
virtual Version Version => File.version
 This version number of this mod. More...
 

Properties

Assembly Code [get, set]
 The assembly code this is loaded when tModLoader loads this mod. More...
 
string DisplayName [get, set]
 The display name of this mod in the Mods menu. More...
 
ILog Logger [get, set]
 A logger with this mod's name for easy logging. More...
 
ModProperties Properties [get, protected set]
 
ModSide Side = ModProperties.AutoLoadAll [get, set]
 The ModSide that controls how this mod is synced between client and server. More...
 
Version tModLoaderVersion [get, set]
 The version of tModLoader that was being used when this mod was built. More...
 

Private Member Functions

void AutoloadBackgrounds ()
 
void AutoloadBuff (Type type)
 
void AutoloadCommand (Type type)
 
void AutoloadDust (Type type)
 
void AutoloadGlobalBgStyle (Type type)
 
void AutoloadGlobalBuff (Type type)
 
void AutoloadGlobalItem (Type type)
 
void AutoloadGlobalNPC (Type type)
 
void AutoloadGlobalProjectile (Type type)
 
void AutoloadGlobalRecipe (Type type)
 
void AutoloadGlobalTile (Type type)
 
void AutoloadGlobalWall (Type type)
 
void AutoloadGores (IList< Type > modGores)
 
void AutoloadItem (Type type)
 
void AutoloadLocalization ()
 Loads .lang files More...
 
void AutoloadModWorld (Type type)
 
void AutoloadMountData (Type type)
 
void AutoloadNPC (Type type)
 
void AutoloadPlayer (Type type)
 
void AutoloadPrefix (Type type)
 
void AutoloadProjectile (Type type)
 
void AutoloadSounds (IList< Type > modSounds)
 
void AutoloadSurfaceBgStyle (Type type)
 
void AutoloadTile (Type type)
 
void AutoloadTileEntity (Type type)
 
void AutoloadUgBgStyle (Type type)
 
void AutoloadWall (Type type)
 
void AutoloadWaterfallStyle (Type type)
 
void AutoloadWaterStyle (Type type)
 
Music LoadMusic (string path, string extension)
 
bool LoadResourceLegacy (string path, int length, Func< Stream > getStream)
 
SoundEffect LoadSound (Stream stream, int length, string extension)
 
void LoadTexture (string path, Stream stream, bool rawimg)
 

Private Attributes

readonly Queue< Task > AsyncLoadQueue = new Queue<Task>()
 
IDisposable fileHandle
 

Detailed Description

Mod is an abstract class that you will override. It serves as a central place from which the mod's contents are stored. It provides methods for you to use or override.

Definition at line 23 of file Mod.cs.

Member Function Documentation

void Terraria.ModLoader.Mod.AddBackgroundTexture ( string  texture)

Adds a texture to the list of background textures and assigns it a background texture slot.

Parameters
textureThe texture.

Definition at line 1330 of file Mod.cs.

References Terraria.ModLoader.BackgroundTextureLoader.GetBackgroundSlot(), and Terraria.ModLoader.ModContent.GetTexture().

1330  {
1331  if (!loading)
1332  throw new Exception("AddBackgroundTexture can only be called from Mod.Load or Mod.Autoload");
1333 
1334  BackgroundTextureLoader.backgrounds[texture] = BackgroundTextureLoader.ReserveBackgroundSlot();
1335  ModContent.GetTexture(texture);
1336  }

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AddBossHeadTexture ( string  texture,
int  npcType = -1 
)

Assigns a head texture that can be used by NPCs on the map.

Parameters
textureThe texture.
npcTypeAn optional npc id for NPCID.Sets.BossHeadTextures

Definition at line 891 of file Mod.cs.

References Terraria.ModLoader.ModContent.GetTexture().

891  {
892  if (!loading)
893  throw new Exception("AddBossHeadTexture can only be called from Mod.Load or Mod.Autoload");
894 
895  int slot = NPCHeadLoader.ReserveBossHeadSlot(texture);
896  NPCHeadLoader.bossHeads[texture] = slot;
897  ModContent.GetTexture(texture);
898  if (npcType >= 0) {
899  NPCHeadLoader.npcToBossHead[npcType] = slot;
900  }
901  }

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AddBuff ( string  name,
ModBuff  buff,
string  texture 
)

Adds a type of buff to the game with the specified internal name and texture.

Parameters
nameThe name.
buffThe buff.
textureThe texture.

Definition at line 934 of file Mod.cs.

References Terraria.ModLoader.ModBuff.Description, Terraria.ModLoader.ModBuff.DisplayName, Terraria.ModLoader.ModBuff.mod, Terraria.ModLoader.ModBuff.Name, and Terraria.ModLoader.ModBuff.Type.

934  {
935  if (!loading)
936  throw new Exception("AddBuff can only be called from Mod.Load or Mod.Autoload");
937 
938  if (buffs.ContainsKey(name))
939  throw new Exception("You tried to add 2 ModBuff with the same name: " + name + ". Maybe 2 classes share a classname but in different namespaces while autoloading or you manually called AddBuff with 2 buffs of the same name.");
940 
941  buff.mod = this;
942  buff.Name = name;
943  buff.Type = BuffLoader.ReserveBuffID();
944  buff.texture = texture;
945  buff.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.BuffName.{1}", Name, name));
946  buff.Description = GetOrCreateTranslation(string.Format("Mods.{0}.BuffDescription.{1}", Name, name));
947 
948  buffs[name] = buff;
949  BuffLoader.buffs.Add(buff);
950  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void Terraria.ModLoader.Mod.AddCommand ( string  name,
ModCommand  mc 
)

Manually add a Command during Load

Definition at line 1373 of file Mod.cs.

References Terraria.ModLoader.ModCommand.mod, and Terraria.ModLoader.ModCommand.Name.

1373  {
1374  if (!loading)
1375  throw new Exception("AddCommand can only be called from Mod.Load or Mod.Autoload");
1376 
1377  mc.mod = this;
1378  mc.Name = name;
1379  CommandManager.Add(mc);
1380  }
void Terraria.ModLoader.Mod.AddConfig ( string  name,
ModConfig  mc 
)
void Terraria.ModLoader.Mod.AddDust ( string  name,
ModDust  dust,
string  texture = "" 
)

Adds a type of dust to your mod with the specified name. Create an instance of ModDust normally, preferably through the constructor of an overriding class. Leave the texture as an empty string to use the vanilla dust sprite sheet.

Parameters
nameThe name.
dustThe dust.
textureThe texture.

Definition at line 471 of file Mod.cs.

References Terraria.ModLoader.ModContent.GetTexture(), Terraria.ModLoader.ModDust.mod, Terraria.ModLoader.ModDust.Name, Terraria.ModLoader.ModDust.Texture, and Terraria.ModLoader.ModDust.Type.

471  {
472  if (!loading)
473  throw new Exception("AddDust can only be called from Mod.Load or Mod.Autoload");
474 
475  dust.mod = this;
476  dust.Name = name;
477  dust.Type = ModDust.ReserveDustID();
478  dust.Texture = !string.IsNullOrEmpty(texture) ? ModContent.GetTexture(texture) : Main.dustTexture;
479 
480  dusts[name] = dust;
481  ModDust.dusts.Add(dust);
482  }

+ Here is the call graph for this function:

int Terraria.ModLoader.Mod.AddEquipTexture ( ModItem  item,
EquipType  type,
string  name,
string  texture,
string  armTexture = "",
string  femaleTexture = "" 
)

Adds an equipment texture of the specified type, internal name, and associated item to your mod. (The item parameter may be null if you don't want to associate an item with the texture.) You can then get the ID for your texture by calling EquipLoader.GetEquipTexture, and using the EquipTexture's Slot property. If the EquipType is EquipType.Body, make sure that you also provide an armTexture and a femaleTexture. Returns the ID / slot that is assigned to the equipment texture.

Parameters
itemThe item.
typeThe type.
nameThe name.
textureThe texture.
armTextureThe arm texture (for body slots).
femaleTextureThe female texture (for body slots), if missing the regular body texture is used.
Returns

Definition at line 334 of file Mod.cs.

335  {
336  return AddEquipTexture(new EquipTexture(), item, type, name, texture, armTexture, femaleTexture);
337  }
int AddEquipTexture(ModItem item, EquipType type, string name, string texture, string armTexture="", string femaleTexture="")
Adds an equipment texture of the specified type, internal name, and associated item to your mod...
Definition: Mod.cs:334
int Terraria.ModLoader.Mod.AddEquipTexture ( EquipTexture  equipTexture,
ModItem  item,
EquipType  type,
string  name,
string  texture,
string  armTexture = "",
string  femaleTexture = "" 
)

Adds an equipment texture of the specified type, internal name, and associated item to your mod. This method is different from the other AddEquipTexture in that you can specify the class of the equipment texture, thus allowing you to override EquipmentTexture's hooks. All other parameters are the same as the other AddEquipTexture.

Parameters
equipTextureThe equip texture.
itemThe item.
typeThe type.
nameThe name.
textureThe texture.
armTextureThe arm texture (for body slots).
femaleTextureThe female texture (for body slots), if missing the regular body texture is used.
Returns

Definition at line 352 of file Mod.cs.

References Terraria.ModLoader.ModContent.GetTexture(), Terraria.ModLoader.ModItem.item, Terraria.ModLoader.EquipTexture.item, Terraria.ModLoader.EquipTexture.mod, Terraria.ModLoader.EquipTexture.Name, Terraria.ModLoader.EquipTexture.Slot, Terraria.ModLoader.EquipTexture.Texture, Terraria.ModLoader.ModContent.TextureExists(), and Terraria.ModLoader.EquipTexture.Type.

353  {
354  if (!loading)
355  throw new Exception("AddEquipTexture can only be called from Mod.Load or Mod.Autoload");
356 
357  ModContent.GetTexture(texture); //ensure texture exists
358 
359  equipTexture.Texture = texture;
360  equipTexture.mod = this;
361  equipTexture.Name = name;
362  equipTexture.Type = type;
363  equipTexture.item = item;
364  int slot = equipTexture.Slot = EquipLoader.ReserveEquipID(type);
365 
366  EquipLoader.equipTextures[type][slot] = equipTexture;
367  equipTextures[Tuple.Create(name, type)] = equipTexture;
368 
369  if (type == EquipType.Body) {
370  if (femaleTexture == null || !ModContent.TextureExists(femaleTexture))
371  femaleTexture = texture;
372  EquipLoader.femaleTextures[slot] = femaleTexture;
373 
374  ModContent.GetTexture(armTexture); //ensure texture exists
375  EquipLoader.armTextures[slot] = armTexture;
376  }
377  if (item != null) {
378  IDictionary<EquipType, int> slots;
379  if (!EquipLoader.idToSlot.TryGetValue(item.item.type, out slots))
380  EquipLoader.idToSlot[item.item.type] = slots = new Dictionary<EquipType, int>();
381 
382  slots[type] = slot;
383  if (type == EquipType.Head || type == EquipType.Body || type == EquipType.Legs)
384  EquipLoader.slotToId[type][slot] = item.item.type;
385  }
386  return slot;
387  }
EquipType
This is an enum of all the types of equipment that exist. An equipment type is defined as a type or l...
Definition: EquipType.cs:6

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AddGlobalBgStyle ( string  name,
GlobalBgStyle  globalBgStyle 
)

Adds the given global background style with the given name to this mod.

Parameters
nameThe name.
globalBgStyleThe global bg style.

Definition at line 1176 of file Mod.cs.

References Terraria.ModLoader.GlobalBgStyle.mod, and Terraria.ModLoader.GlobalBgStyle.Name.

1176  {
1177  if (!loading)
1178  throw new Exception("AddGlobalBgStyle can only be called from Mod.Load or Mod.Autoload");
1179 
1180  globalBgStyle.mod = this;
1181  globalBgStyle.Name = name;
1182 
1183  globalBgStyles[name] = globalBgStyle;
1184  GlobalBgStyleLoader.globalBgStyles.Add(globalBgStyle);
1185  }
void Terraria.ModLoader.Mod.AddGlobalBuff ( string  name,
GlobalBuff  globalBuff 
)

Adds the given GlobalBuff instance to this mod using the provided name.

Parameters
nameThe name.
globalBuffThe global buff.

Definition at line 980 of file Mod.cs.

References Terraria.ModLoader.GlobalBuff.mod, and Terraria.ModLoader.GlobalBuff.Name.

980  {
981  globalBuff.mod = this;
982  globalBuff.Name = name;
983 
984  globalBuffs[name] = globalBuff;
985  BuffLoader.globalBuffs.Add(globalBuff);
986  }
void Terraria.ModLoader.Mod.AddGlobalItem ( string  name,
GlobalItem  globalItem 
)

Adds the given GlobalItem instance to this mod with the provided name.

Parameters
nameThe name.
globalItemThe global item.

Definition at line 285 of file Mod.cs.

References Terraria.ModLoader.GlobalItem.mod, and Terraria.ModLoader.GlobalItem.Name.

285  {
286  if (!loading)
287  throw new Exception("AddGlobalItem can only be called from Mod.Load or Mod.Autoload");
288 
289  ItemLoader.VerifyGlobalItem(globalItem);
290 
291  globalItem.mod = this;
292  globalItem.Name = name;
293 
294  globalItems[name] = globalItem;
295  globalItem.index = ItemLoader.globalItems.Count;
296  ItemLoader.globalIndexes[Name + ':' + name] = ItemLoader.globalItems.Count;
297  if (ItemLoader.globalIndexesByType.ContainsKey(globalItem.GetType())) {
298  ItemLoader.globalIndexesByType[globalItem.GetType()] = -1;
299  }
300  else {
301  ItemLoader.globalIndexesByType[globalItem.GetType()] = ItemLoader.globalItems.Count;
302  }
303  ItemLoader.globalItems.Add(globalItem);
304  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void Terraria.ModLoader.Mod.AddGlobalNPC ( string  name,
GlobalNPC  globalNPC 
)

Adds the given GlobalNPC instance to this mod with the provided name.

Parameters
nameThe name.
globalNPCThe global NPC.

Definition at line 833 of file Mod.cs.

References Terraria.ModLoader.GlobalNPC.mod, and Terraria.ModLoader.GlobalNPC.Name.

833  {
834  if (!loading)
835  throw new Exception("AddGlobalNPC can only be called from Mod.Load or Mod.Autoload");
836 
837  NPCLoader.VerifyGlobalNPC(globalNPC);
838 
839  globalNPC.mod = this;
840  globalNPC.Name = name;
841 
842  globalNPCs[name] = globalNPC;
843  globalNPC.index = NPCLoader.globalNPCs.Count;
844  NPCLoader.globalIndexes[Name + ':' + name] = NPCLoader.globalNPCs.Count;
845  if (NPCLoader.globalIndexesByType.ContainsKey(globalNPC.GetType())) {
846  NPCLoader.globalIndexesByType[globalNPC.GetType()] = -1;
847  }
848  else {
849  NPCLoader.globalIndexesByType[globalNPC.GetType()] = NPCLoader.globalNPCs.Count;
850  }
851  NPCLoader.globalNPCs.Add(globalNPC);
852  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void Terraria.ModLoader.Mod.AddGlobalProjectile ( string  name,
GlobalProjectile  globalProjectile 
)

Adds the given GlobalProjectile instance to this mod with the provided name.

Parameters
nameThe name.
globalProjectileThe global projectile.

Definition at line 754 of file Mod.cs.

References Terraria.ModLoader.GlobalProjectile.mod, and Terraria.ModLoader.GlobalProjectile.Name.

754  {
755  if (!loading)
756  throw new Exception("AddGlobalProjectile can only be called from Mod.Load or Mod.Autoload");
757 
758  ProjectileLoader.VerifyGlobalProjectile(globalProjectile);
759 
760  globalProjectile.mod = this;
761  globalProjectile.Name = name;
762 
763  globalProjectiles[name] = globalProjectile;
764  globalProjectile.index = ProjectileLoader.globalProjectiles.Count;
765  ProjectileLoader.globalIndexes[Name + ':' + name] = ProjectileLoader.globalProjectiles.Count;
766  if (ProjectileLoader.globalIndexesByType.ContainsKey(globalProjectile.GetType())) {
767  ProjectileLoader.globalIndexesByType[globalProjectile.GetType()] = -1;
768  }
769  else {
770  ProjectileLoader.globalIndexesByType[globalProjectile.GetType()] = ProjectileLoader.globalProjectiles.Count;
771  }
772  ProjectileLoader.globalProjectiles.Add(globalProjectile);
773  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void Terraria.ModLoader.Mod.AddGlobalRecipe ( string  name,
GlobalRecipe  globalRecipe 
)

Manually add a Global Recipe during Load

Parameters
nameThe name.
globalRecipeThe global recipe.

Definition at line 1350 of file Mod.cs.

References Terraria.ModLoader.GlobalRecipe.mod, and Terraria.ModLoader.GlobalRecipe.Name.

1350  {
1351  if (!loading)
1352  throw new Exception("AddGlobalRecipe can only be called from Mod.Load or Mod.Autoload");
1353 
1354  globalRecipe.mod = this;
1355  globalRecipe.Name = name;
1356 
1357  globalRecipes[name] = globalRecipe;
1358  RecipeHooks.Add(globalRecipe);
1359  }
void Terraria.ModLoader.Mod.AddGlobalTile ( string  name,
GlobalTile  globalTile 
)

Adds the given GlobalTile instance to this mod with the provided name.

Parameters
nameThe name.
globalTileThe global tile.

Definition at line 567 of file Mod.cs.

References Terraria.ModLoader.GlobalTile.mod, and Terraria.ModLoader.GlobalTile.Name.

567  {
568  if (!loading)
569  throw new Exception("AddGlobalTile can only be called from Mod.Load or Mod.Autoload");
570 
571  globalTile.mod = this;
572  globalTile.Name = name;
573 
574  globalTiles[name] = globalTile;
575  TileLoader.globalTiles.Add(globalTile);
576  }
void Terraria.ModLoader.Mod.AddGlobalWall ( string  name,
GlobalWall  globalWall 
)

Adds the given GlobalWall instance to this mod with the provided name.

Parameters
nameThe name.
globalWallThe global wall.

Definition at line 685 of file Mod.cs.

References Terraria.ModLoader.GlobalWall.mod, and Terraria.ModLoader.GlobalWall.Name.

685  {
686  if (!loading)
687  throw new Exception("AddGlobalWall can only be called from Mod.Load or Mod.Autoload");
688 
689  globalWall.mod = this;
690  globalWall.Name = name;
691 
692  globalWalls[name] = globalWall;
693  WallLoader.globalWalls.Add(globalWall);
694  }
void Terraria.ModLoader.Mod.AddGore ( string  texture,
ModGore  modGore = null 
)

Adds the given texture to the game as a custom gore, with the given custom gore behavior. If no custom gore behavior is provided, the custom gore will have the default vanilla behavior.

Parameters
textureThe texture.
modGoreThe mod gore.

Definition at line 1268 of file Mod.cs.

References Terraria.ModLoader.ModGore.GetGoreSlot().

1268  {
1269  if (!loading)
1270  throw new Exception("AddGore can only be called from Mod.Load or Mod.Autoload");
1271 
1272  int id = ModGore.ReserveGoreID();
1273  ModGore.gores[texture] = id;
1274  if (modGore != null) {
1275  ModGore.modGores[id] = modGore;
1276  }
1277  }

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AddItem ( string  name,
ModItem  item 
)

Adds a type of item to your mod with the specified internal name. This method should be called in Load. You can obtain an instance of ModItem by overriding it then creating an instance of the subclass.

Parameters
nameThe name.
itemThe item.
Exceptions
System.ExceptionYou tried to add 2 ModItems with the same name: " + name + ". Maybe 2 classes share a classname but in different namespaces while autoloading or you manually called AddItem with 2 items of the same name.

Definition at line 233 of file Mod.cs.

References Terraria.ModLoader.ModItem.DisplayName, Terraria.ModLoader.ModItem.item, Terraria.ModLoader.ModItem.mod, Terraria.ModLoader.ModItem.Name, and Terraria.ModLoader.ModItem.Tooltip.

233  {
234  if (!loading)
235  throw new Exception(Language.GetTextValue("tModLoader.LoadErrorAddItemOnlyInLoad"));
236 
237  if (items.ContainsKey(name))
238  throw new Exception(Language.GetTextValue("tModLoader.LoadError2ModItemSameName", name));
239 
240  item.mod = this;
241  item.Name = name;
242  item.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.ItemName.{1}", Name, name));
243  item.Tooltip = GetOrCreateTranslation(string.Format("Mods.{0}.ItemTooltip.{1}", Name, name), true);
244 
245  item.item.ResetStats(ItemLoader.ReserveItemID());
246  item.item.modItem = item;
247 
248  items[name] = item;
249  ItemLoader.items.Add(item);
250  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void Terraria.ModLoader.Mod.AddModWorld ( string  name,
ModWorld  modWorld 
)

Adds a ModWorld to this mod with the given name.

Parameters
nameThe name.
modWorldThe mod world.

Definition at line 1085 of file Mod.cs.

References Terraria.ModLoader.ModWorld.mod, and Terraria.ModLoader.ModWorld.Name.

1085  {
1086  if (!loading)
1087  throw new Exception("AddModWorld can only be called from Mod.Load or Mod.Autoload");
1088 
1089  modWorld.mod = this;
1090  modWorld.Name = name;
1091 
1092  worlds[name] = modWorld;
1093  WorldHooks.Add(modWorld);
1094  }
void Terraria.ModLoader.Mod.AddMount ( string  name,
ModMountData  mount,
string  texture,
IDictionary< MountTextureType, string >  extraTextures = null 
)

Adds the given mount to the game with the given name and texture. The extraTextures dictionary should optionally map types of mount textures to the texture paths you want to include.

Parameters
nameThe name.
mountThe mount.
textureThe texture.
extraTexturesThe extra textures.

Definition at line 1004 of file Mod.cs.

References Terraria.ModLoader.ModContent.GetTexture(), Terraria.ModLoader.ModMountData.mod, Terraria.ModLoader.ModMountData.Name, Terraria.ModLoader.ModContent.TextureExists(), and Terraria.ModLoader.ModMountData.Type.

1005  {
1006  if (!loading)
1007  throw new Exception("AddMount can only be called from Mod.Load or Mod.Autoload");
1008 
1009  if (Mount.mounts == null || Mount.mounts.Length == MountID.Count)
1010  Mount.Initialize();
1011 
1012  mount.mod = this;
1013  mount.Name = name;
1014  mount.Type = MountLoader.ReserveMountID();
1015  mount.texture = texture;
1016 
1017  mountDatas[name] = mount;
1018  MountLoader.mountDatas[mount.Type] = mount;
1019 
1020  if (extraTextures == null)
1021  return;
1022 
1023  foreach (var entry in extraTextures) {
1024  if (!ModContent.TextureExists(entry.Value))
1025  continue;
1026 
1027  Texture2D extraTexture = ModContent.GetTexture(entry.Value);
1028  switch (entry.Key) {
1029  case MountTextureType.Back:
1030  mount.mountData.backTexture = extraTexture;
1031  break;
1032  case MountTextureType.BackGlow:
1033  mount.mountData.backTextureGlow = extraTexture;
1034  break;
1035  case MountTextureType.BackExtra:
1036  mount.mountData.backTextureExtra = extraTexture;
1037  break;
1038  case MountTextureType.BackExtraGlow:
1039  mount.mountData.backTextureExtraGlow = extraTexture;
1040  break;
1041  case MountTextureType.Front:
1042  mount.mountData.frontTexture = extraTexture;
1043  break;
1044  case MountTextureType.FrontGlow:
1045  mount.mountData.frontTextureGlow = extraTexture;
1046  break;
1047  case MountTextureType.FrontExtra:
1048  mount.mountData.frontTextureExtra = extraTexture;
1049  break;
1050  case MountTextureType.FrontExtraGlow:
1051  mount.mountData.frontTextureExtraGlow = extraTexture;
1052  break;
1053  }
1054  }
1055  }
MountTextureType
This is an enum of all possible types of extra mount textures for custom mounts. Use these as keys in...

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AddMusicBox ( int  musicSlot,
int  itemType,
int  tileType,
int  tileFrameY = 0 
)

Allows you to tie a music ID, and item ID, and a tile ID together to form a music box. When music with the given ID is playing, equipped music boxes have a chance to change their ID to the given item type. When an item with the given item type is equipped, it will play the music that has musicSlot as its ID. When a tile with the given type and Y-frame is nearby, if its X-frame is >= 36, it will play the music that has musicSlot as its ID.

Parameters
musicSlotThe music slot.
itemTypeType of the item.
tileTypeType of the tile.
tileFrameYThe tile frame y.
Exceptions
System.ArgumentOutOfRangeExceptionCannot assign music box to vanilla music ID " + musicSlot or Music ID " + musicSlot + " does not exist or Cannot assign music box to vanilla item ID " + itemType or Item ID " + itemType + " does not exist or Cannot assign music box to vanilla tile ID " + tileType or Tile ID " + tileType + " does not exist
System.ArgumentExceptionMusic ID " + musicSlot + " has already been assigned a music box or Item ID " + itemType + " has already been assigned a music or or Y-frame must be divisible by 36

Definition at line 1410 of file Mod.cs.

References Terraria.ModLoader.ItemLoader.GetItem(), Terraria.ModLoader.TileLoader.GetTile(), and Terraria.ModLoader.SoundLoader.SoundCount().

1410  {
1411  if (!loading)
1412  throw new Exception("AddMusicBox can only be called from Mod.Load or Mod.Autoload");
1413 
1414  if (Main.waveBank == null)
1415  return;
1416 
1417  if (musicSlot < Main.maxMusic) {
1418  throw new ArgumentOutOfRangeException("Cannot assign music box to vanilla music ID " + musicSlot);
1419  }
1420  if (musicSlot >= SoundLoader.SoundCount(SoundType.Music)) {
1421  throw new ArgumentOutOfRangeException("Music ID " + musicSlot + " does not exist");
1422  }
1423  if (itemType < ItemID.Count) {
1424  throw new ArgumentOutOfRangeException("Cannot assign music box to vanilla item ID " + itemType);
1425  }
1426  if (ItemLoader.GetItem(itemType) == null) {
1427  throw new ArgumentOutOfRangeException("Item ID " + itemType + " does not exist");
1428  }
1429  if (tileType < TileID.Count) {
1430  throw new ArgumentOutOfRangeException("Cannot assign music box to vanilla tile ID " + tileType);
1431  }
1432  if (TileLoader.GetTile(tileType) == null) {
1433  throw new ArgumentOutOfRangeException("Tile ID " + tileType + " does not exist");
1434  }
1435  if (SoundLoader.musicToItem.ContainsKey(musicSlot)) {
1436  throw new ArgumentException("Music ID " + musicSlot + " has already been assigned a music box");
1437  }
1438  if (SoundLoader.itemToMusic.ContainsKey(itemType)) {
1439  throw new ArgumentException("Item ID " + itemType + " has already been assigned a music");
1440  }
1441  if (!SoundLoader.tileToMusic.ContainsKey(tileType)) {
1442  SoundLoader.tileToMusic[tileType] = new Dictionary<int, int>();
1443  }
1444  if (SoundLoader.tileToMusic[tileType].ContainsKey(tileFrameY)) {
1445  string message = "Y-frame " + tileFrameY + " of tile type " + tileType + " has already been assigned a music";
1446  throw new ArgumentException(message);
1447  }
1448  if (tileFrameY % 36 != 0) {
1449  throw new ArgumentException("Y-frame must be divisible by 36");
1450  }
1451  SoundLoader.musicToItem[musicSlot] = itemType;
1452  SoundLoader.itemToMusic[itemType] = musicSlot;
1453  SoundLoader.tileToMusic[tileType][tileFrameY] = musicSlot;
1454  }
SoundType
This is an enum of the types of sound you can add to the game. This is used for determining whether a...
Definition: SoundType.cs:12

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AddNPC ( string  name,
ModNPC  npc 
)

Adds a type of NPC to the game with the specified name and texture. Also allows you to give the NPC alternate textures.

Parameters
nameThe name.
npcThe NPC.

Definition at line 789 of file Mod.cs.

References Terraria.ModLoader.ModNPC.DisplayName, Terraria.ModLoader.ModNPC.mod, Terraria.ModLoader.ModNPC.Name, and Terraria.ModLoader.ModNPC.npc.

789  {
790  if (!loading)
791  throw new Exception("AddNPC can only be called from Mod.Load or Mod.Autoload");
792 
793  if (npcs.ContainsKey(name))
794  throw new Exception("You tried to add 2 ModNPC with the same name: " + name + ". Maybe 2 classes share a classname but in different namespaces while autoloading or you manually called AddNPC with 2 npcs of the same name.");
795 
796  npc.mod = this;
797  npc.Name = name;
798  npc.npc.type = NPCLoader.ReserveNPCID();
799  npc.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.NPCName.{1}", Name, name));
800 
801  npcs[name] = npc;
802  NPCLoader.npcs.Add(npc);
803  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void Terraria.ModLoader.Mod.AddNPCHeadTexture ( int  npcType,
string  texture 
)

Assigns a head texture to the given town NPC type.

Parameters
npcTypeType of the NPC.
textureThe texture.
Exceptions
MissingResourceException

Definition at line 869 of file Mod.cs.

References Terraria.ModLoader.ModContent.GetTexture().

869  {
870  if (!loading)
871  throw new Exception("AddNPCHeadTexture can only be called from Mod.Load or Mod.Autoload");
872 
873  int slot = NPCHeadLoader.ReserveHeadSlot();
874  NPCHeadLoader.heads[texture] = slot;
875  if (!Main.dedServ) {
876  ModContent.GetTexture(texture);
877  }
878  /*else if (Main.dedServ && !(ModLoader.FileExists(texture + ".png") || ModLoader.FileExists(texture + ".rawimg")))
879  {
880  throw new MissingResourceException(texture);
881  }*/
882  NPCHeadLoader.npcToHead[npcType] = slot;
883  NPCHeadLoader.headToNPC[slot] = npcType;
884  }

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AddPlayer ( string  name,
ModPlayer  player 
)

Adds a type of ModPlayer to this mod. All ModPlayer types will be newly created and attached to each player that is loaded.

Parameters
nameThe name.
playerThe player.

Definition at line 908 of file Mod.cs.

References Terraria.ModLoader.ModPlayer.mod, and Terraria.ModLoader.ModPlayer.Name.

908  {
909  if (!loading)
910  throw new Exception("AddPlayer can only be called from Mod.Load or Mod.Autoload");
911 
912  player.mod = this;
913  player.Name = name;
914 
915  players[name] = player;
916  PlayerHooks.Add(player);
917  }
void Terraria.ModLoader.Mod.AddPrefix ( string  name,
ModPrefix  prefix 
)

Adds a prefix to your mod with the specified internal name. This method should be called in Load. You can obtain an instance of ModPrefix by overriding it then creating an instance of the subclass.

Parameters
nameThe name.
prefixThe prefix.
Exceptions
System.ExceptionYou tried to add 2 ModItems with the same name: " + name + ". Maybe 2 classes share a classname but in different namespaces while autoloading or you manually called AddItem with 2 items of the same name.

Definition at line 420 of file Mod.cs.

References Terraria.ModLoader.ModPrefix.Category, Terraria.ModLoader.ModPrefix.DisplayName, Terraria.ModLoader.ModPrefix.mod, Terraria.ModLoader.ModPrefix.Name, and Terraria.ModLoader.ModPrefix.Type.

420  {
421  if (!loading)
422  throw new Exception("AddPrefix can only be called from Mod.Load or Mod.Autoload");
423 
424  if (prefixes.ContainsKey(name))
425  throw new Exception("You tried to add 2 ModPrefixes with the same name: " + name + ". Maybe 2 classes share a classname but in different namespaces while autoloading or you manually called AddPrefix with 2 prefixes of the same name.");
426 
427  prefix.mod = this;
428  prefix.Name = name;
429  prefix.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.Prefix.{1}", Name, name));
430  prefix.Type = ModPrefix.ReservePrefixID();
431 
432  prefixes[name] = prefix;
433  ModPrefix.prefixes.Add(prefix);
434  ModPrefix.categoryPrefixes[prefix.Category].Add(prefix);
435  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void Terraria.ModLoader.Mod.AddProjectile ( string  name,
ModProjectile  projectile 
)

Adds a type of projectile to the game with the specified name.

Parameters
nameThe name.
projectileThe projectile.

Definition at line 710 of file Mod.cs.

References Terraria.ModLoader.ModProjectile.DisplayName, Terraria.ModLoader.ModProjectile.mod, Terraria.ModLoader.ModProjectile.Name, and Terraria.ModLoader.ModProjectile.projectile.

710  {
711  if (!loading)
712  throw new Exception("AddProjectile can only be called from Mod.Load or Mod.Autoload");
713 
714  if (projectiles.ContainsKey(name))
715  throw new Exception("You tried to add 2 ModProjectile with the same name: " + name + ". Maybe 2 classes share a classname but in different namespaces while autoloading or you manually called AddProjectile with 2 projectiles of the same name.");
716 
717  projectile.mod = this;
718  projectile.Name = name;
719  projectile.projectile.type = ProjectileLoader.ReserveProjectileID();
720  projectile.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.ProjectileName.{1}", Name, name));
721 
722  projectiles[name] = projectile;
723  ProjectileLoader.projectiles.Add(projectile);
724  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
virtual void Terraria.ModLoader.Mod.AddRecipeGroups ( )
virtual

Override this method to add recipe groups to this mod. You must add recipe groups by calling the RecipeGroup.RegisterGroup method here. A recipe group is a set of items that can be used interchangeably in the same recipe.

Definition at line 88 of file Mod.cs.

88  {
89  }
virtual void Terraria.ModLoader.Mod.AddRecipes ( )
virtual

Override this method to add recipes to the game. It is recommended that you do so through instances of ModRecipe, since it provides methods that simplify recipe creation.

Definition at line 94 of file Mod.cs.

94  {
95  }
void Terraria.ModLoader.Mod.AddSound ( SoundType  type,
string  soundPath,
ModSound  modSound = null 
)

Adds the given sound file to the game as the given type of sound and with the given custom sound playing. If no ModSound instance is provided, the custom sound will play in a similar manner as the default vanilla ones.

Parameters
typeThe type.
soundPathThe sound path.
modSoundThe mod sound.

Definition at line 1299 of file Mod.cs.

References Terraria.ModLoader.ModContent.GetSound(), and Terraria.ModLoader.SoundLoader.GetSoundSlot().

1299  {
1300  if (!loading)
1301  throw new Exception("AddSound can only be called from Mod.Load or Mod.Autoload");
1302  int id = SoundLoader.ReserveSoundID(type);
1303  SoundLoader.sounds[type][soundPath] = id;
1304  if (modSound != null) {
1305  SoundLoader.modSounds[type][id] = modSound;
1306  modSound.sound = ModContent.GetSound(soundPath);
1307  }
1308  }

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AddSurfaceBgStyle ( string  name,
ModSurfaceBgStyle  surfaceBgStyle 
)

Adds the given surface background style with the given name to this mod.

Parameters
nameThe name.
surfaceBgStyleThe surface bg style.

Definition at line 1141 of file Mod.cs.

References Terraria.ModLoader.ModSurfaceBgStyle.mod, Terraria.ModLoader.ModSurfaceBgStyle.Name, and Terraria.ModLoader.ModSurfaceBgStyle.Slot.

1141  {
1142  if (!loading)
1143  throw new Exception("AddSurfaceBgStyle can only be called from Mod.Load or Mod.Autoload");
1144 
1145  surfaceBgStyle.mod = this;
1146  surfaceBgStyle.Name = name;
1147  surfaceBgStyle.Slot = SurfaceBgStyleLoader.ReserveBackgroundSlot();
1148 
1149  surfaceBgStyles[name] = surfaceBgStyle;
1150  SurfaceBgStyleLoader.surfaceBgStyles.Add(surfaceBgStyle);
1151  }
void Terraria.ModLoader.Mod.AddTexture ( string  name,
Texture2D  texture 
)

Shorthand for calling ModLoader.AddTexture(this.FileName(name), texture).

Parameters
nameThe name.
textureThe texture.
Exceptions
Terraria.ModLoader.Exceptions.ModNameExceptionTexture already exist: " + name

Definition at line 1533 of file Mod.cs.

1533  {
1534  if (Main.dedServ)
1535  return;
1536 
1537  if (TextureExists(name))
1538  throw new Exception("Texture already exist: " + name);
1539 
1540  textures[name] = texture;
1541  }
bool TextureExists(string name)
Shorthand for calling ModLoader.TextureExists(this.FileName(name)).
void Terraria.ModLoader.Mod.AddTile ( string  name,
ModTile  tile,
string  texture 
)

Adds a type of tile to the game with the specified name and texture.

Parameters
nameThe name.
tileThe tile.
textureThe texture.

Definition at line 518 of file Mod.cs.

References Terraria.ModLoader.ModTile.mod, Terraria.ModLoader.ModTile.Name, and Terraria.ModLoader.ModTile.Type.

518  {
519  if (!loading)
520  throw new Exception("AddItem can only be called from Mod.Load or Mod.Autoload");
521 
522  if (tiles.ContainsKey(name))
523  throw new Exception("You tried to add 2 ModTile with the same name: " + name + ". Maybe 2 classes share a classname but in different namespaces while autoloading or you manually called AddTile with 2 tiles of the same name.");
524 
525  tile.mod = this;
526  tile.Name = name;
527  tile.Type = (ushort)TileLoader.ReserveTileID();
528  tile.texture = texture;
529 
530  tiles[name] = tile;
531  TileLoader.tiles.Add(tile);
532  }
void Terraria.ModLoader.Mod.AddTileEntity ( string  name,
ModTileEntity  entity 
)

Manually add a tile entity during Load.

Definition at line 595 of file Mod.cs.

References Terraria.ModLoader.ModTileEntity.mod, Terraria.ModLoader.ModTileEntity.Name, and Terraria.ModLoader.ModTileEntity.Type.

595  {
596  if (!loading)
597  throw new Exception("AddTileEntity can only be called from Mod.Load or Mod.Autoload");
598 
599  int id = ModTileEntity.ReserveTileEntityID();
600  entity.mod = this;
601  entity.Name = name;
602  entity.Type = id;
603  entity.type = (byte)id;
604 
605  tileEntities[name] = entity;
606  ModTileEntity.tileEntities.Add(entity);
607  }
void Terraria.ModLoader.Mod.AddTranslation ( ModTranslation  translation)

Adds a ModTranslation to the game so that you can use Language.GetText to get a LocalizedText.

Definition at line 1479 of file Mod.cs.

References Terraria.ModLoader.ModTranslation.Key.

1479  {
1480  translations[translation.Key] = translation;
1481  }
void Terraria.ModLoader.Mod.AddUgBgStyle ( string  name,
ModUgBgStyle  ugBgStyle 
)

Adds the given underground background style with the given name to this mod.

Parameters
nameThe name.
ugBgStyleThe ug bg style.

Definition at line 1115 of file Mod.cs.

References Terraria.ModLoader.ModUgBgStyle.mod, Terraria.ModLoader.ModUgBgStyle.Name, and Terraria.ModLoader.ModUgBgStyle.Slot.

1115  {
1116  if (!loading)
1117  throw new Exception("AddUgBgStyle can only be called from Mod.Load or Mod.Autoload");
1118 
1119  ugBgStyle.mod = this;
1120  ugBgStyle.Name = name;
1121  ugBgStyle.Slot = UgBgStyleLoader.ReserveBackgroundSlot();
1122 
1123  ugBgStyles[name] = ugBgStyle;
1124  UgBgStyleLoader.ugBgStyles.Add(ugBgStyle);
1125  }
void Terraria.ModLoader.Mod.AddWall ( string  name,
ModWall  wall,
string  texture 
)

Adds a type of wall to the game with the specified name and texture.

Parameters
nameThe name.
wallThe wall.
textureThe texture.

Definition at line 644 of file Mod.cs.

References Terraria.ModLoader.ModWall.mod, Terraria.ModLoader.ModWall.Name, and Terraria.ModLoader.ModWall.Type.

644  {
645  if (!loading)
646  throw new Exception("AddWall can only be called from Mod.Load or Mod.Autoload");
647 
648  wall.mod = this;
649  wall.Name = name;
650  wall.Type = (ushort)WallLoader.ReserveWallID();
651  wall.texture = texture;
652 
653  walls[name] = wall;
654  WallLoader.walls.Add(wall);
655  }
void Terraria.ModLoader.Mod.AddWaterfallStyle ( string  name,
ModWaterfallStyle  waterfallStyle,
string  texture 
)

Adds the given waterfall style to the game with the given name and texture path.

Parameters
nameThe name.
waterfallStyleThe waterfall style.
textureThe texture.

Definition at line 1232 of file Mod.cs.

References Terraria.ModLoader.ModWaterfallStyle.mod, Terraria.ModLoader.ModWaterfallStyle.Name, and Terraria.ModLoader.ModWaterfallStyle.Type.

1232  {
1233  if (!loading)
1234  throw new Exception("AddWaterfallStyle can only be called from Mod.Load or Mod.Autoload");
1235 
1236  waterfallStyle.mod = this;
1237  waterfallStyle.Name = name;
1238  waterfallStyle.Type = WaterfallStyleLoader.ReserveStyle();
1239  waterfallStyle.texture = texture;
1240 
1241  waterfallStyles[name] = waterfallStyle;
1242  WaterfallStyleLoader.waterfallStyles.Add(waterfallStyle);
1243  }
void Terraria.ModLoader.Mod.AddWaterStyle ( string  name,
ModWaterStyle  waterStyle,
string  texture,
string  blockTexture 
)

Adds the given water style to the game with the given name, texture path, and block texture path.

Parameters
nameThe name.
waterStyleThe water style.
textureThe texture.
blockTextureThe block texture.

Definition at line 1203 of file Mod.cs.

References Terraria.ModLoader.ModWaterStyle.mod, Terraria.ModLoader.ModWaterStyle.Name, and Terraria.ModLoader.ModWaterStyle.Type.

1203  {
1204  if (!loading)
1205  throw new Exception("AddWaterStyle can only be called from Mod.Load or Mod.Autoload");
1206 
1207  waterStyle.mod = this;
1208  waterStyle.Name = name;
1209  waterStyle.Type = WaterStyleLoader.ReserveStyle();
1210  waterStyle.texture = texture;
1211  waterStyle.blockTexture = blockTexture;
1212 
1213  waterStyles[name] = waterStyle;
1214  WaterStyleLoader.waterStyles.Add(waterStyle);
1215  }
void Terraria.ModLoader.Mod.AutoloadBackgrounds ( )
private

Definition at line 531 of file ModInternals.cs.

531  {
532  foreach (string texture in textures.Keys.Where(t => t.StartsWith("Backgrounds/"))) {
533  AddBackgroundTexture(Name + '/' + texture);
534  }
535  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void AddBackgroundTexture(string texture)
Adds a texture to the list of background textures and assigns it a background texture slot...
Definition: Mod.cs:1330
void Terraria.ModLoader.Mod.AutoloadBuff ( Type  type)
private

Definition at line 489 of file ModInternals.cs.

References Terraria.ModLoader.ModBuff.Autoload(), Terraria.ModLoader.ModBuff.mod, and Terraria.ModLoader.Mod.Name.

489  {
490  ModBuff buff = (ModBuff)Activator.CreateInstance(type);
491  buff.mod = this;
492  string name = type.Name;
493  string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
494  if (buff.Autoload(ref name, ref texture)) {
495  AddBuff(name, buff, texture);
496  }
497  }
void AddBuff(string name, ModBuff buff, string texture)
Adds a type of buff to the game with the specified internal name and texture.
Definition: Mod.cs:934

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadCommand ( Type  type)
private

Definition at line 635 of file ModInternals.cs.

635  {
636  var mc = (ModCommand)Activator.CreateInstance(type);
637  mc.mod = this;
638  var name = type.Name;
639  if (mc.Autoload(ref name))
640  AddCommand(name, mc);
641  }
void AddCommand(string name, ModCommand mc)
Manually add a Command during Load
Definition: Mod.cs:1373
void Terraria.ModLoader.Mod.AutoloadDust ( Type  type)
private

Definition at line 377 of file ModInternals.cs.

References Terraria.ModLoader.ModDust.Autoload(), Terraria.ModLoader.ModDust.mod, and Terraria.ModLoader.Mod.Name.

377  {
378  ModDust dust = (ModDust)Activator.CreateInstance(type);
379  dust.mod = this;
380  string name = type.Name;
381  string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
382  if (dust.Autoload(ref name, ref texture)) {
383  AddDust(name, dust, texture);
384  }
385  }
void AddDust(string name, ModDust dust, string texture="")
Adds a type of dust to your mod with the specified name. Create an instance of ModDust normally...
Definition: Mod.cs:471

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGlobalBgStyle ( Type  type)
private

Definition at line 555 of file ModInternals.cs.

References Terraria.ModLoader.GlobalBgStyle.Autoload(), Terraria.ModLoader.GlobalBgStyle.mod, and Terraria.ModLoader.Mod.Name.

555  {
556  GlobalBgStyle globalBgStyle = (GlobalBgStyle)Activator.CreateInstance(type);
557  globalBgStyle.mod = this;
558  string name = type.Name;
559  if (globalBgStyle.Autoload(ref name)) {
560  AddGlobalBgStyle(name, globalBgStyle);
561  }
562  }
void AddGlobalBgStyle(string name, GlobalBgStyle globalBgStyle)
Adds the given global background style with the given name to this mod.
Definition: Mod.cs:1176

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGlobalBuff ( Type  type)
private

Definition at line 499 of file ModInternals.cs.

References Terraria.ModLoader.GlobalBuff.Autoload(), Terraria.ModLoader.GlobalBuff.mod, and Terraria.ModLoader.Mod.Name.

499  {
500  GlobalBuff globalBuff = (GlobalBuff)Activator.CreateInstance(type);
501  globalBuff.mod = this;
502  string name = type.Name;
503  if (globalBuff.Autoload(ref name)) {
504  AddGlobalBuff(name, globalBuff);
505  }
506  }
void AddGlobalBuff(string name, GlobalBuff globalBuff)
Adds the given GlobalBuff instance to this mod using the provided name.
Definition: Mod.cs:980

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGlobalItem ( Type  type)
private

Definition at line 359 of file ModInternals.cs.

References Terraria.ModLoader.GlobalItem.Autoload(), Terraria.ModLoader.GlobalItem.mod, and Terraria.ModLoader.Mod.Name.

359  {
360  GlobalItem globalItem = (GlobalItem)Activator.CreateInstance(type);
361  globalItem.mod = this;
362  string name = type.Name;
363  if (globalItem.Autoload(ref name)) {
364  AddGlobalItem(name, globalItem);
365  }
366  }
void AddGlobalItem(string name, GlobalItem globalItem)
Adds the given GlobalItem instance to this mod with the provided name.
Definition: Mod.cs:285

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGlobalNPC ( Type  type)
private

Definition at line 471 of file ModInternals.cs.

References Terraria.ModLoader.GlobalNPC.Autoload(), Terraria.ModLoader.GlobalNPC.mod, and Terraria.ModLoader.Mod.Name.

471  {
472  GlobalNPC globalNPC = (GlobalNPC)Activator.CreateInstance(type);
473  globalNPC.mod = this;
474  string name = type.Name;
475  if (globalNPC.Autoload(ref name)) {
476  AddGlobalNPC(name, globalNPC);
477  }
478  }
void AddGlobalNPC(string name, GlobalNPC globalNPC)
Adds the given GlobalNPC instance to this mod with the provided name.
Definition: Mod.cs:833

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGlobalProjectile ( Type  type)
private

Definition at line 443 of file ModInternals.cs.

References Terraria.ModLoader.GlobalProjectile.Autoload(), Terraria.ModLoader.GlobalProjectile.mod, and Terraria.ModLoader.Mod.Name.

443  {
444  GlobalProjectile globalProjectile = (GlobalProjectile)Activator.CreateInstance(type);
445  globalProjectile.mod = this;
446  string name = type.Name;
447  if (globalProjectile.Autoload(ref name)) {
448  AddGlobalProjectile(name, globalProjectile);
449  }
450  }
void AddGlobalProjectile(string name, GlobalProjectile globalProjectile)
Adds the given GlobalProjectile instance to this mod with the provided name.
Definition: Mod.cs:754

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGlobalRecipe ( Type  type)
private

Definition at line 626 of file ModInternals.cs.

References Terraria.ModLoader.GlobalRecipe.Autoload(), Terraria.ModLoader.GlobalRecipe.mod, and Terraria.ModLoader.Mod.Name.

626  {
627  GlobalRecipe globalRecipe = (GlobalRecipe)Activator.CreateInstance(type);
628  globalRecipe.mod = this;
629  string name = type.Name;
630  if (globalRecipe.Autoload(ref name)) {
631  AddGlobalRecipe(name, globalRecipe);
632  }
633  }
void AddGlobalRecipe(string name, GlobalRecipe globalRecipe)
Manually add a Global Recipe during Load
Definition: Mod.cs:1350

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGlobalTile ( Type  type)
private

Definition at line 397 of file ModInternals.cs.

References Terraria.ModLoader.GlobalTile.Autoload(), Terraria.ModLoader.GlobalTile.mod, and Terraria.ModLoader.Mod.Name.

397  {
398  GlobalTile globalTile = (GlobalTile)Activator.CreateInstance(type);
399  globalTile.mod = this;
400  string name = type.Name;
401  if (globalTile.Autoload(ref name)) {
402  AddGlobalTile(name, globalTile);
403  }
404  }
void AddGlobalTile(string name, GlobalTile globalTile)
Adds the given GlobalTile instance to this mod with the provided name.
Definition: Mod.cs:567

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGlobalWall ( Type  type)
private

Definition at line 425 of file ModInternals.cs.

References Terraria.ModLoader.GlobalWall.Autoload(), Terraria.ModLoader.GlobalWall.mod, and Terraria.ModLoader.Mod.Name.

425  {
426  GlobalWall globalWall = (GlobalWall)Activator.CreateInstance(type);
427  globalWall.mod = this;
428  string name = type.Name;
429  if (globalWall.Autoload(ref name)) {
430  AddGlobalWall(name, globalWall);
431  }
432  }
void AddGlobalWall(string name, GlobalWall globalWall)
Adds the given GlobalWall instance to this mod with the provided name.
Definition: Mod.cs:685

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadGores ( IList< Type >  modGores)
private

Definition at line 585 of file ModInternals.cs.

585  {
586  var modGoreNames = modGores.ToDictionary(t => t.Namespace + "." + t.Name);
587  foreach (var texture in textures.Keys.Where(t => t.StartsWith("Gores/"))) {
588  ModGore modGore = null;
589  Type t;
590  if (modGoreNames.TryGetValue(Name + "." + texture.Replace('/', '.'), out t))
591  modGore = (ModGore)Activator.CreateInstance(t);
592 
593  AddGore(Name + '/' + texture, modGore);
594  }
595  }
void AddGore(string texture, ModGore modGore=null)
Adds the given texture to the game as a custom gore, with the given custom gore behavior. If no custom gore behavior is provided, the custom gore will have the default vanilla behavior.
Definition: Mod.cs:1268
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void Terraria.ModLoader.Mod.AutoloadItem ( Type  type)
private

Definition at line 345 of file ModInternals.cs.

References Terraria.ModLoader.ModItem.Autoload(), Terraria.ModLoader.ModItem.mod, Terraria.ModLoader.Mod.Name, Terraria.ModLoader.ModItem.Name, and Terraria.ModLoader.ModItem.Texture.

345  {
346  ModItem item = (ModItem)Activator.CreateInstance(type);
347  item.mod = this;
348  string name = type.Name;
349  if (item.Autoload(ref name)) {
350  AddItem(name, item);
351  var autoloadEquip = type.GetAttribute<AutoloadEquip>();
352  if (autoloadEquip != null)
353  foreach (var equip in autoloadEquip.equipTypes)
354  AddEquipTexture(item, equip, item.Name, item.Texture + '_' + equip,
355  item.Texture + "_Arms", item.Texture + "_FemaleBody");
356  }
357  }
void AddItem(string name, ModItem item)
Adds a type of item to your mod with the specified internal name. This method should be called in Loa...
Definition: Mod.cs:233
int AddEquipTexture(ModItem item, EquipType type, string name, string texture, string armTexture="", string femaleTexture="")
Adds an equipment texture of the specified type, internal name, and associated item to your mod...
Definition: Mod.cs:334

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadLocalization ( )
private

Loads .lang files

Definition at line 646 of file ModInternals.cs.

646  {
647  var modTranslationDictionary = new Dictionary<string, ModTranslation>();
648  foreach (var translationFile in File.Where(entry => Path.GetExtension(entry.Name) == ".lang")) {
649  // .lang files need to be UTF8 encoded.
650  string translationFileContents = System.Text.Encoding.UTF8.GetString(File.GetBytes(translationFile));
651  GameCulture culture = GameCulture.FromName(Path.GetFileNameWithoutExtension(translationFile.Name));
652 
653  using (StringReader reader = new StringReader(translationFileContents)) {
654  string line;
655  while ((line = reader.ReadLine()) != null) {
656  int split = line.IndexOf('=');
657  if (split < 0)
658  continue; // lines witout a = are ignored
659  string key = line.Substring(0, split).Trim().Replace(" ", "_");
660  string value = line.Substring(split + 1).Trim();
661  if (value.Length == 0) {
662  continue;
663  }
664  value = value.Replace("\\n", "\n");
665  // TODO: Maybe prepend key with filename: en.US.ItemName.lang would automatically assume "ItemName." for all entries.
666  //string key = key;
667  if (!modTranslationDictionary.TryGetValue(key, out ModTranslation mt))
668  modTranslationDictionary[key] = mt = CreateTranslation(key);
669  mt.AddTranslation(culture, value);
670  }
671  }
672  }
673 
674  foreach (var value in modTranslationDictionary.Values) {
675  AddTranslation(value);
676  }
677  }
void AddTranslation(int culture, string value)
void AddTranslation(ModTranslation translation)
Adds a ModTranslation to the game so that you can use Language.GetText to get a LocalizedText.
Definition: Mod.cs:1479
ModTranslation CreateTranslation(string key)
Creates a ModTranslation object that you can use in AddTranslation.
void Terraria.ModLoader.Mod.AutoloadModWorld ( Type  type)
private

Definition at line 522 of file ModInternals.cs.

References Terraria.ModLoader.ModWorld.Autoload(), Terraria.ModLoader.ModWorld.mod, and Terraria.ModLoader.Mod.Name.

522  {
523  ModWorld modWorld = (ModWorld)Activator.CreateInstance(type);
524  modWorld.mod = this;
525  string name = type.Name;
526  if (modWorld.Autoload(ref name)) {
527  AddModWorld(name, modWorld);
528  }
529  }
void AddModWorld(string name, ModWorld modWorld)
Adds a ModWorld to this mod with the given name.
Definition: Mod.cs:1085

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadMountData ( Type  type)
private

Definition at line 508 of file ModInternals.cs.

References Terraria.ModLoader.ModMountData.mod, and Terraria.ModLoader.Mod.Name.

508  {
509  ModMountData mount = (ModMountData)Activator.CreateInstance(type);
510  mount.mod = this;
511  string name = type.Name;
512  string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
513  var extraTextures = new Dictionary<MountTextureType, string>();
514  foreach (MountTextureType textureType in Enum.GetValues(typeof(MountTextureType))) {
515  extraTextures[textureType] = texture + "_" + textureType.ToString();
516  }
517  if (mount.Autoload(ref name, ref texture, extraTextures)) {
518  AddMount(name, mount, texture, extraTextures);
519  }
520  }
void AddMount(string name, ModMountData mount, string texture, IDictionary< MountTextureType, string > extraTextures=null)
Adds the given mount to the game with the given name and texture. The extraTextures dictionary should...
Definition: Mod.cs:1004
MountTextureType
This is an enum of all possible types of extra mount textures for custom mounts. Use these as keys in...
void Terraria.ModLoader.Mod.AutoloadNPC ( Type  type)
private

Definition at line 452 of file ModInternals.cs.

References Terraria.ModLoader.ModNPC.Autoload(), Terraria.ModLoader.ModNPC.BossHeadTexture, Terraria.ModLoader.ModNPC.HeadTexture, Terraria.ModLoader.ModNPC.mod, Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ModNPC.npc.

452  {
453  ModNPC npc = (ModNPC)Activator.CreateInstance(type);
454  npc.mod = this;
455  string name = type.Name;
456  if (npc.Autoload(ref name)) {
457  AddNPC(name, npc);
458  var autoloadHead = type.GetAttribute<AutoloadHead>();
459  if (autoloadHead != null) {
460  string headTexture = npc.HeadTexture;
461  AddNPCHeadTexture(npc.npc.type, headTexture);
462  }
463  var autoloadBossHead = type.GetAttribute<AutoloadBossHead>();
464  if (autoloadBossHead != null) {
465  string headTexture = npc.BossHeadTexture;
466  AddBossHeadTexture(headTexture, npc.npc.type);
467  }
468  }
469  }
void AddNPCHeadTexture(int npcType, string texture)
Assigns a head texture to the given town NPC type.
Definition: Mod.cs:869
void AddNPC(string name, ModNPC npc)
Adds a type of NPC to the game with the specified name and texture. Also allows you to give the NPC a...
Definition: Mod.cs:789
void AddBossHeadTexture(string texture, int npcType=-1)
Assigns a head texture that can be used by NPCs on the map.
Definition: Mod.cs:891

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadPlayer ( Type  type)
private

Definition at line 480 of file ModInternals.cs.

References Terraria.ModLoader.ModPlayer.Autoload(), Terraria.ModLoader.ModPlayer.mod, and Terraria.ModLoader.Mod.Name.

480  {
481  ModPlayer player = (ModPlayer)Activator.CreateInstance(type);
482  player.mod = this;
483  string name = type.Name;
484  if (player.Autoload(ref name)) {
485  AddPlayer(name, player);
486  }
487  }
void AddPlayer(string name, ModPlayer player)
Adds a type of ModPlayer to this mod. All ModPlayer types will be newly created and attached to each ...
Definition: Mod.cs:908

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadPrefix ( Type  type)
private

Definition at line 368 of file ModInternals.cs.

References Terraria.ModLoader.ModPrefix.Autoload(), Terraria.ModLoader.ModPrefix.mod, and Terraria.ModLoader.Mod.Name.

368  {
369  ModPrefix prefix = (ModPrefix)Activator.CreateInstance(type);
370  prefix.mod = this;
371  string name = type.Name;
372  if (prefix.Autoload(ref name)) {
373  AddPrefix(name, prefix);
374  }
375  }
void AddPrefix(string name, ModPrefix prefix)
Adds a prefix to your mod with the specified internal name. This method should be called in Load...
Definition: Mod.cs:420

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadProjectile ( Type  type)
private

Definition at line 434 of file ModInternals.cs.

References Terraria.ModLoader.ModProjectile.Autoload(), Terraria.ModLoader.ModProjectile.mod, and Terraria.ModLoader.Mod.Name.

434  {
435  ModProjectile projectile = (ModProjectile)Activator.CreateInstance(type);
436  projectile.mod = this;
437  string name = type.Name;
438  if (projectile.Autoload(ref name)) {
439  AddProjectile(name, projectile);
440  }
441  }
void AddProjectile(string name, ModProjectile projectile)
Adds a type of projectile to the game with the specified name.
Definition: Mod.cs:710

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadSounds ( IList< Type >  modSounds)
private

Definition at line 597 of file ModInternals.cs.

597  {
598  var modSoundNames = modSounds.ToDictionary(t => t.Namespace + "." + t.Name);
599  foreach (var sound in sounds.Keys.Where(t => t.StartsWith("Sounds/"))) {
600  string substring = sound.Substring("Sounds/".Length);
601  SoundType soundType = SoundType.Custom;
602  if (substring.StartsWith("Item/")) {
603  soundType = SoundType.Item;
604  }
605  else if (substring.StartsWith("NPCHit/")) {
606  soundType = SoundType.NPCHit;
607  }
608  else if (substring.StartsWith("NPCKilled/")) {
609  soundType = SoundType.NPCKilled;
610  }
611  ModSound modSound = null;
612  Type t;
613  if (modSoundNames.TryGetValue((Name + '/' + sound).Replace('/', '.'), out t))
614  modSound = (ModSound)Activator.CreateInstance(t);
615 
616  AddSound(soundType, Name + '/' + sound, modSound);
617  }
618  foreach (var music in musics.Keys.Where(t => t.StartsWith("Sounds/"))) {
619  string substring = music.Substring("Sounds/".Length);
620  if (substring.StartsWith("Music/")) {
621  AddSound(SoundType.Music, Name + '/' + music);
622  }
623  }
624  }
SoundType
This is an enum of the types of sound you can add to the game. This is used for determining whether a...
Definition: SoundType.cs:12
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
void AddSound(SoundType type, string soundPath, ModSound modSound=null)
Adds the given sound file to the game as the given type of sound and with the given custom sound play...
Definition: Mod.cs:1299
void Terraria.ModLoader.Mod.AutoloadSurfaceBgStyle ( Type  type)
private

Definition at line 546 of file ModInternals.cs.

References Terraria.ModLoader.ModSurfaceBgStyle.Autoload(), Terraria.ModLoader.ModSurfaceBgStyle.mod, and Terraria.ModLoader.Mod.Name.

546  {
547  ModSurfaceBgStyle surfaceBgStyle = (ModSurfaceBgStyle)Activator.CreateInstance(type);
548  surfaceBgStyle.mod = this;
549  string name = type.Name;
550  if (surfaceBgStyle.Autoload(ref name)) {
551  AddSurfaceBgStyle(name, surfaceBgStyle);
552  }
553  }
void AddSurfaceBgStyle(string name, ModSurfaceBgStyle surfaceBgStyle)
Adds the given surface background style with the given name to this mod.
Definition: Mod.cs:1141

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadTile ( Type  type)
private

Definition at line 387 of file ModInternals.cs.

References Terraria.ModLoader.ModTile.Autoload(), Terraria.ModLoader.ModTile.mod, and Terraria.ModLoader.Mod.Name.

387  {
388  ModTile tile = (ModTile)Activator.CreateInstance(type);
389  tile.mod = this;
390  string name = type.Name;
391  string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
392  if (tile.Autoload(ref name, ref texture)) {
393  AddTile(name, tile, texture);
394  }
395  }
void AddTile(string name, ModTile tile, string texture)
Adds a type of tile to the game with the specified name and texture.
Definition: Mod.cs:518

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadTileEntity ( Type  type)
private

Definition at line 406 of file ModInternals.cs.

References Terraria.ModLoader.ModTileEntity.Autoload(), Terraria.ModLoader.ModTileEntity.mod, and Terraria.ModLoader.Mod.Name.

406  {
407  ModTileEntity tileEntity = (ModTileEntity)Activator.CreateInstance(type);
408  tileEntity.mod = this;
409  string name = type.Name;
410  if (tileEntity.Autoload(ref name)) {
411  AddTileEntity(name, tileEntity);
412  }
413  }
void AddTileEntity(string name, ModTileEntity entity)
Manually add a tile entity during Load.
Definition: Mod.cs:595

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadUgBgStyle ( Type  type)
private

Definition at line 537 of file ModInternals.cs.

References Terraria.ModLoader.ModUgBgStyle.Autoload(), Terraria.ModLoader.ModUgBgStyle.mod, and Terraria.ModLoader.Mod.Name.

537  {
538  ModUgBgStyle ugBgStyle = (ModUgBgStyle)Activator.CreateInstance(type);
539  ugBgStyle.mod = this;
540  string name = type.Name;
541  if (ugBgStyle.Autoload(ref name)) {
542  AddUgBgStyle(name, ugBgStyle);
543  }
544  }
void AddUgBgStyle(string name, ModUgBgStyle ugBgStyle)
Adds the given underground background style with the given name to this mod.
Definition: Mod.cs:1115

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadWall ( Type  type)
private

Definition at line 415 of file ModInternals.cs.

References Terraria.ModLoader.ModWall.Autoload(), Terraria.ModLoader.ModWall.mod, and Terraria.ModLoader.Mod.Name.

415  {
416  ModWall wall = (ModWall)Activator.CreateInstance(type);
417  wall.mod = this;
418  string name = type.Name;
419  string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
420  if (wall.Autoload(ref name, ref texture)) {
421  AddWall(name, wall, texture);
422  }
423  }
void AddWall(string name, ModWall wall, string texture)
Adds a type of wall to the game with the specified name and texture.
Definition: Mod.cs:644

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadWaterfallStyle ( Type  type)
private

Definition at line 575 of file ModInternals.cs.

References Terraria.ModLoader.ModWaterfallStyle.Autoload(), Terraria.ModLoader.ModWaterfallStyle.mod, and Terraria.ModLoader.Mod.Name.

575  {
576  ModWaterfallStyle waterfallStyle = (ModWaterfallStyle)Activator.CreateInstance(type);
577  waterfallStyle.mod = this;
578  string name = type.Name;
579  string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
580  if (waterfallStyle.Autoload(ref name, ref texture)) {
581  AddWaterfallStyle(name, waterfallStyle, texture);
582  }
583  }
void AddWaterfallStyle(string name, ModWaterfallStyle waterfallStyle, string texture)
Adds the given waterfall style to the game with the given name and texture path.
Definition: Mod.cs:1232

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.AutoloadWaterStyle ( Type  type)
private

Definition at line 564 of file ModInternals.cs.

References Terraria.ModLoader.ModWaterStyle.Autoload(), Terraria.ModLoader.ModWaterStyle.mod, and Terraria.ModLoader.Mod.Name.

564  {
565  ModWaterStyle waterStyle = (ModWaterStyle)Activator.CreateInstance(type);
566  waterStyle.mod = this;
567  string name = type.Name;
568  string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
569  string blockTexture = texture + "_Block";
570  if (waterStyle.Autoload(ref name, ref texture, ref blockTexture)) {
571  AddWaterStyle(name, waterStyle, texture, blockTexture);
572  }
573  }
void AddWaterStyle(string name, ModWaterStyle waterStyle, string texture, string blockTexture)
Adds the given water style to the game with the given name, texture path, and block texture path...
Definition: Mod.cs:1203

+ Here is the call graph for this function:

int Terraria.ModLoader.Mod.BuffType ( string  name)

Gets the type of the ModBuff of this mod corresponding to the given name. Returns 0 if no ModBuff with the given name is found.

Parameters
nameThe name.
Returns

Same as the other BuffType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModBuff 
T :BuffType 
T :typeof 
T :T 
T :Name 
virtual object Terraria.ModLoader.Mod.Call ( params object[]  args)
virtual

Used for weak inter-mod communication. This allows you to interact with other mods without having to reference their types or namespaces, provided that they have implemented this method.

Definition at line 1618 of file Mod.cs.

1618  {
1619  return null;
1620  }
virtual void Terraria.ModLoader.Mod.Close ( )
virtual

Close is called before Unload, and may be called at any time when mod unloading is imminent (such as when downloading an update, or recompiling) Use this to release any additional file handles, or stop streaming music. Make sure to call base.Close() at the end May be called multiple times before Unload

Definition at line 130 of file Mod.cs.

Referenced by Terraria.ModLoader.ModNet.DownloadNextMod().

130  {
131  fileHandle?.Dispose();
132  if (File != null && File.IsOpen)
133  throw new IOException($"TModFile has open handles: {File.path}");
134  }
IDisposable fileHandle
Definition: Mod.cs:64

+ Here is the caller graph for this function:

ModTranslation Terraria.ModLoader.Mod.CreateTranslation ( string  key)

Creates a ModTranslation object that you can use in AddTranslation.

Parameters
keyThe key for the ModTranslation. The full key will be Mods.ModName.key
int Terraria.ModLoader.Mod.DustType ( string  name)

Gets the type of the ModDust of this mod with the given name. Returns 0 if no ModDust with the given name is found.

Parameters
nameThe name.
Returns

Same as the other DustType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModDust 
T :DustType 
T :typeof 
T :T 
T :Name 
bool Terraria.ModLoader.Mod.EffectExists ( string  name)

Used to check if a custom Effect exists

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

Shorthand for calling ModLoader.FileExists(this.FileName(name)). Note that file extensions are used here.

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.ModContent.FileExists().

+ Here is the caller graph for this function:

bool Terraria.ModLoader.Mod.FontExists ( string  name)

Used to check if a custom SpriteFont exists

sbyte Terraria.ModLoader.Mod.GetAccessorySlot ( string  name,
EquipType  type 
)

Same as GetEquipSlot, except returns the number as an sbyte (signed byte) for your convenience.

Parameters
nameThe name.
type
Returns
int Terraria.ModLoader.Mod.GetBackgroundSlot ( string  name)

Gets the texture slot corresponding to the specified texture name. Shorthand for calling BackgroundTextureLoader.GetBackgroundSlot(this.Name + '/' + name).

Parameters
nameThe name.
Returns
ModBuff Terraria.ModLoader.Mod.GetBuff ( string  name)

Gets the ModBuff of this mod corresponding to the given name. Returns null if no ModBuff with the given name is found.

Parameters
nameThe name.
Returns
Type Constraints
T :ModBuff 
T :T 
T :GetBuff 
T :typeof 
T :T 
T :Name 
ModConfig Terraria.ModLoader.Mod.GetConfig ( string  name)

Definition at line 1642 of file Mod.cs.

1643  {
1644  List<ModConfig> configs;
1645  if (ConfigManager.Configs.TryGetValue(this, out configs))
1646  {
1647  return configs.Single(x => x.Name == name);
1648  }
1649  return null;
1650  }
Type Constraints
T :ModConfig 
T :T 
T :GetConfig 
T :typeof 
T :T 
T :Name 
ModDust Terraria.ModLoader.Mod.GetDust ( string  name)

Gets the ModDust of this mod corresponding to the given name. Returns null if no ModDust with the given name is found.

Parameters
nameThe name.
Returns

Same as the other GetDust, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModDust 
T :T 
T :GetDust 
T :typeof 
T :T 
T :Name 
Effect Terraria.ModLoader.Mod.GetEffect ( string  name)

Gets an Effect loaded from the specified path.

Exceptions
MissingResourceException

Definition at line 1603 of file Mod.cs.

1603  {
1604  if (!effects.TryGetValue(name, out var effect))
1605  throw new MissingResourceException(name);
1606 
1607  return effect;
1608  }
int Terraria.ModLoader.Mod.GetEquipSlot ( string  name,
EquipType  type 
)

Gets the slot/ID of the equipment texture corresponding to the given name. Returns -1 if no EquipTexture with the given name is found.

Parameters
nameThe name.
type
Returns
EquipTexture Terraria.ModLoader.Mod.GetEquipTexture ( string  name,
EquipType  type 
)

Gets the EquipTexture instance corresponding to the name and EquipType. Returns null if no EquipTexture with the given name and EquipType is found.

Parameters
nameThe name.
typeThe type.
Returns
byte [] Terraria.ModLoader.Mod.GetFileBytes ( string  name)

Retrieve contents of files within the tmod file

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.ModContent.GetFileBytes().

+ Here is the caller graph for this function:

Stream Terraria.ModLoader.Mod.GetFileStream ( string  name,
bool  newFileStream = false 
)

Retrieve contents of files within the tmod file

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.ModContent.OpenRead().

+ Here is the caller graph for this function:

DynamicSpriteFont Terraria.ModLoader.Mod.GetFont ( string  name)

Gets a SpriteFont loaded from the specified path.

Exceptions
MissingResourceException

Definition at line 1587 of file Mod.cs.

1587  {
1588  if (!fonts.TryGetValue(name, out var font))
1589  throw new MissingResourceException(name);
1590 
1591  return font;
1592  }
GlobalBgStyle Terraria.ModLoader.Mod.GetGlobalBgStyle ( string  name)

Returns the global background style corresponding to the given name.

Parameters
nameThe name.
Returns
Type Constraints
T :GlobalBgStyle 
T :T 
T :GetGlobalBgStyle 
T :typeof 
T :T 
T :Name 
GlobalBuff Terraria.ModLoader.Mod.GetGlobalBuff ( string  name)

Gets the GlobalBuff with the given name from this mod.

Parameters
nameThe name.
Returns
Type Constraints
T :GlobalBuff 
T :T 
T :GetGlobalBuff 
T :typeof 
T :T 
T :Name 
GlobalItem Terraria.ModLoader.Mod.GetGlobalItem ( string  name)

Gets the GlobalItem instance with the given name from this mod.

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.IO.ItemIO.Load(), and Terraria.ModLoader.IO.ItemIO.LoadLegacy().

+ Here is the caller graph for this function:

Same as the other GetGlobalItem, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :GlobalItem 
T :T 
T :GetGlobalItem 
T :typeof 
T :T 
T :Name 
GlobalNPC Terraria.ModLoader.Mod.GetGlobalNPC ( string  name)

Gets the GlobalNPC instance with the given name from this mod.

Parameters
nameThe name.
Returns
Type Constraints
T :GlobalNPC 
T :T 
T :GetGlobalNPC 
T :typeof 
T :T 
T :Name 
GlobalProjectile Terraria.ModLoader.Mod.GetGlobalProjectile ( string  name)

Gets the GlobalProjectile instance with the given name from this mod.

Parameters
nameThe name.
Returns
Type Constraints
T :GlobalProjectile 
T :T 
T :GetGlobalProjectile 
T :typeof 
T :T 
T :Name 
GlobalRecipe Terraria.ModLoader.Mod.GetGlobalRecipe ( string  name)

Gets the global recipe corresponding to the specified name.

Parameters
nameThe name.
Returns
Type Constraints
T :GlobalRecipe 
T :T 
T :GetGlobalRecipe 
T :typeof 
T :T 
T :Name 
GlobalTile Terraria.ModLoader.Mod.GetGlobalTile ( string  name)

Gets the GlobalTile instance with the given name from this mod.

Parameters
nameThe name.
Returns

Same as the other GetGlobalTile, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :GlobalTile 
T :T 
T :GetGlobalTile 
T :typeof 
T :T 
T :Name 
GlobalWall Terraria.ModLoader.Mod.GetGlobalWall ( string  name)

Gets the GlobalWall instance with the given name from this mod.

Parameters
nameThe name.
Returns
Type Constraints
T :GlobalWall 
T :T 
T :GetGlobalWall 
T :typeof 
T :T 
T :Name 
int Terraria.ModLoader.Mod.GetGoreSlot ( string  name)

Shorthand for calling ModGore.GetGoreSlot(this.Name + '/' + name).

Parameters
nameThe name.
Returns

Same as the other GetGoreSlot, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModGore 
T :GetGoreSlot 
T :typeof 
T :T 
T :Name 
ModItem Terraria.ModLoader.Mod.GetItem ( string  name)

Gets the ModItem instance corresponding to the name. Because this method is in the Mod class, conflicts between mods are avoided. Returns null if no ModItem with the given name is found.

Parameters
nameThe name.
Returns

Same as the other GetItem, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModItem 
T :T 
T :GetItem 
T :typeof 
T :T 
T :Name 
LegacySoundStyle Terraria.ModLoader.Mod.GetLegacySoundSlot ( SoundType  type,
string  name 
)

Shorthand for calling SoundLoader.GetLegacySoundSlot(type, this.Name + '/' + name).

Parameters
typeThe type.
nameThe name.
Returns
ModWorld Terraria.ModLoader.Mod.GetModWorld ( string  name)

Gets the ModWorld instance with the given name from this mod.

Parameters
nameThe name.
Returns

Same as the other GetModWorld, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModWorld 
T :T 
T :GetModWorld 
T :typeof 
T :T 
T :Name 
ModMountData Terraria.ModLoader.Mod.GetMount ( string  name)

Gets the ModMountData instance of this mod corresponding to the given name. Returns null if no ModMountData has the given name.

Parameters
nameThe name.
Returns
Type Constraints
T :ModMountData 
T :T 
T :GetMount 
T :typeof 
T :T 
T :Name 
Music Terraria.ModLoader.Mod.GetMusic ( string  name)

Shorthand for calling ModContent.GetMusic(this.FileName(name)).

Parameters
nameThe name.
Returns
Exceptions
MissingResourceException

Definition at line 1569 of file Mod.cs.

Referenced by Terraria.ModLoader.ModContent.GetMusic().

1569  {
1570  if (!musics.TryGetValue(name, out var music))
1571  throw new MissingResourceException(name);
1572 
1573  return music;
1574  }

+ Here is the caller graph for this function:

ModNPC Terraria.ModLoader.Mod.GetNPC ( string  name)

Gets the ModNPC of this mod corresponding to the given name. Returns null if no ModNPC with the given name is found.

Parameters
nameThe name.
Returns
Type Constraints
T :ModNPC 
T :T 
T :GetNPC 
T :typeof 
T :T 
T :Name 
ModPacket Terraria.ModLoader.Mod.GetPacket ( int  capacity = 256)

Creates a ModPacket object that you can write to and then send between servers and clients.

Parameters
capacityThe capacity.
Returns
Exceptions
System.ExceptionCannot get packet for " + Name + " because it does not exist on the other side

Definition at line 1628 of file Mod.cs.

References Terraria.ModLoader.ModNet.NetModCount.

1628  {
1629  if (netID < 0)
1630  throw new Exception("Cannot get packet for " + Name + " because it does not exist on the other side");
1631 
1632  var p = new ModPacket(MessageID.ModPacket, capacity + 5);
1633  if (ModNet.NetModCount < 256)
1634  p.Write((byte)netID);
1635  else
1636  p.Write(netID);
1637 
1638  p.netID = netID;
1639  return p;
1640  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
ModPlayer Terraria.ModLoader.Mod.GetPlayer ( string  name)

Gets the ModPlayer of this mod corresponding to the given name. Returns null if no ModPlayer with the given name is found.

Parameters
nameThe name.
Returns
Type Constraints
T :ModPlayer 
T :T 
T :GetPlayer 
T :typeof 
T :T 
T :Name 
ModPrefix Terraria.ModLoader.Mod.GetPrefix ( string  name)

Gets the ModPrefix instance corresponding to the name. Because this method is in the Mod class, conflicts between mods are avoided. Returns null if no ModPrefix with the given name is found.

Parameters
nameThe name.
Returns

Same as the other GetPrefix, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModPrefix 
T :T 
T :GetPrefix 
T :typeof 
T :T 
T :Name 
ModProjectile Terraria.ModLoader.Mod.GetProjectile ( string  name)

Gets the ModProjectile of this mod corresponding to the given name. Returns null if no ModProjectile with the given name is found.

Parameters
nameThe name.
Returns
Type Constraints
T :ModProjectile 
T :T 
T :GetProjectile 
T :typeof 
T :T 
T :Name 
SoundEffect Terraria.ModLoader.Mod.GetSound ( string  name)

Shorthand for calling ModContent.GetSound(this.FileName(name)).

Parameters
nameThe name.
Returns
Exceptions
MissingResourceException

Definition at line 1549 of file Mod.cs.

Referenced by Terraria.ModLoader.ModContent.GetSound().

1549  {
1550  if (!sounds.TryGetValue(name, out var sound))
1551  throw new MissingResourceException(name);
1552 
1553  return sound;
1554  }

+ Here is the caller graph for this function:

int Terraria.ModLoader.Mod.GetSoundSlot ( SoundType  type,
string  name 
)

Shorthand for calling SoundLoader.GetSoundSlot(type, this.Name + '/' + name).

Parameters
typeThe type.
nameThe name.
Returns
ModSurfaceBgStyle Terraria.ModLoader.Mod.GetSurfaceBgStyle ( string  name)

Returns the surface background style corresponding to the given name.

Parameters
nameThe name.
Returns
Type Constraints
T :ModSurfaceBgStyle 
T :T 
T :GetSurfaceBgStyle 
T :typeof 
T :T 
T :Name 
int Terraria.ModLoader.Mod.GetSurfaceBgStyleSlot ( string  name)

Returns the Slot of the surface background style corresponding to the given name.

Parameters
nameThe name.
Returns
Type Constraints
T :ModSurfaceBgStyle 
T :GetSurfaceBgStyleSlot 
T :typeof 
T :T 
T :Name 
Texture2D Terraria.ModLoader.Mod.GetTexture ( string  name)

Shorthand for calling ModContent.GetTexture(this.FileName(name)).

Exceptions
MissingResourceException

Definition at line 1513 of file Mod.cs.

1513  {
1514  if (!textures.TryGetValue(name, out var t))
1515  throw new MissingResourceException(name, textures.Keys);
1516 
1517  return t;
1518  }
ModTile Terraria.ModLoader.Mod.GetTile ( string  name)

Gets the ModTile of this mod corresponding to the given name. Returns null if no ModTile with the given name is found.

Parameters
nameThe name.
Returns

Same as the other GetTile, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModTile 
T :T 
T :GetTile 
T :typeof 
T :T 
T :Name 
ModTileEntity Terraria.ModLoader.Mod.GetTileEntity ( string  name)

Gets the ModTileEntity of this mod corresponding to the given name. Returns null if no ModTileEntity with the given name is found.

Parameters
nameThe name.
Returns

Same as the other GetTileEntity, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModTileEntity 
T :T 
T :GetTileEntity 
T :typeof 
T :T 
T :Name 
ModUgBgStyle Terraria.ModLoader.Mod.GetUgBgStyle ( string  name)

Returns the underground background style corresponding to the given name.

Parameters
nameThe name.
Returns
Type Constraints
T :ModUgBgStyle 
T :T 
T :GetUgBgStyle 
T :typeof 
T :T 
T :Name 
ModWall Terraria.ModLoader.Mod.GetWall ( string  name)

Gets the ModWall of this mod corresponding to the given name. Returns null if no ModWall with the given name is found.

Parameters
nameThe name.
Returns
Type Constraints
T :ModWall 
T :T 
T :GetWall 
T :typeof 
T :T 
T :Name 
ModWaterfallStyle Terraria.ModLoader.Mod.GetWaterfallStyle ( string  name)

Returns the waterfall style with the given name from this mod.

Parameters
nameThe name.
Returns
Type Constraints
T :ModWaterfallStyle 
T :T 
T :GetWaterfallStyle 
T :typeof 
T :T 
T :Name 
int Terraria.ModLoader.Mod.GetWaterfallStyleSlot ( string  name)

Returns the waterfall style corresponding to the given name.

Parameters
nameThe name.
Returns
Type Constraints
T :ModWaterfallStyle 
T :GetWaterfallStyleSlot 
T :typeof 
T :T 
T :Name 
ModWaterStyle Terraria.ModLoader.Mod.GetWaterStyle ( string  name)

Returns the water style with the given name from this mod.

Parameters
nameThe name.
Returns
Type Constraints
T :ModWaterStyle 
T :T 
T :GetWaterStyle 
T :typeof 
T :T 
T :Name 
virtual void Terraria.ModLoader.Mod.HandlePacket ( BinaryReader  reader,
int  whoAmI 
)
virtual

Called whenever a net message / packet is received from a client (if this is a server) or the server (if this is a client). whoAmI is the ID of whomever sent the packet (equivalent to the Main.myPlayer of the sender), and reader is used to read the binary data of the packet.

Parameters
readerThe reader.
whoAmIThe player the message is from.

Definition at line 44 of file ModHooks.cs.

44  {
45  }
virtual bool Terraria.ModLoader.Mod.HijackGetData ( ref byte  messageType,
ref BinaryReader  reader,
int  playerNumber 
)
virtual

Allows you to modify net message / packet information that is received before the game can act on it.

Parameters
messageTypeType of the message.
readerThe reader.
playerNumberThe player number the message is from.
Returns

Definition at line 54 of file ModHooks.cs.

54  {
55  return false;
56  }
virtual bool Terraria.ModLoader.Mod.HijackSendData ( int  whoAmI,
int  msgType,
int  remoteClient,
int  ignoreClient,
NetworkText  text,
int  number,
float  number2,
float  number3,
float  number4,
int  number5,
int  number6,
int  number7 
)
virtual

Hijacks the send data method. Only use if you absolutely know what you are doing. If any hooks return true, the message is not sent.

Definition at line 61 of file ModHooks.cs.

Referenced by Terraria.ModLoader.ModNet.ReadNetIDs().

61  {
62  return false;
63  }

+ Here is the caller graph for this function:

virtual void Terraria.ModLoader.Mod.HotKeyPressed ( string  name)
virtual

Called when a hotkey is pressed. Check against the name to verify particular hotkey that was pressed. (Using the ModHotKey is more recommended.)

Parameters
nameThe display name of the hotkey.

Definition at line 36 of file ModHooks.cs.

36  {
37  }
int Terraria.ModLoader.Mod.ItemType ( string  name)

Gets the internal ID / type of the ModItem corresponding to the name. Returns 0 if no ModItem with the given name is found.

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.ModRecipe.AddIngredient(), Terraria.ModLoader.IO.ItemIO.Load(), Terraria.ModLoader.IO.ItemIO.LoadLegacy(), Terraria.ModLoader.ModRecipe.SetResult(), and Terraria.ModLoader.PlayerHooks.SetStartInventory().

+ Here is the caller graph for this function:

Same as the other ItemType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModItem 
T :ItemType 
T :typeof 
T :T 
T :Name 
virtual void Terraria.ModLoader.Mod.Load ( )
virtual

Override this method to add most of your content to your mod. Here you will call other methods such as AddItem. This is guaranteed to be called after all content has been autoloaded.

Definition at line 70 of file Mod.cs.

Referenced by Terraria.ModLoader.ModContent.SetLocalizedText().

70  {
71  }

+ Here is the caller graph for this function:

Music Terraria.ModLoader.Mod.LoadMusic ( string  path,
string  extension 
)
private

Definition at line 108 of file ModInternals.cs.

References Terraria.ModLoader.ModPrefix.AutoDefaults(), Terraria.ModLoader.ModProjectile.AutoStaticDefaults(), Terraria.ModLoader.ModItem.AutoStaticDefaults(), Terraria.ModLoader.ModNPC.AutoStaticDefaults(), Terraria.ModLoader.ModTile.chest, Terraria.ModLoader.ModContent.GetTexture(), Terraria.ModLoader.ModTile.HighlightTexture, Terraria.ModLoader.ModItem.item, Terraria.ModLoader.ModMountData.mountData, Terraria.ModLoader.ModNPC.npc, Terraria.ModLoader.ModProjectile.projectile, Terraria.ModLoader.GlobalWall.SetDefaults(), Terraria.ModLoader.ModBuff.SetDefaults(), Terraria.ModLoader.GlobalTile.SetDefaults(), Terraria.ModLoader.ModDust.SetDefaults(), Terraria.ModLoader.ModWall.SetDefaults(), Terraria.ModLoader.ModPrefix.SetDefaults(), Terraria.ModLoader.ModProjectile.SetStaticDefaults(), Terraria.ModLoader.ModItem.SetStaticDefaults(), Terraria.ModLoader.ModNPC.SetStaticDefaults(), Terraria.ModLoader.ModBuff.Type, Terraria.ModLoader.ModWaterStyle.Type, Terraria.ModLoader.ModMountData.Type, Terraria.ModLoader.ModTile.Type, Terraria.ModLoader.ModWall.Type, and Terraria.ModLoader.ModWaterfallStyle.Type.

108  {
109  path = "tmod:"+Name+'/'+path+extension;
110  switch (extension) {
111  case ".wav": return new MusicStreamingWAV(path);
112  case ".mp3": return new MusicStreamingMP3(path);
113  case ".ogg": return new MusicStreamingOGG(path);
114  }
115  throw new ResourceLoadException("Unknown music extension "+extension);
116  }
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41

+ Here is the call graph for this function:

virtual bool Terraria.ModLoader.Mod.LoadResource ( string  path,
int  length,
Func< Stream >  getStream 
)
virtual

Hook for pre-loading resources

Parameters
pathThe path of the resource within the tmod
lengthThe length of the uncompressed resource
getStreamA function which returns a stream containing the file content
Returns
true if the file will no-longer be needed and should not be cached

Definition at line 143 of file Mod.cs.

143  {
144  if (tModLoaderVersion < new Version(0, 11) && LoadResourceLegacy(path, length, getStream)) // TODO LoadResourceLegacy is marked obsolete
145  return false;
146 
147  string extension = Path.GetExtension(path).ToLower();
148  path = Path.ChangeExtension(path, null);
149  switch (extension) {
150  case ".png":
151  case ".rawimg":
152  if (!Main.dedServ)
153  LoadTexture(path, getStream(), extension == ".rawimg");
154  return true;
155  case ".wav":
156  case ".mp3":
157  case ".ogg":
158  //Main.engine == null would be more sensible, but only the waveBank fails on Linux when there is no audio hardware
159  if (Main.dedServ || Main.waveBank == null) { }
160  else if (path.Contains("Music/"))
161  musics[path] = LoadMusic(path, extension);
162  else
163  sounds[path] = LoadSound(getStream(), length, extension);
164  return true;
165  case ".xnb":
166  if (Main.dedServ) { }
167  else if (path.StartsWith("Fonts/"))
168  fonts[path] = Main.instance.OurLoad<DynamicSpriteFont>("tmod:"+Name+"/"+path);
169  else if (path.StartsWith("Effects/"))
170  effects[path] = Main.ShaderContentManager.Load<Effect>("tmod:"+Name+"/"+path);
171  else
172  throw new ResourceLoadException(Language.GetTextValue("tModLoader.LoadErrorUnknownXNBFileHint", path));
173  return true;
174  }
175 
176  return false;
177  }
SoundEffect LoadSound(Stream stream, int length, string extension)
Definition: ModInternals.cs:84
virtual Version Version
This version number of this mod.
Definition: Mod.cs:49
bool LoadResourceLegacy(string path, int length, Func< Stream > getStream)
Definition: Mod.cs:180
void LoadTexture(string path, Stream stream, bool rawimg)
Definition: ModInternals.cs:59
Music LoadMusic(string path, string extension)
Version tModLoaderVersion
The version of tModLoader that was being used when this mod was built.
Definition: Mod.cs:45
virtual string Name
Stores the name of the mod. This name serves as the mod&#39;s identification, and also helps with saving ...
Definition: Mod.cs:41
virtual void Terraria.ModLoader.Mod.LoadResourceFromStream ( string  path,
int  len,
BinaryReader  reader 
)
virtual

Definition at line 188 of file Mod.cs.

188  {
189  }
bool Terraria.ModLoader.Mod.LoadResourceLegacy ( string  path,
int  length,
Func< Stream >  getStream 
)
private

Definition at line 180 of file Mod.cs.

180  {
181  using (var stream = getStream()) {
182  LoadResourceFromStream(path, length, new BinaryReader(stream));
183  return stream.Position > 0;
184  }
185  }
virtual void LoadResourceFromStream(string path, int len, BinaryReader reader)
Definition: Mod.cs:188
virtual void Terraria.ModLoader.Mod.LoadResources ( )
virtual

Definition at line 103 of file Mod.cs.

Referenced by Terraria.ModLoader.ModContent.SetLocalizedText().

103  {
104  if (File == null)
105  return;
106 
107  fileHandle = File.Open();
108 
109  var skipCache = new HashSet<string>();
110  foreach (var entry in File) {
111  Interface.loadModsProgress.SubProgressText = entry.Name;
112 
113  Stream _stream = null;
114  Stream GetStream() => _stream = File.GetStream(entry);
115 
116  if (LoadResource(entry.Name, entry.Length, GetStream))
117  skipCache.Add(entry.Name);
118 
119  _stream?.Dispose();
120  }
121  File.CacheFiles(skipCache);
122  }
virtual bool LoadResource(string path, int length, Func< Stream > getStream)
Hook for pre-loading resources
Definition: Mod.cs:143
IDisposable fileHandle
Definition: Mod.cs:64

+ Here is the caller graph for this function:

SoundEffect Terraria.ModLoader.Mod.LoadSound ( Stream  stream,
int  length,
string  extension 
)
private

Definition at line 84 of file ModInternals.cs.

References Terraria.ModLoader.Audio.MusicStreamingOGG.Convert().

84  {
85  switch (extension) {
86  case ".wav":
87  if (!stream.CanSeek)
88  stream = new MemoryStream(stream.ReadBytes(length));
89  return SoundEffect.FromStream(stream);
90  case ".mp3":
91  using (var mp3Stream = new MP3Stream(stream))
92  using (var ms = new MemoryStream()) {
93  mp3Stream.CopyTo(ms);
94  return new SoundEffect(ms.ToArray(), mp3Stream.Frequency, (AudioChannels)mp3Stream.ChannelCount);
95  }
96  case ".ogg":
97  using (var reader = new VorbisReader(stream, true)) {
98  var buffer = new byte[reader.TotalSamples * 2 * reader.Channels];
99  var floatBuf = new float[buffer.Length / 2];
100  reader.ReadSamples(floatBuf, 0, floatBuf.Length);
101  MusicStreamingOGG.Convert(floatBuf, buffer);
102  return new SoundEffect(buffer, reader.SampleRate, (AudioChannels)reader.Channels);
103  }
104  }
105  throw new ResourceLoadException("Unknown sound extension "+extension);
106  }
static void Convert(float[] floatBuf, byte[] buffer)

+ Here is the call graph for this function:

void Terraria.ModLoader.Mod.LoadTexture ( string  path,
Stream  stream,
bool  rawimg 
)
private

Definition at line 59 of file ModInternals.cs.

References Terraria.ModLoader.IO.ImageIO.PngToTexture2DAsync(), and Terraria.ModLoader.IO.ImageIO.RawToTexture2DAsync().

59  {
60  try {
61  var texTask = rawimg
62  ? ImageIO.RawToTexture2DAsync(Main.instance.GraphicsDevice, new BinaryReader(stream))
63  : ImageIO.PngToTexture2DAsync(Main.instance.GraphicsDevice, stream);
64 
65  AsyncLoadQueue.Enqueue(texTask.ContinueWith(t => {
66  if (t.Exception != null)
67  throw new ResourceLoadException(
68  Language.GetTextValue("tModLoader.LoadErrorTextureFailedToLoad", path), t.Exception);
69 
70  var tex = t.Result;
71  tex.Name = Name + "/" + path;
72  lock (textures)
73  textures[path] = tex;
74  }));
75  }
76  catch (Exception e) {
77  throw new ResourceLoadException(Language.GetTextValue("tModLoader.LoadErrorTextureFailedToLoad", path), e);
78  }
79  finally {
80  stream.Close();
81  }
82  }
readonly Queue< Task > AsyncLoadQueue
Definition: ModInternals.cs:25
static Task< Texture2D > RawToTexture2DAsync(GraphicsDevice graphicsDevice, BinaryReader r)
Definition: ImageIO.cs:94
static Task< Texture2D > PngToTexture2DAsync(GraphicsDevice graphicsDevice, Stream stream)
Definition: ImageIO.cs:103

+ Here is the call graph for this function:

virtual void Terraria.ModLoader.Mod.MidUpdateDustTime ( )
virtual

Called after Dust got updated, but before Time (day/night, events, etc.) gets updated.

If you are looking to hook an earlier part of the update process, see MidUpdateItemDust. If you are looking to hook a later part of the update process, see MidUpdateTimeWorld.

Definition at line 139 of file ModHooks.cs.

139  {
140  }
virtual void Terraria.ModLoader.Mod.MidUpdateGoreProjectile ( )
virtual

Called after Gores got updated, but before any Projectiles get updated.

If you are looking to hook an earlier part of the update process, see MidUpdateNPCGore. If you are looking to hook a later part of the update process, see MidUpdateProjectileItem.

Definition at line 112 of file ModHooks.cs.

112  {
113  }
virtual void Terraria.ModLoader.Mod.MidUpdateInvasionNet ( )
virtual

Called after Invasions got updated. The only thing that is updated after this is the Network.

If you are looking to hook an earlier part of the update process, see MidUpdateTimeWorld. If you are looking to hook even after the Network is updated, see PostUpdateEverything.

Definition at line 157 of file ModHooks.cs.

157  {
158  }
virtual void Terraria.ModLoader.Mod.MidUpdateItemDust ( )
virtual

Called after Items got updated, but before any Dust gets updated.

If you are looking to hook an earlier part of the update process, see MidUpdateProjectileItem. If you are looking to hook a later part of the update process, see MidUpdateDustTime.

Definition at line 130 of file ModHooks.cs.

130  {
131  }
virtual void Terraria.ModLoader.Mod.MidUpdateNPCGore ( )
virtual

Called after NPCs got updated, but before any Gores get updated.

If you are looking to hook an earlier part of the update process, see MidUpdatePlayerNPC. If you are looking to hook a later part of the update process, see MidUpdateGoreProjectile.

Definition at line 103 of file ModHooks.cs.

103  {
104  }
virtual void Terraria.ModLoader.Mod.MidUpdatePlayerNPC ( )
virtual

Called after Players got updated, but before any NPCs get updated.

If you are looking to hook an earlier part of the update process, see PreUpdateEntities. If you are looking to hook a later part of the update process, see MidUpdateNPCGore.

Definition at line 94 of file ModHooks.cs.

94  {
95  }
virtual void Terraria.ModLoader.Mod.MidUpdateProjectileItem ( )
virtual

Gets called immediately after all Projectiles are updated, but before any Items get updated.

If you are looking to hook an earlier part of the update process, see MidUpdateGoreProjectile. If you are looking to hook a later part of the update process, see MidUpdateItemDust.

Definition at line 121 of file ModHooks.cs.

121  {
122  }
virtual void Terraria.ModLoader.Mod.MidUpdateTimeWorld ( )
virtual

Called after Time got updated, but before the World gets updated.

If you are looking to hook an earlier part of the update process, see MidUpdateDustTime. If you are looking to hook a later part of the update process, see MidUpdateInvasionNet.

Definition at line 148 of file ModHooks.cs.

148  {
149  }
virtual void Terraria.ModLoader.Mod.ModifyInterfaceLayers ( List< GameInterfaceLayer >  layers)
virtual

Allows you to modify the elements of the in-game interface that get drawn. GameInterfaceLayer can be found in the Terraria.UI namespace. Check https://github.com/tModLoader/tModLoader/wiki/Vanilla-Interface-layers-values for vanilla interface layer names

Parameters
layersThe layers.

Definition at line 172 of file ModHooks.cs.

172  {
173  }
virtual void Terraria.ModLoader.Mod.ModifyLightingBrightness ( ref float  scale)
virtual

Allows you to modify overall brightness of lights. Can be used to create effects similiar to what night vision and darkness (de)buffs give you. Values too high or too low might result in glitches. For night vision effect use scale 1.03

Parameters
scaleBrightness scale

Definition at line 187 of file ModHooks.cs.

187  {
188  }
virtual void Terraria.ModLoader.Mod.ModifySunLightColor ( ref Color  tileColor,
ref Color  backgroundColor 
)
virtual

Allows you to modify color of light the sun emits.

Parameters
tileColorTile lighting color
backgroundColorBackground lighting color

Definition at line 180 of file ModHooks.cs.

180  {
181  }
virtual void Terraria.ModLoader.Mod.ModifyTransformMatrix ( ref SpriteViewMatrix  Transform)
virtual

Allows you to set the transformation of the screen that is drawn. (Translations, rotations, scales, etc.)

Definition at line 68 of file ModHooks.cs.

68  {
69  }
int Terraria.ModLoader.Mod.MountType ( string  name)

Gets the ID of the ModMountData instance corresponding to the given name. Returns 0 if no ModMountData has the given name.

Parameters
nameThe name.
Returns

Same as the other MountType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModMountData 
T :MountType 
T :typeof 
T :T 
T :Name 
bool Terraria.ModLoader.Mod.MusicExists ( string  name)

Shorthand for calling ModLoader.MusicExists(this.FileName(name)).

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.ModContent.MusicExists().

+ Here is the caller graph for this function:

int Terraria.ModLoader.Mod.NPCType ( string  name)

Gets the type of the ModNPC of this mod with the given name. Returns 0 if no ModNPC with the given name is found.

Parameters
nameThe name.
Returns

Same as the other NPCType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModNPC 
T :NPCType 
T :typeof 
T :T 
T :Name 
virtual void Terraria.ModLoader.Mod.PostAddRecipes ( )
virtual

This provides a hook into the mod-loading process immediately after recipes have been added. You can use this to edit recipes added by other mods.

Definition at line 100 of file Mod.cs.

100  {
101  }
virtual void Terraria.ModLoader.Mod.PostDrawFullscreenMap ( ref string  mouseText)
virtual

Called while the fullscreen map is active. Allows custom drawing to the map.

Parameters
mouseTextThe mouse text.

Definition at line 203 of file ModHooks.cs.

203  {
204  }
virtual void Terraria.ModLoader.Mod.PostDrawInterface ( SpriteBatch  spriteBatch)
virtual

Called after interface is drawn but right before mouse and mouse hover text is drawn. Allows for drawing interface.

Note: This hook should no longer be used. It is better to use the ModifyInterfaceLayers hook.

Parameters
spriteBatchThe sprite batch.

Definition at line 196 of file ModHooks.cs.

196  {
197  }
virtual void Terraria.ModLoader.Mod.PostSetupContent ( )
virtual

Allows you to load things in your mod after its content has been setup (arrays have been resized to fit the content, etc).

Definition at line 76 of file Mod.cs.

Referenced by Terraria.ModLoader.ModContent.SetLocalizedText().

76  {
77  }

+ Here is the caller graph for this function:

virtual void Terraria.ModLoader.Mod.PostUpdateEverything ( )
virtual

Called after the Network got updated, this is the last hook that happens in an update.

If you are looking to hook an earlier part of the update process, see MidUpdateInvasionNet.

Definition at line 165 of file ModHooks.cs.

165  {
166  }
virtual void Terraria.ModLoader.Mod.PostUpdateInput ( )
virtual

Called after the input keys are polled. Allows for modifying things like scroll wheel if your custom drawing should capture that.

Definition at line 209 of file ModHooks.cs.

209  {
210  }
byte Terraria.ModLoader.Mod.PrefixType ( string  name)

Gets the internal ID / type of the ModPrefix corresponding to the name. Returns 0 if no ModPrefix with the given name is found.

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.IO.ItemIO.Load().

+ Here is the caller graph for this function:

Same as the other PrefixType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModPrefix 
T :PrefixType 
T :typeof 
T :T 
T :Name 
virtual void Terraria.ModLoader.Mod.PreSaveAndQuit ( )
virtual

Called in SP or Client when the Save and Quit button is pressed. One use for this hook is clearing out custom UI slots to return items to the player.

Definition at line 215 of file ModHooks.cs.

References Terraria.ModLoader.ModLoader.Mods.

215  {
216  }
virtual void Terraria.ModLoader.Mod.PreUpdateEntities ( )
virtual

Use this if you want to do something before anything in the World gets updated. Called after UI updates, but before anything in the World (Players, NPCs, Projectiles, Tiles) gets updated.

When Main.autoPause is true or Main.FrameSkipMode is 0 or 2, the game may do a partial update. This means that it only updates menus and some animations, but not the World or Entities. This hook - and every hook after it - only gets called on frames with a full update.

If you are looking to hook a later part of the update process, see MidUpdatePlayerNPC.

Definition at line 85 of file ModHooks.cs.

85  {
86  }
int Terraria.ModLoader.Mod.ProjectileType ( string  name)

Gets the type of the ModProjectile of this mod with the given name. Returns 0 if no ModProjectile with the given name is found.

Parameters
nameThe name.
Returns

Same as the other ProjectileType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModProjectile 
T :ProjectileType 
T :typeof 
T :T 
T :Name 
ModHotKey Terraria.ModLoader.Mod.RegisterHotKey ( string  name,
string  defaultKey 
)

Registers a hotkey with a name and defaultKey. Use the returned ModHotKey to detect when buttons are pressed. Do this in a ModPlayer.ProcessTriggers.

Parameters
nameThe name.
defaultKeyThe default key.
Returns

Definition at line 1462 of file Mod.cs.

1462  {
1463  if (!loading)
1464  throw new Exception("RegisterHotKey can only be called from Mod.Load or Mod.Autoload");
1465 
1466  return ModContent.RegisterHotKey(this, name, defaultKey);
1467  }
bool Terraria.ModLoader.Mod.SoundExists ( string  name)

Shorthand for calling ModLoader.SoundExists(this.FileName(name)).

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.ModContent.SoundExists().

+ Here is the caller graph for this function:

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

Shorthand for calling ModLoader.TextureExists(this.FileName(name)).

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.ModContent.TextureExists().

+ Here is the caller graph for this function:

int Terraria.ModLoader.Mod.TileEntityType ( string  name)

Gets the type of the ModTileEntity of this mod with the given name. Returns -1 if no ModTileEntity with the given name is found.

Parameters
nameThe name.
Returns

Same as the other TileEntityType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModTileEntity 
T :TileEntityType 
T :typeof 
T :T 
T :Name 
int Terraria.ModLoader.Mod.TileType ( string  name)

Gets the type of the ModTile of this mod with the given name. Returns 0 if no ModTile with the given name is found.

Parameters
nameThe name.
Returns

Referenced by Terraria.ModLoader.ModRecipe.AddTile().

+ Here is the caller graph for this function:

Same as the other TileType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModTile 
T :TileType 
T :typeof 
T :T 
T :Name 
virtual void Terraria.ModLoader.Mod.Unload ( )
virtual

This is called whenever this mod is unloaded from the game. Use it to undo changes that you've made in Load that aren't automatically handled (for example, modifying the texture of a vanilla item). Mods are guaranteed to be unloaded in the reverse order they were loaded in.

Definition at line 82 of file Mod.cs.

82  {
83  }
virtual void Terraria.ModLoader.Mod.UpdateMusic ( ref int  music,
ref MusicPriority  priority 
)
virtual

Allows you to determine what music should currently play.

Parameters
musicThe music.
priorityThe music priority.

Definition at line 20 of file ModHooks.cs.

20  {
21  UpdateMusic(ref music);
22  }
virtual void UpdateMusic(ref int music, ref MusicPriority priority)
Allows you to determine what music should currently play.
Definition: ModHooks.cs:20
virtual void Terraria.ModLoader.Mod.UpdateMusic ( ref int  music)
virtual

A legacy hook that you should no longer use. Use the version with two parameters instead.

Parameters
music

Definition at line 29 of file ModHooks.cs.

29  {
30  }
virtual void Terraria.ModLoader.Mod.UpdateUI ( GameTime  gameTime)
virtual

Ran every update and suitable for calling Update for UserInterface classes

Definition at line 74 of file ModHooks.cs.

74  {
75  }
int Terraria.ModLoader.Mod.WallType ( string  name)

Gets the type of the ModWall of this mod with the given name. Returns 0 if no ModWall with the given name is found.

Parameters
nameThe name.
Returns

Same as the other WallType, but assumes that the class name and internal name are the same.

Template Parameters
T
Returns
Type Constraints
T :ModWall 
T :WallType 
T :typeof 
T :T 
T :Name 

Member Data Documentation

readonly Queue<Task> Terraria.ModLoader.Mod.AsyncLoadQueue = new Queue<Task>()
private

Definition at line 25 of file ModInternals.cs.

IDisposable Terraria.ModLoader.Mod.fileHandle
private

Definition at line 64 of file Mod.cs.

bool Terraria.ModLoader.Mod.IsNetSynced => netID >= 0

Definition at line 62 of file Mod.cs.

virtual string Terraria.ModLoader.Mod.Name => File.name

Stores the name of the mod. This name serves as the mod's identification, and also helps with saving everything your mod adds. By default this returns the name of the folder that contains all your code and stuff.

Definition at line 41 of file Mod.cs.

Referenced by Terraria.ModLoader.PlayerHooks.AddHook< F >(), Terraria.ModLoader.ModRecipe.AddIngredient(), Terraria.ModLoader.ModRecipe.AddTile(), Terraria.ModLoader.Mod.AutoloadBuff(), Terraria.ModLoader.Mod.AutoloadDust(), Terraria.ModLoader.Mod.AutoloadGlobalBgStyle(), Terraria.ModLoader.Mod.AutoloadGlobalBuff(), Terraria.ModLoader.Mod.AutoloadGlobalItem(), Terraria.ModLoader.Mod.AutoloadGlobalNPC(), Terraria.ModLoader.Mod.AutoloadGlobalProjectile(), Terraria.ModLoader.Mod.AutoloadGlobalRecipe(), Terraria.ModLoader.Mod.AutoloadGlobalTile(), Terraria.ModLoader.Mod.AutoloadGlobalWall(), Terraria.ModLoader.Mod.AutoloadItem(), Terraria.ModLoader.Mod.AutoloadModWorld(), Terraria.ModLoader.Mod.AutoloadMountData(), Terraria.ModLoader.Mod.AutoloadNPC(), Terraria.ModLoader.Mod.AutoloadPlayer(), Terraria.ModLoader.Mod.AutoloadPrefix(), Terraria.ModLoader.Mod.AutoloadProjectile(), Terraria.ModLoader.Mod.AutoloadSurfaceBgStyle(), Terraria.ModLoader.Mod.AutoloadTile(), Terraria.ModLoader.Mod.AutoloadTileEntity(), Terraria.ModLoader.Mod.AutoloadUgBgStyle(), Terraria.ModLoader.Mod.AutoloadWall(), Terraria.ModLoader.Mod.AutoloadWaterfallStyle(), Terraria.ModLoader.Mod.AutoloadWaterStyle(), Terraria.ModLoader.Exceptions.CustomModDataException.CustomModDataException(), Terraria.ModLoader.IO.ItemIO.LoadLegacy(), Terraria.ModLoader.IO.ItemIO.Save(), Terraria.ModLoader.PlayerHooks.SendCustomBiomes(), Terraria.ModLoader.ModContent.SetLocalizedText(), Terraria.ModLoader.ModRecipe.SetResult(), Terraria.ModLoader.ModNet.SetupDiagnostics(), Terraria.ModLoader.MonoModHooks.StringRep(), and Terraria.ModLoader.TooltipLine.TooltipLine().

virtual Version Terraria.ModLoader.Mod.Version => File.version

This version number of this mod.

Definition at line 49 of file Mod.cs.

Property Documentation

Assembly Terraria.ModLoader.Mod.Code
getset

The assembly code this is loaded when tModLoader loads this mod.

Definition at line 32 of file Mod.cs.

string Terraria.ModLoader.Mod.DisplayName
getset

The display name of this mod in the Mods menu.

Definition at line 59 of file Mod.cs.

ILog Terraria.ModLoader.Mod.Logger
getset

A logger with this mod's name for easy logging.

Definition at line 36 of file Mod.cs.

Referenced by Terraria.ModLoader.ErrorLogger.Log().

ModProperties Terraria.ModLoader.Mod.Properties
getprotected set

Definition at line 51 of file Mod.cs.

ModSide Terraria.ModLoader.Mod.Side = ModProperties.AutoLoadAll
getset

The ModSide that controls how this mod is synced between client and server.

Definition at line 55 of file Mod.cs.

Version Terraria.ModLoader.Mod.tModLoaderVersion
getset

The version of tModLoader that was being used when this mod was built.

Definition at line 45 of file Mod.cs.