tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.ModRarity Class Reference

Inherits Terraria.ModLoader.ModType.

Public Member Functions

virtual int GetPrefixedRarity (int offset, float valueMult)
 Allows you to modify which rarities will come before and after this when a modifier is applied (since modifiers can affect rarity) More...
 
sealed override void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
- Public Member Functions inherited from Terraria.ModLoader.ModType
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 void SetStaticDefaults ()
 Allows you to modify the properties after initial loading has completed. 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...
 

Properties

virtual Color RarityColor [get]
 Your ModRarity's color. Returns White by default. More...
 
int Type [get, set]
 
- Properties inherited from Terraria.ModLoader.ModType
string FullName [get]
 The internal name of this, including the mod it is from. More...
 
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...
 

Member Function Documentation

◆ GetPrefixedRarity()

virtual int Terraria.ModLoader.ModRarity.GetPrefixedRarity ( int  offset,
float  valueMult 
)
virtual

Allows you to modify which rarities will come before and after this when a modifier is applied (since modifiers can affect rarity)

Parameters
offsetThe amount by which the rarity would be offset in vanilla. -2 is the most it can go down, and +2 is the most it can go up by.
valueMultThe combined stat and prefix value scale. Can be used to implement super high or low value rarity adjustments outside normal vanilla ranges
Returns
The adjusted rarity type. Return
Type
for no change.

◆ Register()

sealed override void Terraria.ModLoader.ModRarity.Register ( )
protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

sealed override void Terraria.ModLoader.ModRarity.SetupContent ( )
virtual

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

Reimplemented from Terraria.ModLoader.ModType.

Property Documentation

◆ RarityColor

virtual Color Terraria.ModLoader.ModRarity.RarityColor
get

Your ModRarity's color. Returns White by default.

Returns