ModPrefix Class Reference

Inherits ModType< TEntity, TModType >, and ILocalizedModType.

Inherited by UnloadedPrefix.

Public Member Functions
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. Vanilla stat changes ( See also SetStats ) are checked automatically, so there is no need to override this method to check them More...
virtual void	Apply (Item item)
	Applies the custom data stats set in SetStats to the given item.
virtual void	ApplyAccessoryEffects (Player player)
	Use this to modify player stats (or any other applicable data) based on this ModPrefix. More...
virtual bool	CanRoll (Item item)
	Returns if your ModPrefix can roll on the given item By default returns RollChance(item) > 0
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 SetStats will automatically generate tooltips. (such as damage, use speed, crit chance, mana cost, scale, shoot speed, and knockback) More...
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 float	RollChance (Item item)
	The roll chance of your prefix relative to a vanilla prefix, 1f by default.
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.
sealed override void	SetupContent ()
	If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
Public Member Functions inherited from ModType< TEntity, TModType >
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...
string	PrettyPrintName ()
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...
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...
Public Member Functions inherited from ModType< TEntity >
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...
string	PrettyPrintName ()
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
sealed override void	Register ()
	If you make a new ModType, seal this override. More...
Protected Member Functions inherited from ModType< TEntity, TModType >
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 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 PrefixCategory	Category [get]
	The category your prefix belongs to, PrefixCategory.Custom by default
virtual LocalizedText	DisplayName [get]
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 ModType classes can utilize this. More...
int	Type [get, set]
Properties inherited from ModType< TEntity, TModType >
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 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 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...
Properties inherited from ILocalizedModType
abstract 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 ModType classes can utilize this. More...

Member Function Documentation

AllStatChangesHaveEffectOn()

virtual bool ModPrefix.AllStatChangesHaveEffectOn ( Item  item )

virtual

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. Vanilla stat changes (

See also

SetStats

) are checked automatically, so there is no need to override this method to check them

Returns

false to prevent the prefix from being applied

ApplyAccessoryEffects()

virtual void ModPrefix.ApplyAccessoryEffects ( Player  player )

virtual

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

Parameters

player

The player gaining the benefits of this accessory.

GetTooltipLines()

virtual IEnumerable< TooltipLine > ModPrefix.GetTooltipLines ( Item  item )

virtual

Use this to add tooltips to any item with this prefix applied. Note that the stat bonuses applied via SetStats will automatically generate tooltips. (such as damage, use speed, crit chance, mana cost, scale, shoot speed, and knockback)

Reimplemented in UnloadedPrefix.

Register()

sealed override void ModPrefix.Register ( )

protectedvirtual

If you make a new ModType, seal this override.

Implements ModType< TEntity >.

SetupContent()

sealed override void ModPrefix.SetupContent ( )

virtual

If you make a new ModType, seal this override, and call SetStaticDefaults in it.

Reimplemented from ModType< TEntity >.

Property Documentation

LocalizationCategory

virtual string ModPrefix.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 ModType classes can utilize this.

Implements ILocalizedModType.