Represents a style of water that gets drawn, based on factors such as the background. This is used to determine the color of the water, as well as other things as determined by the hooks below.
More...
Inherits Terraria.ModLoader.ModTexturedType.
|
virtual Color | BiomeHairColor () |
| Allows you to change the hair color resulting from the biome hair dye when this water style is in use. More...
|
|
abstract int | ChooseWaterfallStyle () |
| The ID of the waterfall style the game should use when this water style is in use. More...
|
|
abstract int | GetDropletGore () |
| The ID of the gore that represents droplets of water falling down from a block. More...
|
|
virtual Asset< Texture2D > | GetRainTexture () |
| Returns the texture to be used when drawing rain of this water type.
Default uses the vanilla rain texture. More...
|
|
virtual byte | GetRainVariant () |
| Return the variant of rain used. Equal to the offset in the rain texture divided by four.
Vanilla rain has three variants per biome, and so vanilla variants range from 0 to 3 * Main.maxLiquidTextures.
Default is a random number from 0 to 2, which creates normal vanilla forest biome rain. More...
|
|
abstract int | GetSplashDust () |
| The ID of the dust that is created when anything splashes in water. More...
|
|
virtual void | LightColorMultiplier (ref float r, ref float g, ref float b) |
| Allows you to modify the light levels of the tiles behind the water. The light color components will be multiplied by the parameters. More...
|
|
sealed override void | SetupContent () |
| If you make a new ModType, seal this override, and call SetStaticDefaults in it. 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 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...
|
|
|
virtual string | BlockTexture [get] |
|
int | Slot [get, set] |
| The ID of the water style. More...
|
|
virtual string | Texture [get] |
| The file name of this type's texture file in the mod loader's file space. More...
|
|
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...
|
|
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...
|
|
Represents a style of water that gets drawn, based on factors such as the background. This is used to determine the color of the water, as well as other things as determined by the hooks below.
◆ BiomeHairColor()
virtual Color Terraria.ModLoader.ModWaterStyle.BiomeHairColor |
( |
| ) |
|
|
virtual |
Allows you to change the hair color resulting from the biome hair dye when this water style is in use.
◆ ChooseWaterfallStyle()
abstract int Terraria.ModLoader.ModWaterStyle.ChooseWaterfallStyle |
( |
| ) |
|
|
pure virtual |
The ID of the waterfall style the game should use when this water style is in use.
◆ GetDropletGore()
abstract int Terraria.ModLoader.ModWaterStyle.GetDropletGore |
( |
| ) |
|
|
pure virtual |
The ID of the gore that represents droplets of water falling down from a block.
◆ GetRainTexture()
virtual Asset<Texture2D> Terraria.ModLoader.ModWaterStyle.GetRainTexture |
( |
| ) |
|
|
virtual |
Returns the texture to be used when drawing rain of this water type.
Default uses the vanilla rain texture.
◆ GetRainVariant()
virtual byte Terraria.ModLoader.ModWaterStyle.GetRainVariant |
( |
| ) |
|
|
virtual |
Return the variant of rain used. Equal to the offset in the rain texture divided by four.
Vanilla rain has three variants per biome, and so vanilla variants range from 0 to 3 * Main.maxLiquidTextures.
Default is a random number from 0 to 2, which creates normal vanilla forest biome rain.
◆ GetSplashDust()
abstract int Terraria.ModLoader.ModWaterStyle.GetSplashDust |
( |
| ) |
|
|
pure virtual |
The ID of the dust that is created when anything splashes in water.
◆ LightColorMultiplier()
virtual void Terraria.ModLoader.ModWaterStyle.LightColorMultiplier |
( |
ref float |
r, |
|
|
ref float |
g, |
|
|
ref float |
b |
|
) |
| |
|
virtual |
Allows you to modify the light levels of the tiles behind the water. The light color components will be multiplied by the parameters.
◆ Register()
sealed override void Terraria.ModLoader.ModWaterStyle.Register |
( |
| ) |
|
|
protectedvirtual |
◆ SetupContent()
sealed override void Terraria.ModLoader.ModWaterStyle.SetupContent |
( |
| ) |
|
|
virtual |
◆ Slot
int Terraria.ModLoader.ModWaterStyle.Slot |
|
getset |
The ID of the water style.