Inheritance diagram for Terraria.ModLoader.ModPrefix:

Collaboration diagram for Terraria.ModLoader.ModPrefix:

Public Member Functions
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.

virtual float	RollChance (Item item)
	The roll chance of your prefix relative to a vanilla prefix, 1f by default.

virtual bool	CanRoll (Item item)
	Returns if your ModPrefix can roll on the given item By default returns RollChance(item) > 0.

virtual void	SetStats (ref float damageMult, ref float knockbackMult, ref float useTimeMult, ref float scaleMult, ref float shootSpeedMult, ref float manaMult, ref int critBonus)
	Sets the stat changes for this prefix. If data is not already pre-stored, it is best to store custom data changes to some static variables.

virtual bool	AllStatChangesHaveEffectOn (Item item)
	Use this to check whether modifiers to custom stats would be too small to have an effect after rounding, and prevent the prefix from being applied to the given item if there would be no change.

virtual void	Apply (Item item)
	Applies the custom data stats set in SetStats to the given item.

virtual void	ModifyValue (ref float valueMult)
	Allows you to modify the sell price of the item based on the prefix or changes in custom data stats. This also influences the item's rarity.

virtual void	ApplyAccessoryEffects (Player player)
	Use this to modify player stats (or any other applicable data) based on this ModPrefix.

virtual IEnumerable< TooltipLine >	GetTooltipLines (Item item)
	Use this to add tooltips to any item with this prefix applied. Note that the stat bonuses applied via M:Terraria.ModLoader.ModPrefix.SetStats(System.Single@,System.Single@,System.Single@,System.Single@,System.Single@,System.Single@,System.Int32@) will automatically generate tooltips. (such as damage, use speed, crit chance, mana cost, scale, shoot speed, and knockback)

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.

virtual bool	IsLoadingEnabled (Mod mod)
	Allows you to stop M:Terraria.ModLoader.Mod.AddContent(Terraria.ModLoader.ILoadable) from actually adding this content. Useful for items that can be disabled by a config.

virtual void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed.

virtual void	Unload ()
	Allows you to safely unload things you added in M:Terraria.ModLoader.ModType.Load.

string	PrettyPrintName ()

virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned.

virtual TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity.

Protected Member Functions
override void	Register ()

virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.

override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.

virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.

TEntity	CreateTemplateEntity ()

Properties
int	Type `[get, set]`

virtual string	LocalizationCategory `[get]`
	The category used by this modded content for use in localization keys. Localization keys follow the pattern of "Mods.{ModName}.{Category}.{ContentName}.{DataName}". The Localization wiki pageexplains how custom T:Terraria.ModLoader.ModType classes can utilize this.

virtual LocalizedText	DisplayName `[get]`

virtual PrefixCategory	Category `[get]`
	The category your prefix belongs to, PrefixCategory.Custom by default.

Mod	Mod `[get, set]`
	The mod this belongs to.

virtual string	Name `[get]`
	The internal name of this.

string	FullName `[get]`
	The internal name of this, including the mod it is from.

TEntity	Entity `[get, set]`

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].

virtual bool	CloneNewInstances `[get]`
	Whether to create new instances of this mod type via M:Terraria.ModLoader.ModType`2.Clone(`0) or via the default constructor Defaults to false (default constructor).

Private Member Functions
void ILoadable.	Load (Mod mod)
	Called when loading the type.

Private Attributes
bool?	_isCloneable

Detailed Description

Definition at line 7 of file ModPrefix.cs.

The documentation for this class was generated from the following file:

source/Terraria.ModLoader/ModPrefix.cs

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description