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

Represents a style of waterfalls that gets drawn. This is mostly used to determine the color of the waterfall. More...

Inherits Terraria.ModLoader.ModTexturedType.

Public Member Functions

virtual void AddLight (int i, int j)
 Allows you to create light at a tile occupied by a waterfall of this style. More...
 
virtual void ColorMultiplier (ref float r, ref float g, ref float b, float a)
 Allows you to determine the color multiplier acting on waterfalls of this style. Useful for waterfalls whose colors change over time. 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

int Slot [get, set]
 The ID of this waterfall style. 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

Represents a style of waterfalls that gets drawn. This is mostly used to determine the color of the waterfall.

Member Function Documentation

◆ AddLight()

virtual void Terraria.ModLoader.ModWaterfallStyle.AddLight ( int  i,
int  j 
)
virtual

Allows you to create light at a tile occupied by a waterfall of this style.

◆ ColorMultiplier()

virtual void Terraria.ModLoader.ModWaterfallStyle.ColorMultiplier ( ref float  r,
ref float  g,
ref float  b,
float  a 
)
virtual

Allows you to determine the color multiplier acting on waterfalls of this style. Useful for waterfalls whose colors change over time.

◆ Register()

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

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

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

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

Reimplemented from Terraria.ModLoader.ModType.

Property Documentation

◆ Slot

int Terraria.ModLoader.ModWaterfallStyle.Slot
getset

The ID of this waterfall style.