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

This class represents a type of dust that is added by a mod. Only one instance of this class will ever exist for each type of dust you add. More...

Inherits Terraria.ModLoader.ModTexturedType.

Public Member Functions

virtual ? Color GetAlpha (Dust dust, Color lightColor)
 Allows you to override the color this dust will draw in. Return null to draw it in the normal light color; returns null by default. Note that the dust.noLight field makes the dust ignore lighting and draw in full brightness, and can be set in OnSpawn instead of having to return Color.White here. More...
 
virtual bool MidUpdate (Dust dust)
 Allows you to add behavior to this dust on top of the default dust behavior. Return true if you're applying your own behavior; return false to make the dust slow down by itself. Normally you will want this to return true. More...
 
virtual void OnSpawn (Dust dust)
 Allows you to modify a dust's fields when it is created. More...
 
override void SetStaticDefaults ()
 Allows you to modify the properties after initial loading has completed. This is where you would update ModDust's UpdateType property and modify the Terraria.GameContent.ChildSafety.SafeDust array. More...
 
sealed override void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
virtual bool Update (Dust dust)
 Allows you to customize how you want this type of dust to behave. Return true to allow for vanilla dust updating to also take place; will return true by default. Normally you will want this to return false. 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 Unload ()
 Allows you to safely unload things you added in Load. More...
 

Protected Member Functions

override sealed void Register ()
 If you make a new ModType, seal this override. More...
 

Properties

Asset< Texture2D > Texture2D [get]
 The sprite sheet that this type of dust uses. Normally a sprite sheet will consist of a vertical alignment of three 10 x 10 pixel squares, each one containing a possible look for the dust. More...
 
int Type [get, set]
 The ID of this type of dust. More...
 
int UpdateType = -1 [get, set]
 Allows you to choose a type of dust for this type of dust to copy the behavior of. Defaults to -1, which means that no behavior is copied. More...
 
- Properties inherited from Terraria.ModLoader.ModTexturedType
virtual string Texture [get]
 The file name of this type's texture file in the mod loader's file space. More...
 
- 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...
 

Detailed Description

This class represents a type of dust that is added by a mod. Only one instance of this class will ever exist for each type of dust you add.

Member Function Documentation

◆ GetAlpha()

virtual ? Color Terraria.ModLoader.ModDust.GetAlpha ( Dust  dust,
Color  lightColor 
)
virtual

Allows you to override the color this dust will draw in. Return null to draw it in the normal light color; returns null by default. Note that the dust.noLight field makes the dust ignore lighting and draw in full brightness, and can be set in OnSpawn instead of having to return Color.White here.

◆ MidUpdate()

virtual bool Terraria.ModLoader.ModDust.MidUpdate ( Dust  dust)
virtual

Allows you to add behavior to this dust on top of the default dust behavior. Return true if you're applying your own behavior; return false to make the dust slow down by itself. Normally you will want this to return true.

◆ OnSpawn()

virtual void Terraria.ModLoader.ModDust.OnSpawn ( Dust  dust)
virtual

Allows you to modify a dust's fields when it is created.

◆ Register()

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

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetStaticDefaults()

override void Terraria.ModLoader.ModDust.SetStaticDefaults ( )
virtual

Allows you to modify the properties after initial loading has completed. This is where you would update ModDust's UpdateType property and modify the Terraria.GameContent.ChildSafety.SafeDust array.

Reimplemented from Terraria.ModLoader.ModType.

◆ SetupContent()

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

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

Reimplemented from Terraria.ModLoader.ModType.

◆ Update()

virtual bool Terraria.ModLoader.ModDust.Update ( Dust  dust)
virtual

Allows you to customize how you want this type of dust to behave. Return true to allow for vanilla dust updating to also take place; will return true by default. Normally you will want this to return false.

Property Documentation

◆ Texture2D

Asset<Texture2D> Terraria.ModLoader.ModDust.Texture2D
get

The sprite sheet that this type of dust uses. Normally a sprite sheet will consist of a vertical alignment of three 10 x 10 pixel squares, each one containing a possible look for the dust.

◆ Type

int Terraria.ModLoader.ModDust.Type
getset

The ID of this type of dust.

◆ UpdateType

int Terraria.ModLoader.ModDust.UpdateType = -1
getset

Allows you to choose a type of dust for this type of dust to copy the behavior of. Defaults to -1, which means that no behavior is copied.