tModLoader v2022.09
A mod to make and play Terraria mods
|
The base type for most modded things. More...
Inherits Terraria.ModLoader.IModType, ModType, and Terraria.ModLoader.ModType< TEntity >.
Inherited by Terraria.ModLoader.GlobalType< Item, GlobalItem >, Terraria.ModLoader.GlobalType< NPC, GlobalNPC >, Terraria.ModLoader.GlobalType< Projectile, GlobalProjectile >, Terraria.ModLoader.IO.TagSerializer< bool, byte >, Terraria.ModLoader.IO.TagSerializer< Color, int >, Terraria.ModLoader.IO.TagSerializer< Point16, TagCompound >, Terraria.ModLoader.IO.TagSerializer< Rectangle, TagCompound >, Terraria.ModLoader.IO.TagSerializer< T, TagCompound >, Terraria.ModLoader.IO.TagSerializer< uint, int >, Terraria.ModLoader.IO.TagSerializer< ulong, long >, Terraria.ModLoader.IO.TagSerializer< ushort, short >, Terraria.ModLoader.IO.TagSerializer< Vector2, TagCompound >, Terraria.ModLoader.IO.TagSerializer< Vector3, TagCompound >, Terraria.ModLoader.DamageClass, Terraria.ModLoader.GlobalBackgroundStyle, Terraria.ModLoader.GlobalBlockType, Terraria.ModLoader.GlobalBossBar, Terraria.ModLoader.GlobalBuff, Terraria.ModLoader.GlobalInfoDisplay, Terraria.ModLoader.GlobalPylon, Terraria.ModLoader.GlobalType< TEntity, TGlobal >, Terraria.ModLoader.IO.TagSerializer< T, S >, Terraria.ModLoader.ModAccessorySlot, Terraria.ModLoader.ModBackgroundStyle, Terraria.ModLoader.ModBossBarStyle, Terraria.ModLoader.ModCommand, Terraria.ModLoader.ModMapLayer, Terraria.ModLoader.ModMenu, Terraria.ModLoader.ModPrefix, Terraria.ModLoader.ModRarity, Terraria.ModLoader.ModSceneEffect, Terraria.ModLoader.ModSystem, Terraria.ModLoader.ModTexturedType, and Terraria.ModLoader.PlayerDrawLayer.
Public Member Functions | |
virtual TModType | Clone (TEntity newEntity) |
Create a copy of this instanced global. Called when an entity is cloned. More... | |
virtual bool | IsLoadingEnabled (Mod mod) |
Allows you to stop Mod.AddContent from actually adding this content. Useful for items that can be disabled by a config. More... | |
virtual void | Load () |
Allows you to perform one-time loading tasks. Beware that mod content has not finished loading here, things like ModContent lookup tables or ID Sets are not fully populated. More... | |
virtual TModType | NewInstance (TEntity entity) |
Create a new instance of this ModType for a specific entity More... | |
virtual void | SetStaticDefaults () |
Allows you to modify the properties after initial loading has completed. More... | |
virtual void | SetupContent () |
If you make a new ModType, seal this override, and call SetStaticDefaults in it. More... | |
virtual void | Unload () |
Allows you to safely unload things you added in Load. More... | |
Protected Member Functions | |
abstract TEntity | CreateTemplateEntity () |
virtual void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
override void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
abstract void | Register () |
If you make a new ModType, seal this override. More... | |
virtual void | ValidateType () |
Check for the correct overrides of different hook methods and fields and properties More... | |
Protected Member Functions inherited from Terraria.ModLoader.ModType< TEntity > | |
abstract TEntity | CreateTemplateEntity () |
virtual void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
override void | InitTemplateInstance () |
Create dummy objects for instanced mod-types | |
abstract void | Register () |
If you make a new ModType, seal this override. More... | |
virtual void | ValidateType () |
Check for the correct overrides of different hook methods and fields and properties More... | |
Properties | |
virtual bool | CloneNewInstances [get] |
Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor). | |
TEntity | Entity [get, set] |
string | FullName [get] |
The internal name of this, including the mod it is from. More... | |
virtual bool | IsCloneable [get] |
Whether or not this type is cloneable. Cloning is supported if all reference typed fields in each sub-class which doesn't override Clone are marked with [CloneByReference] | |
Mod | Mod [get, set] |
The mod this belongs to. More... | |
virtual string | Name [get] |
The internal name of this. More... | |
Properties inherited from Terraria.ModLoader.IModType | |
string | FullName [get] |
=> $"{Mod.Name}/{Name}" More... | |
Mod | Mod [get] |
The mod this belongs to. More... | |
string | Name [get] |
The internal name of this instance. More... | |
Properties inherited from Terraria.ModLoader.ModType< TEntity > | |
virtual bool | CloneNewInstances [get] |
Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor). | |
TEntity | Entity [get, set] |
string | FullName [get] |
The internal name of this, including the mod it is from. More... | |
virtual bool | IsCloneable [get] |
Whether or not this type is cloneable. Cloning is supported if all reference typed fields in each sub-class which doesn't override Clone are marked with [CloneByReference] | |
Mod | Mod [get, set] |
The mod this belongs to. More... | |
virtual string | Name [get] |
The internal name of this. More... | |
Additional Inherited Members | |
virtual bool | IsLoadingEnabled (Mod mod) |
Whether or not this type should be loaded when it's told to. Returning false disables Mod.AddContent from actually loading this type. More... | |
abstract void | Load (Mod mod) |
Called when loading the type. More... | |
abstract void | Unload () |
Called during unloading when needed. More... | |
virtual TModType | Clone (TEntity newEntity) |
Create a copy of this instanced global. Called when an entity is cloned. More... | |
virtual bool | IsLoadingEnabled (Mod mod) |
Allows you to stop Mod.AddContent from actually adding this content. Useful for items that can be disabled by a config. More... | |
virtual void | Load () |
Allows you to perform one-time loading tasks. Beware that mod content has not finished loading here, things like ModContent lookup tables or ID Sets are not fully populated. More... | |
virtual TModType | NewInstance (TEntity entity) |
Create a new instance of this ModType for a specific entity More... | |
virtual void | SetStaticDefaults () |
Allows you to modify the properties after initial loading has completed. More... | |
virtual void | SetupContent () |
If you make a new ModType, seal this override, and call SetStaticDefaults in it. More... | |
virtual void | Unload () |
Allows you to safely unload things you added in Load. More... | |
The base type for most modded things.
TModType | : | ModType | |
TModType | : | TEntity | |
TModType | : | TModType |
|
virtual |
Create a copy of this instanced global. Called when an entity is cloned.
newEntity | The new clone of the entity |
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.ModType< TEntity, TModType >.
|
protectedpure virtual |
Implements Terraria.ModLoader.ModType< TEntity >.
|
protectedvirtual |
Create dummy objects for instanced mod-types
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.ModType< TEntity, TModType >, and Terraria.ModLoader.ModType< TEntity, TModType >.
|
protectedvirtual |
Create dummy objects for instanced mod-types
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
|
virtual |
Allows you to stop Mod.AddContent from actually adding this content. Useful for items that can be disabled by a config.
mod | The mod adding this content |
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.ModType< TEntity, TModType >.
|
virtual |
Allows you to perform one-time loading tasks. Beware that mod content has not finished loading here, things like ModContent lookup tables or ID Sets are not fully populated.
Use SetStaticDefaults when you need to access content.
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.ModType< TEntity, TModType >.
|
virtual |
Create a new instance of this ModType for a specific entity
entity | The entity instance the mod type is being instantiated for |
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.ModType< TEntity, TModType >, Terraria.ModLoader.GlobalType< TEntity, TGlobal >, Terraria.ModLoader.GlobalType< Item, GlobalItem >, Terraria.ModLoader.GlobalType< NPC, GlobalNPC >, and Terraria.ModLoader.GlobalType< Projectile, GlobalProjectile >.
|
protectedpure virtual |
If you make a new ModType, seal this override.
Implements Terraria.ModLoader.ModType< TEntity >.
Implemented in Terraria.ModLoader.DamageClass, Terraria.ModLoader.GlobalBossBar, Terraria.ModLoader.GlobalBuff, Terraria.ModLoader.GlobalInfoDisplay, Terraria.ModLoader.GlobalItem, Terraria.ModLoader.GlobalNPC, Terraria.ModLoader.GlobalProjectile, Terraria.ModLoader.GlobalPylon, Terraria.ModLoader.GlobalTile, Terraria.ModLoader.GlobalWall, Terraria.ModLoader.InfoDisplay, Terraria.ModLoader.IO.TagSerializer< T, S >, Terraria.ModLoader.IO.TagSerializer< bool, byte >, Terraria.ModLoader.IO.TagSerializer< Color, int >, Terraria.ModLoader.IO.TagSerializer< Point16, TagCompound >, Terraria.ModLoader.IO.TagSerializer< Rectangle, TagCompound >, Terraria.ModLoader.IO.TagSerializer< T, TagCompound >, Terraria.ModLoader.IO.TagSerializer< uint, int >, Terraria.ModLoader.IO.TagSerializer< ulong, long >, Terraria.ModLoader.IO.TagSerializer< ushort, short >, Terraria.ModLoader.IO.TagSerializer< Vector2, TagCompound >, Terraria.ModLoader.IO.TagSerializer< Vector3, TagCompound >, Terraria.ModLoader.ModAccessorySlot, Terraria.ModLoader.ModUndergroundBackgroundStyle, Terraria.ModLoader.ModSurfaceBackgroundStyle, Terraria.ModLoader.GlobalBackgroundStyle, Terraria.ModLoader.ModBiome, Terraria.ModLoader.ModBossBar, Terraria.ModLoader.ModBossBarStyle, Terraria.ModLoader.ModBuff, Terraria.ModLoader.ModCommand, Terraria.ModLoader.ModDust, Terraria.ModLoader.ModGore, Terraria.ModLoader.ModItem, Terraria.ModLoader.ModMapLayer, Terraria.ModLoader.ModMenu, Terraria.ModLoader.ModMount, Terraria.ModLoader.ModNPC, Terraria.ModLoader.ModPlayer, Terraria.ModLoader.ModPrefix, Terraria.ModLoader.ModProjectile, Terraria.ModLoader.ModRarity, Terraria.ModLoader.ModSceneEffect, Terraria.ModLoader.ModSystem, Terraria.ModLoader.ModTile, Terraria.ModLoader.ModType< TEntity, TModType >, Terraria.ModLoader.ModWall, Terraria.ModLoader.ModWaterStyle, Terraria.ModLoader.ModWaterfallStyle, and Terraria.ModLoader.PlayerDrawLayer.
|
virtual |
Allows you to modify the properties after initial loading has completed.
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.Default.AprilFools, Terraria.ModLoader.Default.StartBag, Terraria.ModLoader.Default.UnloadedChest, Terraria.ModLoader.Default.UnloadedDresser, Terraria.ModLoader.Default.UnloadedItem, Terraria.ModLoader.Default.UnloadedNonSolidTile, Terraria.ModLoader.Default.UnloadedSemiSolidTile, Terraria.ModLoader.Default.UnloadedSolidTile, Terraria.ModLoader.Default.UnloadedSupremeFurniture, Terraria.ModLoader.Default.UnloadedWall, Terraria.ModLoader.ModBiome, Terraria.ModLoader.ModBlockType, Terraria.ModLoader.ModBuff, Terraria.ModLoader.ModDust, Terraria.ModLoader.ModMount, and Terraria.ModLoader.ModType< TEntity, TModType >.
|
virtual |
If you make a new ModType, seal this override, and call SetStaticDefaults in it.
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.DamageClass, Terraria.ModLoader.GlobalBossBar, Terraria.ModLoader.GlobalBuff, Terraria.ModLoader.GlobalInfoDisplay, Terraria.ModLoader.GlobalItem, Terraria.ModLoader.GlobalNPC, Terraria.ModLoader.GlobalProjectile, Terraria.ModLoader.GlobalPylon, Terraria.ModLoader.GlobalTile, Terraria.ModLoader.GlobalWall, Terraria.ModLoader.InfoDisplay, Terraria.ModLoader.IO.TagSerializer< T, S >, Terraria.ModLoader.IO.TagSerializer< bool, byte >, Terraria.ModLoader.IO.TagSerializer< Color, int >, Terraria.ModLoader.IO.TagSerializer< Point16, TagCompound >, Terraria.ModLoader.IO.TagSerializer< Rectangle, TagCompound >, Terraria.ModLoader.IO.TagSerializer< T, TagCompound >, Terraria.ModLoader.IO.TagSerializer< uint, int >, Terraria.ModLoader.IO.TagSerializer< ulong, long >, Terraria.ModLoader.IO.TagSerializer< ushort, short >, Terraria.ModLoader.IO.TagSerializer< Vector2, TagCompound >, Terraria.ModLoader.IO.TagSerializer< Vector3, TagCompound >, Terraria.ModLoader.ModUndergroundBackgroundStyle, Terraria.ModLoader.ModSurfaceBackgroundStyle, Terraria.ModLoader.GlobalBackgroundStyle, Terraria.ModLoader.ModBiome, Terraria.ModLoader.ModBossBar, Terraria.ModLoader.ModBossBarStyle, Terraria.ModLoader.ModBuff, Terraria.ModLoader.ModCommand, Terraria.ModLoader.ModDust, Terraria.ModLoader.ModGore, Terraria.ModLoader.ModItem, Terraria.ModLoader.ModMenu, Terraria.ModLoader.ModMount, Terraria.ModLoader.ModNPC, Terraria.ModLoader.ModPlayer, Terraria.ModLoader.ModPrefix, Terraria.ModLoader.ModProjectile, Terraria.ModLoader.ModRarity, Terraria.ModLoader.ModSystem, Terraria.ModLoader.ModTile, Terraria.ModLoader.ModType< TEntity, TModType >, Terraria.ModLoader.ModWall, Terraria.ModLoader.ModWaterStyle, Terraria.ModLoader.ModWaterfallStyle, and Terraria.ModLoader.PlayerDrawLayer.
|
virtual |
Allows you to safely unload things you added in Load.
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.ModType< TEntity, TModType >.
|
protectedvirtual |
Check for the correct overrides of different hook methods and fields and properties
Reimplemented from Terraria.ModLoader.ModType< TEntity >.
Reimplemented in Terraria.ModLoader.GlobalItem, Terraria.ModLoader.GlobalType< TEntity, TGlobal >, Terraria.ModLoader.GlobalType< Item, GlobalItem >, Terraria.ModLoader.GlobalType< NPC, GlobalNPC >, Terraria.ModLoader.GlobalType< Projectile, GlobalProjectile >, Terraria.ModLoader.ModItem, Terraria.ModLoader.ModPlayer, and Terraria.ModLoader.ModType< TEntity, TModType >.
|
get |
The internal name of this, including the mod it is from.
Implements Terraria.ModLoader.IModType.
|
getset |
The mod this belongs to.
Implements Terraria.ModLoader.IModType.
|
get |
The internal name of this.
Implements Terraria.ModLoader.IModType.