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 (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...
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...
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...
T	GetBuff< T > ()
ModConfig	GetConfig (string name)
T	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...
T	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...
T	GetGlobalBgStyle< T > ()
GlobalBuff	GetGlobalBuff (string name)
	Gets the GlobalBuff with the given name from this mod. More...
T	GetGlobalBuff< T > ()
GlobalItem	GetGlobalItem (string name)
	Gets the GlobalItem instance with the given name from this mod. More...
T	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...
T	GetGlobalNPC< T > ()
GlobalProjectile	GetGlobalProjectile (string name)
	Gets the GlobalProjectile instance with the given name from this mod. More...
T	GetGlobalProjectile< T > ()
GlobalRecipe	GetGlobalRecipe (string name)
	Gets the global recipe corresponding to the specified name. More...
T	GetGlobalRecipe< T > ()
GlobalTile	GetGlobalTile (string name)
	Gets the GlobalTile instance with the given name from this mod. More...
T	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...
T	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...
T	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...
T	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...
T	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...
T	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...
T	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...
T	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...
T	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...
T	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...
T	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...
T	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...
T	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...
T	GetWall< T > ()
ModWaterfallStyle	GetWaterfallStyle (string name)
	Returns the waterfall style with the given name from this mod. More...
T	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...
T	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)
	A legacy hook that you should no longer use. Use the version with two parameters instead. More...
virtual void	UpdateMusic (ref int music, ref MusicPriority priority)
	Allows you to determine what music should currently play. 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...

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...
virtual uint	ExtraPlayerBuffSlots [get]
	The amount of extra buff slots this mod desires for Players. This value is checked after Mod.Load but before Mod.PostSetupContent. The actual number of buffs the player can use will be 22 plus the max value of all enabled mods. In-game use Player.MaxBuffs to check the maximum number of buffs. More...
bool	IsNetSynced [get]
ILog	Logger [get, set]
	A logger with this mod's name for easy logging. More...
virtual string	Name [get]
	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...
ModProperties	Properties = ModProperties.AutoLoadAll [get, protected set]
ModSide	Side [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...
virtual Version	Version [get]
	This version number of this mod. 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 24 of file Mod.cs.

Member Function Documentation

AddBackgroundTexture()

void Terraria.ModLoader.Mod.AddBackgroundTexture

(

string

texture

)

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

Parameters

texture

The texture.

Definition at line 1393 of file Mod.cs.

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

References Terraria.ModLoader.ModContent.GetTexture().

Referenced by Terraria.ModLoader.Mod.AutoloadBackgrounds().

Here is the call graph for this function:

Here is the caller graph for this function:

AddBossHeadTexture()

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

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

Parameters

texture	The texture.
npcType	An optional npc id for NPCID.Sets.BossHeadTextures

Definition at line 931 of file Mod.cs.

                                                                         {
            if (!loading)
                throw new Exception("AddBossHeadTexture can only be called from Mod.Load or Mod.Autoload");
 
            int slot = NPCHeadLoader.ReserveBossHeadSlot(texture);
            NPCHeadLoader.bossHeads[texture] = slot;
            ModContent.GetTexture(texture);
            if (npcType >= 0) {
                NPCHeadLoader.npcToBossHead[npcType] = slot;
            }
        }

References Terraria.ModLoader.ModContent.GetTexture().

Referenced by Terraria.ModLoader.Mod.AutoloadNPC().

Here is the call graph for this function:

Here is the caller graph for this function:

AddBuff()

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

name	The name.
buff	The buff.
texture	The texture.

Definition at line 976 of file Mod.cs.

                                                                       {
            if (!loading)
                throw new Exception("AddBuff can only be called from Mod.Load or Mod.Autoload");
 
            if (buffs.ContainsKey(name))
                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.");
 
            buff.mod = this;
            buff.Name = name;
            buff.Type = BuffLoader.ReserveBuffID();
            buff.texture = texture;
            buff.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.BuffName.{1}", Name, name));
            buff.Description = GetOrCreateTranslation(string.Format("Mods.{0}.BuffDescription.{1}", Name, name));
 
            buffs[name] = buff;
            BuffLoader.buffs.Add(buff);
            ContentInstance.Register(buff);
        }

References Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadBuff().

Here is the call graph for this function:

Here is the caller graph for this function:

AddCommand()

void Terraria.ModLoader.Mod.AddCommand	(	string	name,
		ModCommand	mc
	)

Manually add a Command during Load

Definition at line 1438 of file Mod.cs.

                                                           {
            if (!loading)
                throw new Exception("AddCommand can only be called from Mod.Load or Mod.Autoload");
 
            mc.mod = this;
            mc.Name = name;
            CommandManager.Add(mc);
        }

Referenced by Terraria.ModLoader.Mod.AutoloadCommand().

Here is the caller graph for this function:

AddConfig()

void Terraria.ModLoader.Mod.AddConfig	(	string	name,
		ModConfig	mc
	)

Definition at line 225 of file Mod.cs.

        {
            mc.Name = name;
            mc.mod = this;
 
            ConfigManager.Add(mc);
            ContentInstance.Register(mc);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Here is the call graph for this function:

AddDust()

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

name	The name.
dust	The dust.
texture	The texture.

Definition at line 485 of file Mod.cs.

                                                                            {
            if (!loading)
                throw new Exception("AddDust can only be called from Mod.Load or Mod.Autoload");
 
            dust.mod = this;
            dust.Name = name;
            dust.Type = ModDust.ReserveDustID();
            dust.Texture = !string.IsNullOrEmpty(texture) ? ModContent.GetTexture(texture) : Main.dustTexture;
 
            dusts[name] = dust;
            ModDust.dusts.Add(dust);
            ContentInstance.Register(dust);
        }

References Terraria.ModLoader.ModContent.GetTexture(), and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadDust().

Here is the call graph for this function:

Here is the caller graph for this function:

AddEquipTexture() [1/2]

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

equipTexture	The equip texture.
item	The item.
type	The type.
name	The name.
texture	The texture.
armTexture	The arm texture (for body slots).
femaleTexture	The female texture (for body slots), if missing the regular body texture is used.

Returns

Definition at line 363 of file Mod.cs.

                                                               {
            if (!loading)
                throw new Exception("AddEquipTexture can only be called from Mod.Load or Mod.Autoload");
 
            ModContent.GetTexture(texture); //ensure texture exists
 
            equipTexture.Texture = texture;
            equipTexture.mod = this;
            equipTexture.Name = name;
            equipTexture.Type = type;
            equipTexture.item = item;
            int slot = equipTexture.Slot = EquipLoader.ReserveEquipID(type);
 
            EquipLoader.equipTextures[type][slot] = equipTexture;
            equipTextures[Tuple.Create(name, type)] = equipTexture;
 
            if (type == EquipType.Body) {
                if (femaleTexture == null || !ModContent.TextureExists(femaleTexture))
                    femaleTexture = texture;
                EquipLoader.femaleTextures[slot] = femaleTexture;
 
                ModContent.GetTexture(armTexture); //ensure texture exists
                EquipLoader.armTextures[slot] = armTexture;
            }
            if (item != null) {
                IDictionary<EquipType, int> slots;
                if (!EquipLoader.idToSlot.TryGetValue(item.item.type, out slots))
                    EquipLoader.idToSlot[item.item.type] = slots = new Dictionary<EquipType, int>();
 
                slots[type] = slot;
                if (type == EquipType.Head || type == EquipType.Body || type == EquipType.Legs)
                    EquipLoader.slotToId[type][slot] = item.item.type;
            }
            return slot;
        }

References Terraria.ModLoader.ModContent.GetTexture(), Terraria.ModLoader.ModItem.item, and Terraria.ModLoader.ModContent.TextureExists().

Here is the call graph for this function:

AddEquipTexture() [2/2]

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

item	The item.
type	The type.
name	The name.
texture	The texture.
armTexture	The arm texture (for body slots).
femaleTexture	The female texture (for body slots), if missing the regular body texture is used.

Returns

Definition at line 345 of file Mod.cs.

                                                               {
            return AddEquipTexture(new EquipTexture(), item, type, name, texture, armTexture, femaleTexture);
        }

References Terraria.ModLoader.Mod.AddEquipTexture().

Referenced by Terraria.ModLoader.Mod.AddEquipTexture(), and Terraria.ModLoader.Mod.AutoloadItem().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGlobalBgStyle()

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

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

Parameters

name	The name.
globalBgStyle	The global bg style.

Definition at line 1232 of file Mod.cs.

                                                                               {
            if (!loading)
                throw new Exception("AddGlobalBgStyle can only be called from Mod.Load or Mod.Autoload");
 
            globalBgStyle.mod = this;
            globalBgStyle.Name = name;
 
            globalBgStyles[name] = globalBgStyle;
            GlobalBgStyleLoader.globalBgStyles.Add(globalBgStyle);
            ContentInstance.Register(globalBgStyle);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGlobalBgStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGlobalBuff()

void Terraria.ModLoader.Mod.AddGlobalBuff	(	string	name,
		GlobalBuff	globalBuff
	)

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

Parameters

name	The name.
globalBuff	The global buff.

Definition at line 1025 of file Mod.cs.

                                                                      {
            globalBuff.mod = this;
            globalBuff.Name = name;
 
            globalBuffs[name] = globalBuff;
            BuffLoader.globalBuffs.Add(globalBuff);
            ContentInstance.Register(globalBuff);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGlobalBuff().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGlobalItem()

void Terraria.ModLoader.Mod.AddGlobalItem	(	string	name,
		GlobalItem	globalItem
	)

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

Parameters

name	The name.
globalItem	The global item.

Definition at line 295 of file Mod.cs.

                                                                      {
            if (!loading)
                throw new Exception("AddGlobalItem can only be called from Mod.Load or Mod.Autoload");
 
            ItemLoader.VerifyGlobalItem(globalItem);
 
            globalItem.mod = this;
            globalItem.Name = name;
 
            globalItems[name] = globalItem;
            globalItem.index = ItemLoader.globalItems.Count;
            ItemLoader.globalIndexes[Name + ':' + name] = ItemLoader.globalItems.Count;
            if (ItemLoader.globalIndexesByType.ContainsKey(globalItem.GetType())) {
                ItemLoader.globalIndexesByType[globalItem.GetType()] = -1;
            }
            else {
                ItemLoader.globalIndexesByType[globalItem.GetType()] = ItemLoader.globalItems.Count;
            }
            ItemLoader.globalItems.Add(globalItem);
            ContentInstance.Register(globalItem);
        }

References Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGlobalItem().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGlobalNPC()

void Terraria.ModLoader.Mod.AddGlobalNPC	(	string	name,
		GlobalNPC	globalNPC
	)

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

Parameters

name	The name.
globalNPC	The global NPC.

Definition at line 871 of file Mod.cs.

                                                                   {
            if (!loading)
                throw new Exception("AddGlobalNPC can only be called from Mod.Load or Mod.Autoload");
 
            NPCLoader.VerifyGlobalNPC(globalNPC);
 
            globalNPC.mod = this;
            globalNPC.Name = name;
 
            globalNPCs[name] = globalNPC;
            globalNPC.index = NPCLoader.globalNPCs.Count;
            NPCLoader.globalIndexes[Name + ':' + name] = NPCLoader.globalNPCs.Count;
            if (NPCLoader.globalIndexesByType.ContainsKey(globalNPC.GetType())) {
                NPCLoader.globalIndexesByType[globalNPC.GetType()] = -1;
            }
            else {
                NPCLoader.globalIndexesByType[globalNPC.GetType()] = NPCLoader.globalNPCs.Count;
            }
            NPCLoader.globalNPCs.Add(globalNPC);
            ContentInstance.Register(globalNPC);
        }

References Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGlobalNPC().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGlobalProjectile()

void Terraria.ModLoader.Mod.AddGlobalProjectile	(	string	name,
		GlobalProjectile	globalProjectile
	)

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

Parameters

name	The name.
globalProjectile	The global projectile.

Definition at line 787 of file Mod.cs.

                                                                                        {
            if (!loading)
                throw new Exception("AddGlobalProjectile can only be called from Mod.Load or Mod.Autoload");
 
            ProjectileLoader.VerifyGlobalProjectile(globalProjectile);
 
            globalProjectile.mod = this;
            globalProjectile.Name = name;
 
            globalProjectiles[name] = globalProjectile;
            globalProjectile.index = ProjectileLoader.globalProjectiles.Count;
            ProjectileLoader.globalIndexes[Name + ':' + name] = ProjectileLoader.globalProjectiles.Count;
            if (ProjectileLoader.globalIndexesByType.ContainsKey(globalProjectile.GetType())) {
                ProjectileLoader.globalIndexesByType[globalProjectile.GetType()] = -1;
            }
            else {
                ProjectileLoader.globalIndexesByType[globalProjectile.GetType()] = ProjectileLoader.globalProjectiles.Count;
            }
            ProjectileLoader.globalProjectiles.Add(globalProjectile);
            ContentInstance.Register(globalProjectile);
        }

References Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGlobalProjectile().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGlobalRecipe()

void Terraria.ModLoader.Mod.AddGlobalRecipe	(	string	name,
		GlobalRecipe	globalRecipe
	)

Manually add a Global Recipe during Load

Parameters

name	The name.
globalRecipe	The global recipe.

Definition at line 1413 of file Mod.cs.

                                                                            {
            if (!loading)
                throw new Exception("AddGlobalRecipe can only be called from Mod.Load or Mod.Autoload");
 
            globalRecipe.mod = this;
            globalRecipe.Name = name;
 
            globalRecipes[name] = globalRecipe;
            RecipeHooks.Add(globalRecipe);
            ContentInstance.Register(globalRecipe);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGlobalRecipe().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGlobalTile()

void Terraria.ModLoader.Mod.AddGlobalTile	(	string	name,
		GlobalTile	globalTile
	)

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

Parameters

name	The name.
globalTile	The global tile.

Definition at line 587 of file Mod.cs.

                                                                      {
            if (!loading)
                throw new Exception("AddGlobalTile can only be called from Mod.Load or Mod.Autoload");
 
            globalTile.mod = this;
            globalTile.Name = name;
 
            globalTiles[name] = globalTile;
            TileLoader.globalTiles.Add(globalTile);
            ContentInstance.Register(globalTile);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGlobalTile().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGlobalWall()

void Terraria.ModLoader.Mod.AddGlobalWall	(	string	name,
		GlobalWall	globalWall
	)

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

Parameters

name	The name.
globalWall	The global wall.

Definition at line 713 of file Mod.cs.

                                                                      {
            if (!loading)
                throw new Exception("AddGlobalWall can only be called from Mod.Load or Mod.Autoload");
 
            globalWall.mod = this;
            globalWall.Name = name;
 
            globalWalls[name] = globalWall;
            WallLoader.globalWalls.Add(globalWall);
            ContentInstance.Register(globalWall);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGlobalWall().

Here is the call graph for this function:

Here is the caller graph for this function:

AddGore()

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

texture	The texture.
modGore	The mod gore.

Definition at line 1330 of file Mod.cs.

                                                                    {
            if (!loading)
                throw new Exception("AddGore can only be called from Mod.Load or Mod.Autoload");
 
            int id = ModGore.ReserveGoreID();
            ModGore.gores[texture] = id;
            if (modGore != null) {
                ModGore.modGores[id] = modGore;
                ContentInstance.Register(modGore);
            }
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadGores().

Here is the call graph for this function:

Here is the caller graph for this function:

AddItem()

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

name	The name.
item	The item.

Exceptions

System.Exception

You 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 240 of file Mod.cs.

                                                       {
            if (!loading)
                throw new Exception(Language.GetTextValue("tModLoader.LoadErrorAddItemOnlyInLoad"));
 
            if (items.ContainsKey(name))
                throw new Exception(Language.GetTextValue("tModLoader.LoadError2ModItemSameName", name));
 
            item.mod = this;
            item.Name = name;
            item.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.ItemName.{1}", Name, name));
            item.Tooltip = GetOrCreateTranslation(string.Format("Mods.{0}.ItemTooltip.{1}", Name, name), true);
 
            item.item.ResetStats(ItemLoader.ReserveItemID());
            item.item.modItem = item;
 
            items[name] = item;
            ItemLoader.items.Add(item);
            ContentInstance.Register(item);
        }

References Terraria.ModLoader.ModItem.item, Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadItem().

Here is the call graph for this function:

Here is the caller graph for this function:

AddModWorld()

void Terraria.ModLoader.Mod.AddModWorld	(	string	name,
		ModWorld	modWorld
	)

Adds a ModWorld to this mod with the given name.

Parameters

name	The name.
modWorld	The mod world.

Definition at line 1135 of file Mod.cs.

                                                                {
            if (!loading)
                throw new Exception("AddModWorld can only be called from Mod.Load or Mod.Autoload");
 
            modWorld.mod = this;
            modWorld.Name = name;
 
            worlds[name] = modWorld;
            WorldHooks.Add(modWorld);
            ContentInstance.Register(modWorld);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadModWorld().

Here is the call graph for this function:

Here is the caller graph for this function:

AddMount()

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

name	The name.
mount	The mount.
texture	The texture.
extraTextures	The extra textures.

Definition at line 1051 of file Mod.cs.

                                                                        {
            if (!loading)
                throw new Exception("AddMount can only be called from Mod.Load or Mod.Autoload");
 
            if (Mount.mounts == null || Mount.mounts.Length == MountID.Count)
                Mount.Initialize();
 
            mount.mod = this;
            mount.Name = name;
            mount.Type = MountLoader.ReserveMountID();
            mount.texture = texture;
 
            mountDatas[name] = mount;
            MountLoader.mountDatas[mount.Type] = mount;
            ContentInstance.Register(mount);
 
            if (extraTextures == null)
                return;
 
            foreach (var entry in extraTextures) {
                if (!ModContent.TextureExists(entry.Value))
                    continue;
 
                Texture2D extraTexture = ModContent.GetTexture(entry.Value);
                switch (entry.Key) {
                    case MountTextureType.Back:
                        mount.mountData.backTexture = extraTexture;
                        break;
                    case MountTextureType.BackGlow:
                        mount.mountData.backTextureGlow = extraTexture;
                        break;
                    case MountTextureType.BackExtra:
                        mount.mountData.backTextureExtra = extraTexture;
                        break;
                    case MountTextureType.BackExtraGlow:
                        mount.mountData.backTextureExtraGlow = extraTexture;
                        break;
                    case MountTextureType.Front:
                        mount.mountData.frontTexture = extraTexture;
                        break;
                    case MountTextureType.FrontGlow:
                        mount.mountData.frontTextureGlow = extraTexture;
                        break;
                    case MountTextureType.FrontExtra:
                        mount.mountData.frontTextureExtra = extraTexture;
                        break;
                    case MountTextureType.FrontExtraGlow:
                        mount.mountData.frontTextureExtraGlow = extraTexture;
                        break;
                }
            }
        }

References Terraria.ModLoader.ModContent.GetTexture(), Terraria.ModLoader.ContentInstance< T >.Register(), and Terraria.ModLoader.ModContent.TextureExists().

Referenced by Terraria.ModLoader.Mod.AutoloadMountData().

Here is the call graph for this function:

Here is the caller graph for this function:

AddMusicBox()

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

musicSlot	The music slot.
itemType	Type of the item.
tileType	Type of the tile.
tileFrameY	The tile frame y.

Exceptions

System.ArgumentOutOfRangeException

Cannot 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 </exception> <exception cref="System.ArgumentException"> Music 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 1475 of file Mod.cs.

                                                                                               {
            if (!loading)
                throw new Exception("AddMusicBox can only be called from Mod.Load or Mod.Autoload");
 
            if (Main.waveBank == null)
                return;
 
            if (musicSlot < Main.maxMusic) {
                throw new ArgumentOutOfRangeException("Cannot assign music box to vanilla music ID " + musicSlot);
            }
            if (musicSlot >= SoundLoader.SoundCount(SoundType.Music)) {
                throw new ArgumentOutOfRangeException("Music ID " + musicSlot + " does not exist");
            }
            if (itemType < ItemID.Count) {
                throw new ArgumentOutOfRangeException("Cannot assign music box to vanilla item ID " + itemType);
            }
            if (ItemLoader.GetItem(itemType) == null) {
                throw new ArgumentOutOfRangeException("Item ID " + itemType + " does not exist");
            }
            if (tileType < TileID.Count) {
                throw new ArgumentOutOfRangeException("Cannot assign music box to vanilla tile ID " + tileType);
            }
            if (TileLoader.GetTile(tileType) == null) {
                throw new ArgumentOutOfRangeException("Tile ID " + tileType + " does not exist");
            }
            if (SoundLoader.musicToItem.ContainsKey(musicSlot)) {
                throw new ArgumentException("Music ID " + musicSlot + " has already been assigned a music box");
            }
            if (SoundLoader.itemToMusic.ContainsKey(itemType)) {
                throw new ArgumentException("Item ID " + itemType + " has already been assigned a music");
            }
            if (!SoundLoader.tileToMusic.ContainsKey(tileType)) {
                SoundLoader.tileToMusic[tileType] = new Dictionary<int, int>();
            }
            if (SoundLoader.tileToMusic[tileType].ContainsKey(tileFrameY)) {
                string message = "Y-frame " + tileFrameY + " of tile type " + tileType + " has already been assigned a music";
                throw new ArgumentException(message);
            }
            if (tileFrameY % 36 != 0) {
                throw new ArgumentException("Y-frame must be divisible by 36");
            }
            SoundLoader.musicToItem[musicSlot] = itemType;
            SoundLoader.itemToMusic[itemType] = musicSlot;
            SoundLoader.tileToMusic[tileType][tileFrameY] = musicSlot;
        }

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

Here is the call graph for this function:

AddNPC()

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

name	The name.
npc	The NPC.

Definition at line 824 of file Mod.cs.

                                                    {
            if (!loading)
                throw new Exception("AddNPC can only be called from Mod.Load or Mod.Autoload");
 
            if (npcs.ContainsKey(name))
                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.");
 
            npc.mod = this;
            npc.Name = name;
            npc.npc.type = NPCLoader.ReserveNPCID();
            npc.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.NPCName.{1}", Name, name));
 
            npcs[name] = npc;
            NPCLoader.npcs.Add(npc);
            ContentInstance.Register(npc);
        }

References Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadNPC().

Here is the call graph for this function:

Here is the caller graph for this function:

AddNPCHeadTexture()

void Terraria.ModLoader.Mod.AddNPCHeadTexture	(	int	npcType,
		string	texture
	)

Assigns a head texture to the given town NPC type.

Parameters

npcType	Type of the NPC.
texture	The texture.

Exceptions

MissingResourceException

Definition at line 909 of file Mod.cs.

                                                                   {
            if (!loading)
                throw new Exception("AddNPCHeadTexture can only be called from Mod.Load or Mod.Autoload");
 
            int slot = NPCHeadLoader.ReserveHeadSlot();
            NPCHeadLoader.heads[texture] = slot;
            if (!Main.dedServ) {
                ModContent.GetTexture(texture);
            }
            /*else if (Main.dedServ && !(ModLoader.FileExists(texture + ".png") || ModLoader.FileExists(texture + ".rawimg")))
            {
                throw new MissingResourceException(texture);
            }*/
            NPCHeadLoader.npcToHead[npcType] = slot;
            NPCHeadLoader.headToNPC[slot] = npcType;
        }

References Terraria.ModLoader.ModContent.GetTexture().

Referenced by Terraria.ModLoader.Mod.AutoloadNPC().

Here is the call graph for this function:

Here is the caller graph for this function:

AddPlayer()

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

name	The name.
player	The player.

Definition at line 948 of file Mod.cs.

                                                             {
            if (!loading)
                throw new Exception("AddPlayer can only be called from Mod.Load or Mod.Autoload");
 
            player.mod = this;
            player.Name = name;
 
            players[name] = player;
            PlayerHooks.Add(player);
            ContentInstance.Register(player);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadPlayer().

Here is the call graph for this function:

Here is the caller graph for this function:

AddPrefix()

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

name	The name.
prefix	The prefix.

Exceptions

System.Exception

You 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 431 of file Mod.cs.

                                                             {
            if (!loading)
                throw new Exception("AddPrefix can only be called from Mod.Load or Mod.Autoload");
 
            if (prefixes.ContainsKey(name))
                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.");
 
            prefix.mod = this;
            prefix.Name = name;
            prefix.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.Prefix.{1}", Name, name));
            prefix.Type = ModPrefix.ReservePrefixID();
 
            prefixes[name] = prefix;
            ModPrefix.prefixes.Add(prefix);
            ModPrefix.categoryPrefixes[prefix.Category].Add(prefix);
            ContentInstance.Register(prefix);
        }

References Terraria.ModLoader.ModPrefix.Category, Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadPrefix().

Here is the call graph for this function:

Here is the caller graph for this function:

AddProjectile()

void Terraria.ModLoader.Mod.AddProjectile	(	string	name,
		ModProjectile	projectile
	)

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

Parameters

name	The name.
projectile	The projectile.

Definition at line 740 of file Mod.cs.

                                                                         {
            if (!loading)
                throw new Exception("AddProjectile can only be called from Mod.Load or Mod.Autoload");
 
            if (projectiles.ContainsKey(name))
                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.");
 
            projectile.mod = this;
            projectile.Name = name;
            projectile.projectile.type = ProjectileLoader.ReserveProjectileID();
            projectile.DisplayName = GetOrCreateTranslation(string.Format("Mods.{0}.ProjectileName.{1}", Name, name));
 
            projectiles[name] = projectile;
            ProjectileLoader.projectiles.Add(projectile);
            ContentInstance.Register(projectile);
        }

References Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadProjectile().

Here is the call graph for this function:

Here is the caller graph for this function:

AddRecipeGroups()

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 94 of file Mod.cs.

                                              {
        }

AddRecipes()

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 100 of file Mod.cs.

                                         {
        }

AddSound()

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

type	The type.
soundPath	The sound path.
modSound	The mod sound.

Definition at line 1362 of file Mod.cs.

                                                                                         {
            if (!loading)
                throw new Exception("AddSound can only be called from Mod.Load or Mod.Autoload");
            int id = SoundLoader.ReserveSoundID(type);
            SoundLoader.sounds[type][soundPath] = id;
            if (modSound != null) {
                SoundLoader.modSounds[type][id] = modSound;
                modSound.sound = ModContent.GetSound(soundPath);
            }
        }

References Terraria.ModLoader.ModContent.GetSound().

Referenced by Terraria.ModLoader.Mod.AutoloadSounds().

Here is the call graph for this function:

Here is the caller graph for this function:

AddSurfaceBgStyle()

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

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

Parameters

name	The name.
surfaceBgStyle	The surface bg style.

Definition at line 1195 of file Mod.cs.

                                                                                     {
            if (!loading)
                throw new Exception("AddSurfaceBgStyle can only be called from Mod.Load or Mod.Autoload");
 
            surfaceBgStyle.mod = this;
            surfaceBgStyle.Name = name;
            surfaceBgStyle.Slot = SurfaceBgStyleLoader.ReserveBackgroundSlot();
 
            surfaceBgStyles[name] = surfaceBgStyle;
            SurfaceBgStyleLoader.surfaceBgStyles.Add(surfaceBgStyle);
            ContentInstance.Register(surfaceBgStyle);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadSurfaceBgStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

AddTexture()

void Terraria.ModLoader.Mod.AddTexture	(	string	name,
		Texture2D	texture
	)

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

Parameters

name	The name.
texture	The texture.

Exceptions

Terraria.ModLoader.Exceptions.ModNameException

Texture already exist: " + name

Definition at line 1598 of file Mod.cs.

                                                               {
            if (Main.dedServ)
                return;
 
            if (TextureExists(name))
                throw new Exception("Texture already exist: " + name);
 
            textures[name] = texture;
        }

References Terraria.ModLoader.Mod.TextureExists().

Here is the call graph for this function:

AddTile()

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

name	The name.
tile	The tile.
texture	The texture.

Definition at line 535 of file Mod.cs.

                                                                       {
            if (!loading)
                throw new Exception("AddItem can only be called from Mod.Load or Mod.Autoload");
 
            if (tiles.ContainsKey(name))
                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.");
 
            tile.mod = this;
            tile.Name = name;
            tile.Type = (ushort)TileLoader.ReserveTileID();
            tile.texture = texture;
 
            tiles[name] = tile;
            TileLoader.tiles.Add(tile);
            ContentInstance.Register(tile);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadTile().

Here is the call graph for this function:

Here is the caller graph for this function:

AddTileEntity()

void Terraria.ModLoader.Mod.AddTileEntity	(	string	name,
		ModTileEntity	entity
	)

Manually add a tile entity during Load.

Definition at line 617 of file Mod.cs.

                                                                     {
            if (!loading)
                throw new Exception("AddTileEntity can only be called from Mod.Load or Mod.Autoload");
 
            int id = ModTileEntity.ReserveTileEntityID();
            entity.mod = this;
            entity.Name = name;
            entity.Type = id;
            entity.type = (byte)id;
 
            tileEntities[name] = entity;
            ModTileEntity.tileEntities.Add(entity);
            ContentInstance.Register(entity);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadTileEntity().

Here is the call graph for this function:

Here is the caller graph for this function:

AddTranslation()

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 1544 of file Mod.cs.

                                                               {
            translations[translation.Key] = translation;
        }

References Terraria.ModLoader.ModTranslation.Key.

Referenced by Terraria.ModLoader.Mod.AutoloadLocalization().

Here is the caller graph for this function:

AddUgBgStyle()

void Terraria.ModLoader.Mod.AddUgBgStyle	(	string	name,
		ModUgBgStyle	ugBgStyle
	)

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

Parameters

name	The name.
ugBgStyle	The ug bg style.

Definition at line 1167 of file Mod.cs.

                                                                      {
            if (!loading)
                throw new Exception("AddUgBgStyle can only be called from Mod.Load or Mod.Autoload");
 
            ugBgStyle.mod = this;
            ugBgStyle.Name = name;
            ugBgStyle.Slot = UgBgStyleLoader.ReserveBackgroundSlot();
 
            ugBgStyles[name] = ugBgStyle;
            UgBgStyleLoader.ugBgStyles.Add(ugBgStyle);
            ContentInstance.Register(ugBgStyle);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadUgBgStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

AddWall()

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

name	The name.
wall	The wall.
texture	The texture.

Definition at line 669 of file Mod.cs.

                                                                       {
            if (!loading)
                throw new Exception("AddWall can only be called from Mod.Load or Mod.Autoload");
 
            wall.mod = this;
            wall.Name = name;
            wall.Type = (ushort)WallLoader.ReserveWallID();
            wall.texture = texture;
 
            walls[name] = wall;
            WallLoader.walls.Add(wall);
            ContentInstance.Register(wall);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadWall().

Here is the call graph for this function:

Here is the caller graph for this function:

AddWaterfallStyle()

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

name	The name.
waterfallStyle	The waterfall style.
texture	The texture.

Definition at line 1292 of file Mod.cs.

                                                                                                     {
            if (!loading)
                throw new Exception("AddWaterfallStyle can only be called from Mod.Load or Mod.Autoload");
 
            waterfallStyle.mod = this;
            waterfallStyle.Name = name;
            waterfallStyle.Type = WaterfallStyleLoader.ReserveStyle();
            waterfallStyle.texture = texture;
 
            waterfallStyles[name] = waterfallStyle;
            WaterfallStyleLoader.waterfallStyles.Add(waterfallStyle);
            ContentInstance.Register(waterfallStyle);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadWaterfallStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

AddWaterStyle()

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

name	The name.
waterStyle	The water style.
texture	The texture.
blockTexture	The block texture.

Definition at line 1261 of file Mod.cs.

                                                                                                              {
            if (!loading)
                throw new Exception("AddWaterStyle can only be called from Mod.Load or Mod.Autoload");
 
            waterStyle.mod = this;
            waterStyle.Name = name;
            waterStyle.Type = WaterStyleLoader.ReserveStyle();
            waterStyle.texture = texture;
            waterStyle.blockTexture = blockTexture;
 
            waterStyles[name] = waterStyle;
            WaterStyleLoader.waterStyles.Add(waterStyle);
            ContentInstance.Register(waterStyle);
        }

References Terraria.ModLoader.ContentInstance< T >.Register().

Referenced by Terraria.ModLoader.Mod.AutoloadWaterStyle().

Here is the call graph for this function:

Here is the caller graph for this function:

AutoloadBackgrounds()

void Terraria.ModLoader.Mod.AutoloadBackgrounds ( )

private

Definition at line 532 of file ModInternals.cs.

                                           {
            foreach (string texture in textures.Keys.Where(t => t.StartsWith("Backgrounds/"))) {
                AddBackgroundTexture(Name + '/' + texture);
            }
        }

References Terraria.ModLoader.Mod.AddBackgroundTexture(), and Terraria.ModLoader.Mod.Name.

Here is the call graph for this function:

AutoloadBuff()

void Terraria.ModLoader.Mod.AutoloadBuff ( Type  type )

private

Definition at line 490 of file ModInternals.cs.

                                             {
            ModBuff buff = (ModBuff)Activator.CreateInstance(type);
            buff.mod = this;
            string name = type.Name;
            string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
            if (buff.Autoload(ref name, ref texture)) {
                AddBuff(name, buff, texture);
            }
        }

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

Here is the call graph for this function:

AutoloadCommand()

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

private

Definition at line 636 of file ModInternals.cs.

                                                {
            var mc = (ModCommand)Activator.CreateInstance(type);
            mc.mod = this;
            var name = type.Name;
            if (mc.Autoload(ref name))
                AddCommand(name, mc);
        }

References Terraria.ModLoader.Mod.AddCommand().

Here is the call graph for this function:

AutoloadDust()

void Terraria.ModLoader.Mod.AutoloadDust ( Type  type )

private

Definition at line 378 of file ModInternals.cs.

                                             {
            ModDust dust = (ModDust)Activator.CreateInstance(type);
            dust.mod = this;
            string name = type.Name;
            string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
            if (dust.Autoload(ref name, ref texture)) {
                AddDust(name, dust, texture);
            }
        }

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

Here is the call graph for this function:

AutoloadGlobalBgStyle()

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

private

Definition at line 556 of file ModInternals.cs.

                                                      {
            GlobalBgStyle globalBgStyle = (GlobalBgStyle)Activator.CreateInstance(type);
            globalBgStyle.mod = this;
            string name = type.Name;
            if (globalBgStyle.Autoload(ref name)) {
                AddGlobalBgStyle(name, globalBgStyle);
            }
        }

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

Here is the call graph for this function:

AutoloadGlobalBuff()

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

private

Definition at line 500 of file ModInternals.cs.

                                                   {
            GlobalBuff globalBuff = (GlobalBuff)Activator.CreateInstance(type);
            globalBuff.mod = this;
            string name = type.Name;
            if (globalBuff.Autoload(ref name)) {
                AddGlobalBuff(name, globalBuff);
            }
        }

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

Here is the call graph for this function:

AutoloadGlobalItem()

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

private

Definition at line 360 of file ModInternals.cs.

                                                   {
            GlobalItem globalItem = (GlobalItem)Activator.CreateInstance(type);
            globalItem.mod = this;
            string name = type.Name;
            if (globalItem.Autoload(ref name)) {
                AddGlobalItem(name, globalItem);
            }
        }

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

Here is the call graph for this function:

AutoloadGlobalNPC()

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

private

Definition at line 472 of file ModInternals.cs.

                                                  {
            GlobalNPC globalNPC = (GlobalNPC)Activator.CreateInstance(type);
            globalNPC.mod = this;
            string name = type.Name;
            if (globalNPC.Autoload(ref name)) {
                AddGlobalNPC(name, globalNPC);
            }
        }

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

Here is the call graph for this function:

AutoloadGlobalProjectile()

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

private

Definition at line 444 of file ModInternals.cs.

                                                         {
            GlobalProjectile globalProjectile = (GlobalProjectile)Activator.CreateInstance(type);
            globalProjectile.mod = this;
            string name = type.Name;
            if (globalProjectile.Autoload(ref name)) {
                AddGlobalProjectile(name, globalProjectile);
            }
        }

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

Here is the call graph for this function:

AutoloadGlobalRecipe()

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

private

Definition at line 627 of file ModInternals.cs.

                                                     {
            GlobalRecipe globalRecipe = (GlobalRecipe)Activator.CreateInstance(type);
            globalRecipe.mod = this;
            string name = type.Name;
            if (globalRecipe.Autoload(ref name)) {
                AddGlobalRecipe(name, globalRecipe);
            }
        }

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

Here is the call graph for this function:

AutoloadGlobalTile()

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

private

Definition at line 398 of file ModInternals.cs.

                                                   {
            GlobalTile globalTile = (GlobalTile)Activator.CreateInstance(type);
            globalTile.mod = this;
            string name = type.Name;
            if (globalTile.Autoload(ref name)) {
                AddGlobalTile(name, globalTile);
            }
        }

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

Here is the call graph for this function:

AutoloadGlobalWall()

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

private

Definition at line 426 of file ModInternals.cs.

                                                   {
            GlobalWall globalWall = (GlobalWall)Activator.CreateInstance(type);
            globalWall.mod = this;
            string name = type.Name;
            if (globalWall.Autoload(ref name)) {
                AddGlobalWall(name, globalWall);
            }
        }

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

Here is the call graph for this function:

AutoloadGores()

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

private

Definition at line 586 of file ModInternals.cs.

                                                         {
            var modGoreNames = modGores.ToDictionary(t => t.Namespace + "." + t.Name);
            foreach (var texture in textures.Keys.Where(t => t.StartsWith("Gores/"))) {
                ModGore modGore = null;
                Type t;
                if (modGoreNames.TryGetValue(Name + "." + texture.Replace('/', '.'), out t))
                    modGore = (ModGore)Activator.CreateInstance(t);
 
                AddGore(Name + '/' + texture, modGore);
            }
        }

References Terraria.ModLoader.Mod.AddGore(), and Terraria.ModLoader.Mod.Name.

Here is the call graph for this function:

AutoloadItem()

void Terraria.ModLoader.Mod.AutoloadItem ( Type  type )

private

Definition at line 346 of file ModInternals.cs.

                                             {
            ModItem item = (ModItem)Activator.CreateInstance(type);
            item.mod = this;
            string name = type.Name;
            if (item.Autoload(ref name)) {
                AddItem(name, item);
                var autoloadEquip = type.GetAttribute<AutoloadEquip>();
                if (autoloadEquip != null)
                    foreach (var equip in autoloadEquip.equipTypes)
                        AddEquipTexture(item, equip, item.Name, item.Texture + '_' + equip,
                            item.Texture + "_Arms", item.Texture + "_FemaleBody");
            }
        }

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

Here is the call graph for this function:

AutoloadLocalization()

void Terraria.ModLoader.Mod.AutoloadLocalization ( )

private

Loads .lang files

Definition at line 647 of file ModInternals.cs.

                                            {
            var modTranslationDictionary = new Dictionary<string, ModTranslation>();
            foreach (var translationFile in File.Where(entry => Path.GetExtension(entry.Name) == ".lang")) {
                // .lang files need to be UTF8 encoded.
                string translationFileContents = System.Text.Encoding.UTF8.GetString(File.GetBytes(translationFile));
                GameCulture culture = GameCulture.FromName(Path.GetFileNameWithoutExtension(translationFile.Name));
 
                using (StringReader reader = new StringReader(translationFileContents)) {
                    string line;
                    while ((line = reader.ReadLine()) != null) {
                        int split = line.IndexOf('=');
                        if (split < 0)
                            continue; // lines witout a = are ignored
                        string key = line.Substring(0, split).Trim().Replace(" ", "_");
                        string value = line.Substring(split + 1); // removed .Trim() since sometimes it is desired.
                        if (value.Length == 0) {
                            continue;
                        }
                        value = value.Replace("\\n", "\n");
                        // TODO: Maybe prepend key with filename: en.US.ItemName.lang would automatically assume "ItemName." for all entries.
                        //string key = key;
                        if (!modTranslationDictionary.TryGetValue(key, out ModTranslation mt))
                            modTranslationDictionary[key] = mt = CreateTranslation(key);
                        mt.AddTranslation(culture, value);
                    }
                }
            }
 
            foreach (var value in modTranslationDictionary.Values) {
                AddTranslation(value);
            }
        }

References Terraria.ModLoader.ModTranslation.AddTranslation(), Terraria.ModLoader.Mod.AddTranslation(), and Terraria.ModLoader.Mod.CreateTranslation().

Here is the call graph for this function:

AutoloadModWorld()

void Terraria.ModLoader.Mod.AutoloadModWorld ( Type  type )

private

Definition at line 523 of file ModInternals.cs.

                                                 {
            ModWorld modWorld = (ModWorld)Activator.CreateInstance(type);
            modWorld.mod = this;
            string name = type.Name;
            if (modWorld.Autoload(ref name)) {
                AddModWorld(name, modWorld);
            }
        }

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

Here is the call graph for this function:

AutoloadMountData()

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

private

Definition at line 509 of file ModInternals.cs.

                                                  {
            ModMountData mount = (ModMountData)Activator.CreateInstance(type);
            mount.mod = this;
            string name = type.Name;
            string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
            var extraTextures = new Dictionary<MountTextureType, string>();
            foreach (MountTextureType textureType in Enum.GetValues(typeof(MountTextureType))) {
                extraTextures[textureType] = texture + "_" + textureType.ToString();
            }
            if (mount.Autoload(ref name, ref texture, extraTextures)) {
                AddMount(name, mount, texture, extraTextures);
            }
        }

References Terraria.ModLoader.Mod.AddMount(), and Terraria.ModLoader.ModMountData.Name.

Here is the call graph for this function:

AutoloadNPC()

void Terraria.ModLoader.Mod.AutoloadNPC ( Type  type )

private

Definition at line 453 of file ModInternals.cs.

                                            {
            ModNPC npc = (ModNPC)Activator.CreateInstance(type);
            npc.mod = this;
            string name = type.Name;
            if (npc.Autoload(ref name)) {
                AddNPC(name, npc);
                var autoloadHead = type.GetAttribute<AutoloadHead>();
                if (autoloadHead != null) {
                    string headTexture = npc.HeadTexture;
                    AddNPCHeadTexture(npc.npc.type, headTexture);
                }
                var autoloadBossHead = type.GetAttribute<AutoloadBossHead>();
                if (autoloadBossHead != null) {
                    string headTexture = npc.BossHeadTexture;
                    AddBossHeadTexture(headTexture, npc.npc.type);
                }
            }
        }

References Terraria.ModLoader.Mod.AddBossHeadTexture(), Terraria.ModLoader.Mod.AddNPC(), Terraria.ModLoader.Mod.AddNPCHeadTexture(), Terraria.ModLoader.ModNPC.Autoload(), Terraria.ModLoader.ModNPC.BossHeadTexture, Terraria.ModLoader.ModNPC.HeadTexture, Terraria.ModLoader.ModNPC.Name, and Terraria.ModLoader.ModNPC.npc.

Here is the call graph for this function:

AutoloadPlayer()

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

private

Definition at line 481 of file ModInternals.cs.

                                               {
            ModPlayer player = (ModPlayer)Activator.CreateInstance(type);
            player.mod = this;
            string name = type.Name;
            if (player.Autoload(ref name)) {
                AddPlayer(name, player);
            }
        }

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

Here is the call graph for this function:

AutoloadPrefix()

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

private

Definition at line 369 of file ModInternals.cs.

                                               {
            ModPrefix prefix = (ModPrefix)Activator.CreateInstance(type);
            prefix.mod = this;
            string name = type.Name;
            if (prefix.Autoload(ref name)) {
                AddPrefix(name, prefix);
            }
        }

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

Here is the call graph for this function:

AutoloadProjectile()

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

private

Definition at line 435 of file ModInternals.cs.

                                                   {
            ModProjectile projectile = (ModProjectile)Activator.CreateInstance(type);
            projectile.mod = this;
            string name = type.Name;
            if (projectile.Autoload(ref name)) {
                AddProjectile(name, projectile);
            }
        }

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

Here is the call graph for this function:

AutoloadSounds()

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

private

Definition at line 598 of file ModInternals.cs.

                                                           {
            var modSoundNames = modSounds.ToDictionary(t => t.Namespace + "." + t.Name);
            foreach (var sound in sounds.Keys.Where(t => t.StartsWith("Sounds/"))) {
                string substring = sound.Substring("Sounds/".Length);
                SoundType soundType = SoundType.Custom;
                if (substring.StartsWith("Item/")) {
                    soundType = SoundType.Item;
                }
                else if (substring.StartsWith("NPCHit/")) {
                    soundType = SoundType.NPCHit;
                }
                else if (substring.StartsWith("NPCKilled/")) {
                    soundType = SoundType.NPCKilled;
                }
                ModSound modSound = null;
                Type t;
                if (modSoundNames.TryGetValue((Name + '/' + sound).Replace('/', '.'), out t))
                    modSound = (ModSound)Activator.CreateInstance(t);
 
                AddSound(soundType, Name + '/' + sound, modSound);
            }
            foreach (var music in musics.Keys.Where(t => t.StartsWith("Sounds/"))) {
                string substring = music.Substring("Sounds/".Length);
                if (substring.StartsWith("Music/")) {
                    AddSound(SoundType.Music, Name + '/' + music);
                }
            }
        }

References Terraria.ModLoader.Mod.AddSound(), and Terraria.ModLoader.Mod.Name.

Here is the call graph for this function:

AutoloadSurfaceBgStyle()

void Terraria.ModLoader.Mod.AutoloadSurfaceBgStyle ( Type  type )

private

Definition at line 547 of file ModInternals.cs.

                                                       {
            ModSurfaceBgStyle surfaceBgStyle = (ModSurfaceBgStyle)Activator.CreateInstance(type);
            surfaceBgStyle.mod = this;
            string name = type.Name;
            if (surfaceBgStyle.Autoload(ref name)) {
                AddSurfaceBgStyle(name, surfaceBgStyle);
            }
        }

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

Here is the call graph for this function:

AutoloadTile()

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

private

Definition at line 388 of file ModInternals.cs.

                                             {
            ModTile tile = (ModTile)Activator.CreateInstance(type);
            tile.mod = this;
            string name = type.Name;
            string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
            if (tile.Autoload(ref name, ref texture)) {
                AddTile(name, tile, texture);
            }
        }

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

Here is the call graph for this function:

AutoloadTileEntity()

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

private

Definition at line 407 of file ModInternals.cs.

                                                   {
            ModTileEntity tileEntity = (ModTileEntity)Activator.CreateInstance(type);
            tileEntity.mod = this;
            string name = type.Name;
            if (tileEntity.Autoload(ref name)) {
                AddTileEntity(name, tileEntity);
            }
        }

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

Here is the call graph for this function:

AutoloadUgBgStyle()

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

private

Definition at line 538 of file ModInternals.cs.

                                                  {
            ModUgBgStyle ugBgStyle = (ModUgBgStyle)Activator.CreateInstance(type);
            ugBgStyle.mod = this;
            string name = type.Name;
            if (ugBgStyle.Autoload(ref name)) {
                AddUgBgStyle(name, ugBgStyle);
            }
        }

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

Here is the call graph for this function:

AutoloadWall()

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

private

Definition at line 416 of file ModInternals.cs.

                                             {
            ModWall wall = (ModWall)Activator.CreateInstance(type);
            wall.mod = this;
            string name = type.Name;
            string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
            if (wall.Autoload(ref name, ref texture)) {
                AddWall(name, wall, texture);
            }
        }

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

Here is the call graph for this function:

AutoloadWaterfallStyle()

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

private

Definition at line 576 of file ModInternals.cs.

                                                       {
            ModWaterfallStyle waterfallStyle = (ModWaterfallStyle)Activator.CreateInstance(type);
            waterfallStyle.mod = this;
            string name = type.Name;
            string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
            if (waterfallStyle.Autoload(ref name, ref texture)) {
                AddWaterfallStyle(name, waterfallStyle, texture);
            }
        }

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

Here is the call graph for this function:

AutoloadWaterStyle()

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

private

Definition at line 565 of file ModInternals.cs.

                                                   {
            ModWaterStyle waterStyle = (ModWaterStyle)Activator.CreateInstance(type);
            waterStyle.mod = this;
            string name = type.Name;
            string texture = (type.Namespace + "." + type.Name).Replace('.', '/');
            string blockTexture = texture + "_Block";
            if (waterStyle.Autoload(ref name, ref texture, ref blockTexture)) {
                AddWaterStyle(name, waterStyle, texture, blockTexture);
            }
        }

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

Here is the call graph for this function:

BuffType()

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

name

The name.

Returns

BuffType< T >()

int Terraria.ModLoader.Mod.BuffType< T >

(

)

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	:	ModContent.BuffType<T>()

Call()

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 1683 of file Mod.cs.

                                                         {
            return null;
        }

Close()

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 136 of file Mod.cs.

                                    {
            fileHandle?.Dispose();
            if (File != null && File.IsOpen)
                throw new IOException($"TModFile has open handles: {File.path}");
        }

References Terraria.ModLoader.Mod.fileHandle.

CreateTranslation()

ModTranslation Terraria.ModLoader.Mod.CreateTranslation

(

string

key

)

Creates a ModTranslation object that you can use in AddTranslation.

Parameters

key	The key for the ModTranslation. The full key will be Mods.ModName.key

Referenced by Terraria.ModLoader.Mod.AutoloadLocalization().

Here is the caller graph for this function:

DustType()

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

name

The name.

Returns

DustType< T >()

int Terraria.ModLoader.Mod.DustType< T >

(

)

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	:	ModContent.DustType<T>()

EffectExists()

bool Terraria.ModLoader.Mod.EffectExists

(

string

name

)

Used to check if a custom Effect exists

FileExists()

bool Terraria.ModLoader.Mod.FileExists

(

string

name

)

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

Parameters

name

The name.

Returns

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

Here is the caller graph for this function:

FontExists()

bool Terraria.ModLoader.Mod.FontExists

(

string

name

)

Used to check if a custom SpriteFont exists

GetAccessorySlot()

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

name	The name.
type

Returns

GetBackgroundSlot()

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

name

The name.

Returns

GetBuff()

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

name

The name.

Returns

GetBuff< T >()

T Terraria.ModLoader.Mod.GetBuff< T >

(

)

Type Constraints

T	:	ModBuff
T	:	ModContent.GetInstance<T>()

GetConfig()

ModConfig Terraria.ModLoader.Mod.GetConfig

(

string

name

)

Definition at line 1707 of file Mod.cs.

        {
            List<ModConfig> configs;
            if (ConfigManager.Configs.TryGetValue(this, out configs))
            {
                return configs.Single(x => x.Name == name);
            }
            return null;
        }

GetConfig< T >()

T Terraria.ModLoader.Mod.GetConfig< T >

(

)

Type Constraints

T	:	ModConfig
T	:	T
T	:	GetConfig
T	:	typeof
T	:	T
T	:	Name

GetDust()

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

name

The name.

Returns

GetDust< T >()

T Terraria.ModLoader.Mod.GetDust< T >

(

)

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	:	ModContent.GetInstance<T>()

GetEffect()

Effect Terraria.ModLoader.Mod.GetEffect

(

string

name

)

Gets an Effect loaded from the specified path.

Exceptions

MissingResourceException

Definition at line 1668 of file Mod.cs.

                                             {
            if (!effects.TryGetValue(name, out var effect))
                throw new MissingResourceException(name);
 
            return effect;
        }

GetEquipSlot()

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

name	The name.
type

Returns

GetEquipTexture()

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

name	The name.
type	The type.

Returns

GetFileBytes()

byte[] Terraria.ModLoader.Mod.GetFileBytes

(

string

name

)

Retrieve contents of files within the tmod file

Parameters

name

The name.

Returns

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

Here is the caller graph for this function:

GetFileStream()

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

Retrieve contents of files within the tmod file

Parameters

name

The name.

Returns

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

Here is the caller graph for this function:

GetFont()

DynamicSpriteFont Terraria.ModLoader.Mod.GetFont

(

string

name

)

Gets a SpriteFont loaded from the specified path.

Exceptions

MissingResourceException

Definition at line 1652 of file Mod.cs.

                                                      {
            if (!fonts.TryGetValue(name, out var font))
                throw new MissingResourceException(name);
 
            return font;
        }

GetGlobalBgStyle()

GlobalBgStyle Terraria.ModLoader.Mod.GetGlobalBgStyle

(

string

name

)

Returns the global background style corresponding to the given name.

Parameters

name

The name.

Returns

GetGlobalBgStyle< T >()

T Terraria.ModLoader.Mod.GetGlobalBgStyle< T >

(

)

Type Constraints

T	:	GlobalBgStyle
T	:	ModContent.GetInstance<T>()

GetGlobalBuff()

GlobalBuff Terraria.ModLoader.Mod.GetGlobalBuff

(

string

name

)

Gets the GlobalBuff with the given name from this mod.

Parameters

name

The name.

Returns

GetGlobalBuff< T >()

T Terraria.ModLoader.Mod.GetGlobalBuff< T >

(

)

Type Constraints

T	:	GlobalBuff
T	:	ModContent.GetInstance<T>()

GetGlobalItem()

GlobalItem Terraria.ModLoader.Mod.GetGlobalItem

(

string

name

)

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

Parameters

name

The name.

Returns

GetGlobalItem< T >()

T Terraria.ModLoader.Mod.GetGlobalItem< T >

(

)

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

GetGlobalNPC()

GlobalNPC Terraria.ModLoader.Mod.GetGlobalNPC

(

string

name

)

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

Parameters

name

The name.

Returns

GetGlobalNPC< T >()

T Terraria.ModLoader.Mod.GetGlobalNPC< T >

(

)

Type Constraints

T	:	GlobalNPC
T	:	ModContent.GetInstance<T>()

GetGlobalProjectile()

GlobalProjectile Terraria.ModLoader.Mod.GetGlobalProjectile

(

string

name

)

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

Parameters

name

The name.

Returns

GetGlobalProjectile< T >()

T Terraria.ModLoader.Mod.GetGlobalProjectile< T >

(

)

Type Constraints

T	:	GlobalProjectile
T	:	ModContent.GetInstance<T>()

GetGlobalRecipe()

GlobalRecipe Terraria.ModLoader.Mod.GetGlobalRecipe

(

string

name

)

Gets the global recipe corresponding to the specified name.

Parameters

name

The name.

Returns

GetGlobalRecipe< T >()

T Terraria.ModLoader.Mod.GetGlobalRecipe< T >

(

)

Type Constraints

T	:	GlobalRecipe
T	:	ModContent.GetInstance<T>()

GetGlobalTile()

GlobalTile Terraria.ModLoader.Mod.GetGlobalTile

(

string

name

)

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

Parameters

name

The name.

Returns

GetGlobalTile< T >()

T Terraria.ModLoader.Mod.GetGlobalTile< T >

(

)

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	:	ModContent.GetInstance<T>()

GetGlobalWall()

GlobalWall Terraria.ModLoader.Mod.GetGlobalWall

(

string

name

)

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

Parameters

name

The name.

Returns

GetGlobalWall< T >()

T Terraria.ModLoader.Mod.GetGlobalWall< T >

(

)

Type Constraints

T	:	GlobalWall
T	:	ModContent.GetInstance<T>()

GetGoreSlot()

int Terraria.ModLoader.Mod.GetGoreSlot

(

string

name

)

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

Parameters

name

The name.

Returns

GetGoreSlot< T >()

int Terraria.ModLoader.Mod.GetGoreSlot< T >

(

)

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

GetItem()

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

name

The name.

Returns

GetItem< T >()

T Terraria.ModLoader.Mod.GetItem< T >

(

)

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	:	ModContent.GetInstance<T>()

GetLegacySoundSlot()

LegacySoundStyle Terraria.ModLoader.Mod.GetLegacySoundSlot	(	SoundType	type,
		string	name
	)

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

Parameters

type	The type.
name	The name.

Returns

GetModWorld()

ModWorld Terraria.ModLoader.Mod.GetModWorld

(

string

name

)

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

Parameters

name

The name.

Returns

GetModWorld< T >()

T Terraria.ModLoader.Mod.GetModWorld< T >

(

)

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	:	ModContent.GetInstance<T>()

GetMount()

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

name

The name.

Returns

GetMount< T >()

T Terraria.ModLoader.Mod.GetMount< T >

(

)

Type Constraints

T	:	ModMountData
T	:	ModContent.GetInstance<T>()

GetMusic()

Music Terraria.ModLoader.Mod.GetMusic

(

string

name

)

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

Parameters

name

The name.

Returns

Exceptions

MissingResourceException

Definition at line 1634 of file Mod.cs.

                                           {
            if (!musics.TryGetValue(name, out var music))
                throw new MissingResourceException(name);
 
            return music;
        }

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

Here is the caller graph for this function:

GetNPC()

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

name

The name.

Returns

GetNPC< T >()

T Terraria.ModLoader.Mod.GetNPC< T >

(

)

Type Constraints

T	:	ModNPC
T	:	ModContent.GetInstance<T>()

GetPacket()

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

capacity

The capacity.

Returns

Exceptions

System.Exception

Cannot get packet for " + Name + " because it does not exist on the other side

Definition at line 1693 of file Mod.cs.

                                                       {
            if (netID < 0)
                throw new Exception("Cannot get packet for " + Name + " because it does not exist on the other side");
 
            var p = new ModPacket(MessageID.ModPacket, capacity + 5);
            if (ModNet.NetModCount < 256)
                p.Write((byte)netID);
            else
                p.Write(netID);
 
            p.netID = netID;
            return p;
        }

References Terraria.ModLoader.Mod.Name, and Terraria.ModLoader.ModNet.NetModCount.

GetPlayer()

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

name

The name.

Returns

GetPlayer< T >()

T Terraria.ModLoader.Mod.GetPlayer< T >

(

)

Type Constraints

T	:	ModPlayer
T	:	ModContent.GetInstance<T>()

GetPrefix()

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

name

The name.

Returns

GetPrefix< T >()

T Terraria.ModLoader.Mod.GetPrefix< T >

(

)

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	:	ModContent.GetInstance<T>()

GetProjectile()

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

name

The name.

Returns

GetProjectile< T >()

T Terraria.ModLoader.Mod.GetProjectile< T >

(

)

Type Constraints

T	:	ModProjectile
T	:	ModContent.GetInstance<T>()

GetSound()

SoundEffect Terraria.ModLoader.Mod.GetSound

(

string

name

)

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

Parameters

name

The name.

Returns

Exceptions

MissingResourceException

Definition at line 1614 of file Mod.cs.

                                                 {
            if (!sounds.TryGetValue(name, out var sound))
                throw new MissingResourceException(name);
 
            return sound;
        }

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

Here is the caller graph for this function:

GetSoundSlot()

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

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

Parameters

type	The type.
name	The name.

Returns

GetSurfaceBgStyle()

ModSurfaceBgStyle Terraria.ModLoader.Mod.GetSurfaceBgStyle

(

string

name

)

Returns the surface background style corresponding to the given name.

Parameters

name

The name.

Returns

GetSurfaceBgStyle< T >()

T Terraria.ModLoader.Mod.GetSurfaceBgStyle< T >

(

)

Type Constraints

T	:	ModSurfaceBgStyle
T	:	ModContent.GetInstance<T>()

GetSurfaceBgStyleSlot()

int Terraria.ModLoader.Mod.GetSurfaceBgStyleSlot

(

string

name

)

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

Parameters

name

The name.

Returns

GetSurfaceBgStyleSlot< T >()

int Terraria.ModLoader.Mod.GetSurfaceBgStyleSlot< T >

(

)

Type Constraints

T	:	ModSurfaceBgStyle
T	:	GetSurfaceBgStyleSlot
T	:	typeof
T	:	T
T	:	Name

GetTexture()

Texture2D Terraria.ModLoader.Mod.GetTexture

(

string

name

)

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

Exceptions

MissingResourceException

Definition at line 1578 of file Mod.cs.

                                                 {
            if (!textures.TryGetValue(name, out var t))
                throw new MissingResourceException(name, textures.Keys);
 
            return t;
        }

GetTile()

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

name

The name.

Returns

GetTile< T >()

T Terraria.ModLoader.Mod.GetTile< T >

(

)

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	:	ModContent.GetInstance<T>()

GetTileEntity()

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

name

The name.

Returns

GetTileEntity< T >()

T Terraria.ModLoader.Mod.GetTileEntity< T >

(

)

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	:	ModContent.GetInstance<T>()

GetUgBgStyle()

ModUgBgStyle Terraria.ModLoader.Mod.GetUgBgStyle

(

string

name

)

Returns the underground background style corresponding to the given name.

Parameters

name

The name.

Returns

GetUgBgStyle< T >()

T Terraria.ModLoader.Mod.GetUgBgStyle< T >

(

)

Type Constraints

T	:	ModUgBgStyle
T	:	ModContent.GetInstance<T>()

GetWall()

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

name

The name.

Returns

GetWall< T >()

T Terraria.ModLoader.Mod.GetWall< T >

(

)

Type Constraints

T	:	ModWall
T	:	ModContent.GetInstance<T>()

GetWaterfallStyle()

ModWaterfallStyle Terraria.ModLoader.Mod.GetWaterfallStyle

(

string

name

)

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

Parameters

name

The name.

Returns

GetWaterfallStyle< T >()

T Terraria.ModLoader.Mod.GetWaterfallStyle< T >

(

)

Type Constraints

T	:	ModWaterfallStyle
T	:	ModContent.GetInstance<T>()

GetWaterfallStyleSlot()

int Terraria.ModLoader.Mod.GetWaterfallStyleSlot

(

string

name

)

Returns the waterfall style corresponding to the given name.

Parameters

name

The name.

Returns

GetWaterfallStyleSlot< T >()

int Terraria.ModLoader.Mod.GetWaterfallStyleSlot< T >

(

)

Type Constraints

T	:	ModWaterfallStyle
T	:	GetWaterfallStyleSlot
T	:	typeof
T	:	T
T	:	Name

GetWaterStyle()

ModWaterStyle Terraria.ModLoader.Mod.GetWaterStyle

(

string

name

)

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

Parameters

name

The name.

Returns

GetWaterStyle< T >()

T Terraria.ModLoader.Mod.GetWaterStyle< T >

(

)

Type Constraints

T	:	ModWaterStyle
T	:	ModContent.GetInstance<T>()

HandlePacket()

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

reader	The reader.
whoAmI	The player the message is from.

Definition at line 44 of file ModHooks.cs.

                                                                          {
        }

HijackGetData()

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

messageType	Type of the message.
reader	The reader.
playerNumber	The player number the message is from.

Returns

Definition at line 54 of file ModHooks.cs.

                                                                                                           {
            return false;
        }

HijackSendData()

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.

                                                                                                                                                                                                                          {
            return false;
        }

HotKeyPressed()

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

name	The display name of the hotkey.

Definition at line 36 of file ModHooks.cs.

                                                       {
        }

ItemType()

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

name

The name.

Returns

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

Here is the caller graph for this function:

ItemType< T >()

int Terraria.ModLoader.Mod.ItemType< T >

(

)

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	:	ModContent.ItemType<T>()

Load()

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 71 of file Mod.cs.

                                   {
        }

LoadMusic()

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

private

Definition at line 109 of file ModInternals.cs.

                                                               {
            path = "tmod:"+Name+'/'+path+extension;
            switch (extension) {
                case ".wav": return new MusicStreamingWAV(path);
                case ".mp3": return new MusicStreamingMP3(path);
                case ".ogg": return new MusicStreamingOGG(path);
            }
            throw new ResourceLoadException("Unknown music extension "+extension);
        }

References Terraria.ModLoader.Mod.Name.

Referenced by Terraria.ModLoader.Mod.LoadResource().

Here is the caller graph for this function:

LoadResource()

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

virtual

Hook for pre-loading resources

Parameters

path	The path of the resource within the tmod
length	The length of the uncompressed resource
getStream	A 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 149 of file Mod.cs.

                                                                                          {
            if (tModLoaderVersion < new Version(0, 11) && LoadResourceLegacy(path, length, getStream)) // TODO LoadResourceLegacy is marked obsolete
                return false;
 
            string extension = Path.GetExtension(path).ToLower();
            path = Path.ChangeExtension(path, null);
            switch (extension) {
                case ".png":
                case ".rawimg":
                    if (!Main.dedServ)
                        LoadTexture(path, getStream(), extension == ".rawimg");
                    return true;
                case ".wav":
                case ".mp3":
                case ".ogg":
                    //Main.engine == null would be more sensible, but only the waveBank fails on Linux when there is no audio hardware
                    if (Main.dedServ || Main.waveBank == null) { }
                    else if (path.Contains("Music/"))
                        musics[path] = LoadMusic(path, extension);
                    else
                        sounds[path] = LoadSound(getStream(), length, extension);
                    return true;
                case ".xnb":
                    if (Main.dedServ) { }
                    else if (path.StartsWith("Fonts/"))
                        fonts[path] = Main.instance.OurLoad<DynamicSpriteFont>("tmod:"+Name+"/"+path);
                    else if (path.StartsWith("Effects/"))
                        effects[path] = Main.ShaderContentManager.Load<Effect>("tmod:"+Name+"/"+path);
                    else
                        throw new ResourceLoadException(Language.GetTextValue("tModLoader.LoadErrorUnknownXNBFileHint", path));
                    return true;
            }
 
            return false;
        }

References Terraria.ModLoader.Mod.LoadMusic(), Terraria.ModLoader.Mod.LoadResourceLegacy(), Terraria.ModLoader.Mod.LoadSound(), Terraria.ModLoader.Mod.LoadTexture(), Terraria.ModLoader.Mod.Name, Terraria.ModLoader.Mod.tModLoaderVersion, and Terraria.ModLoader.Mod.Version.

Referenced by Terraria.ModLoader.Mod.LoadResources().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadResourceFromStream()

virtual void Terraria.ModLoader.Mod.LoadResourceFromStream ( string  path, int  len, BinaryReader  reader  )

virtual

Definition at line 194 of file Mod.cs.

                                                                                              {
        }

Referenced by Terraria.ModLoader.Mod.LoadResourceLegacy().

Here is the caller graph for this function:

LoadResourceLegacy()

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

private

Definition at line 186 of file Mod.cs.

                                                                                         {
            using (var stream = getStream()) {
                LoadResourceFromStream(path, length, new BinaryReader(stream));
                return stream.Position > 0;
            }
        }

References Terraria.ModLoader.Mod.LoadResourceFromStream().

Referenced by Terraria.ModLoader.Mod.LoadResource().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadResources()

virtual void Terraria.ModLoader.Mod.LoadResources ( )

virtual

Definition at line 109 of file Mod.cs.

                                            {
            if (File == null)
                return;
 
            fileHandle = File.Open();
 
            var skipCache = new HashSet<string>();
            foreach (var entry in File) {
                Interface.loadMods.SubProgressText = entry.Name;
 
                Stream _stream = null;
                Stream GetStream() => _stream = File.GetStream(entry);
 
                if (LoadResource(entry.Name, entry.Length, GetStream))
                    skipCache.Add(entry.Name);
                
                _stream?.Dispose();
            }
            File.CacheFiles(skipCache);
        }

References Terraria.ModLoader.Mod.fileHandle, and Terraria.ModLoader.Mod.LoadResource().

Here is the call graph for this function:

LoadSound()

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

private

Definition at line 85 of file ModInternals.cs.

                                                                                   {
            switch (extension) {
                case ".wav": 
                    if (!stream.CanSeek)
                        stream = new MemoryStream(stream.ReadBytes(length));
                    return SoundEffect.FromStream(stream);
                case ".mp3":
                    using (var mp3Stream = new MP3Stream(stream))
                    using (var ms = new MemoryStream()) {
                        mp3Stream.CopyTo(ms);
                        return new SoundEffect(ms.ToArray(), mp3Stream.Frequency, (AudioChannels)mp3Stream.ChannelCount);
                    }
                case ".ogg":
                    using (var reader = new VorbisReader(stream, true)) {
                        var buffer = new byte[reader.TotalSamples * 2 * reader.Channels];
                        var floatBuf = new float[buffer.Length / 2];
                        reader.ReadSamples(floatBuf, 0, floatBuf.Length);
                        MusicStreamingOGG.Convert(floatBuf, buffer);
                        return new SoundEffect(buffer, reader.SampleRate, (AudioChannels)reader.Channels);
                    }
            }
            throw new ResourceLoadException("Unknown sound extension "+extension);
        }

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

Referenced by Terraria.ModLoader.Mod.LoadResource().

Here is the call graph for this function:

Here is the caller graph for this function:

LoadTexture()

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

private

Definition at line 60 of file ModInternals.cs.

                                                                          {
            try {
                var texTask = rawimg
                    ? ImageIO.RawToTexture2DAsync(Main.instance.GraphicsDevice, new BinaryReader(stream))
                    : ImageIO.PngToTexture2DAsync(Main.instance.GraphicsDevice, stream);
                
                AsyncLoadQueue.Enqueue(texTask.ContinueWith(t => {
                    if (t.Exception != null)
                        throw new ResourceLoadException(
                            Language.GetTextValue("tModLoader.LoadErrorTextureFailedToLoad", path), t.Exception);
 
                    var tex = t.Result;
                    tex.Name = Name + "/" + path;
                    lock (textures)
                        textures[path] = tex;
                }));
            }
            catch (Exception e) {
                throw new ResourceLoadException(Language.GetTextValue("tModLoader.LoadErrorTextureFailedToLoad", path), e);
            }
            finally {
                stream.Close();
            }
        }

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

Referenced by Terraria.ModLoader.Mod.LoadResource().

Here is the call graph for this function:

Here is the caller graph for this function:

MidUpdateDustTime()

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.

                                                {
        }

MidUpdateGoreProjectile()

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.

                                                      {
        }

MidUpdateInvasionNet()

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.

                                                   {
        }

MidUpdateItemDust()

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.

                                                {
        }

MidUpdateNPCGore()

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.

                                               {
        }

MidUpdatePlayerNPC()

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.

                                                 {
        }

MidUpdateProjectileItem()

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.

                                                      {
        }

MidUpdateTimeWorld()

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.

                                                 {
        }

ModifyInterfaceLayers()

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

layers

The layers.

Definition at line 172 of file ModHooks.cs.

                                                                                   {
        }

ModifyLightingBrightness()

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

scale

Brightness scale

Definition at line 187 of file ModHooks.cs.

                                                                      {
        }

ModifySunLightColor()

virtual void Terraria.ModLoader.Mod.ModifySunLightColor ( ref Color  tileColor, ref Color  backgroundColor  )

virtual

Allows you to modify color of light the sun emits.

Parameters

tileColor	Tile lighting color
backgroundColor	Background lighting color

Definition at line 180 of file ModHooks.cs.

                                                                                                {
        }

ModifyTransformMatrix()

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.

                                                                                  {
        }

MountType()

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

name

The name.

Returns

MountType< T >()

int Terraria.ModLoader.Mod.MountType< T >

(

)

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	:	ModContent.MountType<T>()

MusicExists()

bool Terraria.ModLoader.Mod.MusicExists

(

string

name

)

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

Parameters

name

The name.

Returns

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

Here is the caller graph for this function:

NPCType()

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

name

The name.

Returns

NPCType< T >()

int Terraria.ModLoader.Mod.NPCType< T >

(

)

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	:	ModContent.NPCType<T>()

PostAddRecipes()

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 106 of file Mod.cs.

                                             {
        }

PostDrawFullscreenMap()

virtual void Terraria.ModLoader.Mod.PostDrawFullscreenMap ( ref string  mouseText )

virtual

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

Parameters

mouseText

The mouse text.

Definition at line 203 of file ModHooks.cs.

                                                                        {
        }

PostDrawInterface()

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

spriteBatch

The sprite batch.

Definition at line 196 of file ModHooks.cs.

                                                                       {
        }

PostSetupContent()

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 77 of file Mod.cs.

                                               {
        }

PostUpdateEverything()

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.

                                                   {
        }

PostUpdateInput()

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.

                                              {
        }

PrefixType()

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

name

The name.

Returns

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

Here is the caller graph for this function:

PrefixType< T >()

byte Terraria.ModLoader.Mod.PrefixType< T >

(

)

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	:	ModContent.PrefixType<T>()

PreSaveAndQuit()

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.

                                             {
        }

PreUpdateEntities()

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.

                                                {
        }

ProjectileType()

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

name

The name.

Returns

ProjectileType< T >()

int Terraria.ModLoader.Mod.ProjectileType< T >

(

)

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	:	ModContent.ProjectileType<T>()

RegisterHotKey()

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

name	The name.
defaultKey	The default key.

Returns

Definition at line 1527 of file Mod.cs.

                                                                        {
            if (!loading)
                throw new Exception("RegisterHotKey can only be called from Mod.Load or Mod.Autoload");
 
            return HotKeyLoader.RegisterHotKey(new ModHotKey(this, name, defaultKey));
        }

SoundExists()

bool Terraria.ModLoader.Mod.SoundExists

(

string

name

)

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

Parameters

name

The name.

Returns

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

Here is the caller graph for this function:

TextureExists()

bool Terraria.ModLoader.Mod.TextureExists

(

string

name

)

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

Parameters

name

The name.

Returns

Referenced by Terraria.ModLoader.Mod.AddTexture(), and Terraria.ModLoader.ModContent.TextureExists().

Here is the caller graph for this function:

TileEntityType()

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

name

The name.

Returns

TileEntityType< T >()

int Terraria.ModLoader.Mod.TileEntityType< T >

(

)

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	:	ModContent.TileEntityType<T>()

TileType()

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

name

The name.

Returns

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

Here is the caller graph for this function:

TileType< T >()

int Terraria.ModLoader.Mod.TileType< T >

(

)

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	:	ModContent.TileType<T>()

Unload()

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 83 of file Mod.cs.

                                     {
        }

UpdateMusic() [1/2]

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.

                                                       {
        }

UpdateMusic() [2/2]

virtual void Terraria.ModLoader.Mod.UpdateMusic ( ref int  music, ref MusicPriority  priority  )

virtual

Allows you to determine what music should currently play.

Parameters

music	The music.
priority	The music priority.

Definition at line 20 of file ModHooks.cs.

                                                                                   {
            UpdateMusic(ref music);
        }

References Terraria.ModLoader.Mod.UpdateMusic().

Referenced by Terraria.ModLoader.Mod.UpdateMusic().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateUI()

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.

                                                        {
        }

WallType()

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

name

The name.

Returns

WallType< T >()

int Terraria.ModLoader.Mod.WallType< T >

(

)

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	:	ModContent.WallType<T>()

Member Data Documentation

AsyncLoadQueue

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

private

Definition at line 26 of file ModInternals.cs.

Referenced by Terraria.ModLoader.Mod.LoadTexture().

fileHandle

IDisposable Terraria.ModLoader.Mod.fileHandle

private

Definition at line 65 of file Mod.cs.

Referenced by Terraria.ModLoader.Mod.Close(), and Terraria.ModLoader.Mod.LoadResources().

Property Documentation

Code

Assembly Terraria.ModLoader.Mod.Code

getset

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

Definition at line 33 of file Mod.cs.

{ get; internal set; }

DisplayName

string Terraria.ModLoader.Mod.DisplayName

getset

The display name of this mod in the Mods menu.

Definition at line 60 of file Mod.cs.

{ get; internal set; }

Referenced by Terraria.ModLoader.ModNPC.AutoStaticDefaults().

ExtraPlayerBuffSlots

virtual uint Terraria.ModLoader.Mod.ExtraPlayerBuffSlots

get

The amount of extra buff slots this mod desires for Players. This value is checked after Mod.Load but before Mod.PostSetupContent. The actual number of buffs the player can use will be 22 plus the max value of all enabled mods. In-game use Player.MaxBuffs to check the maximum number of buffs.

Definition at line 89 of file Mod.cs.

{ get; }

IsNetSynced

bool Terraria.ModLoader.Mod.IsNetSynced

get

Definition at line 63 of file Mod.cs.

Logger

ILog Terraria.ModLoader.Mod.Logger

getset

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

Definition at line 37 of file Mod.cs.

{ get; internal set; }

Name

virtual string Terraria.ModLoader.Mod.Name

get

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 42 of file Mod.cs.

Referenced by Terraria.ModLoader.Exceptions.CustomModDataException.CustomModDataException(), Terraria.ModLoader.Mod.AddBuff(), Terraria.ModLoader.Mod.AddGlobalItem(), Terraria.ModLoader.Mod.AddGlobalNPC(), Terraria.ModLoader.Mod.AddGlobalProjectile(), Terraria.ModLoader.Mod.AddItem(), Terraria.ModLoader.Mod.AddNPC(), Terraria.ModLoader.Mod.AddPrefix(), Terraria.ModLoader.Mod.AddProjectile(), Terraria.ModLoader.Mod.AutoloadBackgrounds(), Terraria.ModLoader.Mod.AutoloadGores(), Terraria.ModLoader.Mod.AutoloadSounds(), Terraria.ModLoader.ModTile.CreateMapEntryName(), Terraria.ModLoader.ModWall.CreateMapEntryName(), Terraria.ModLoader.Mod.GetPacket(), Terraria.ModLoader.Mod.LoadMusic(), Terraria.ModLoader.Mod.LoadResource(), Terraria.ModLoader.IO.ItemIO.Save(), and Terraria.ModLoader.PlayerHooks.SendCustomBiomes().

Properties

ModProperties Terraria.ModLoader.Mod.Properties = ModProperties.AutoLoadAll

getprotected set

Definition at line 52 of file Mod.cs.

{ get; protected set; } = ModProperties.AutoLoadAll;

Referenced by Terraria.ModLoader.GlobalBuff.Autoload(), Terraria.ModLoader.GlobalItem.Autoload(), Terraria.ModLoader.GlobalNPC.Autoload(), Terraria.ModLoader.GlobalProjectile.Autoload(), Terraria.ModLoader.GlobalRecipe.Autoload(), Terraria.ModLoader.GlobalTile.Autoload(), Terraria.ModLoader.GlobalWall.Autoload(), Terraria.ModLoader.ModUgBgStyle.Autoload(), Terraria.ModLoader.ModSurfaceBgStyle.Autoload(), Terraria.ModLoader.GlobalBgStyle.Autoload(), Terraria.ModLoader.ModItem.Autoload(), Terraria.ModLoader.ModNPC.Autoload(), Terraria.ModLoader.ModPlayer.Autoload(), Terraria.ModLoader.ModPrefix.Autoload(), Terraria.ModLoader.ModProjectile.Autoload(), Terraria.ModLoader.ModTileEntity.Autoload(), Terraria.ModLoader.ModWorld.Autoload(), Terraria.ModLoader.ModBuff.Autoload(), Terraria.ModLoader.ModDust.Autoload(), Terraria.ModLoader.ModTile.Autoload(), Terraria.ModLoader.ModWall.Autoload(), Terraria.ModLoader.ModWaterfallStyle.Autoload(), Terraria.ModLoader.ModMountData.Autoload(), and Terraria.ModLoader.ModWaterStyle.Autoload().

Side

ModSide Terraria.ModLoader.Mod.Side

getset

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

Definition at line 56 of file Mod.cs.

{ get; internal set; }

tModLoaderVersion

Version Terraria.ModLoader.Mod.tModLoaderVersion

getset

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

Definition at line 46 of file Mod.cs.

{ get; internal set; }

Referenced by Terraria.ModLoader.Mod.LoadResource().

Version

virtual Version Terraria.ModLoader.Mod.Version

get

This version number of this mod.

Definition at line 50 of file Mod.cs.

Referenced by Terraria.ModLoader.Mod.LoadResource().