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...

Collaboration diagram for Terraria.ModLoader.ModWaterfallStyle:

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 bool	Autoload (ref string name, ref string texture)
	Allows you to automatically add a ModWaterfallStyle instead of using Mod.AddWaterfallStyle. Return true to allow autoloading; by default returns the mod's autoload property. Name is initialized to the overriding class name, and texture is initialized to the namespace and overriding class name with periods replaced with slashes. Use this to either force or stop an autoload, change the name that identifies this type of ModWaterStyle, or change the texture path used by this ModWaterfallStyle. 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...

Properties
Mod	mod [get, set]
	The mod that added this style of waterfall. More...
string	Name [get, set]
	The internal name of this waterfall style. More...
int	Type [get, set]
	The ID of this waterfall style. More...

Detailed Description

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

Definition at line 86 of file ModWaterStyle.cs.

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.

Definition at line 124 of file ModWaterStyle.cs.

                                                   {
        }

Autoload()

virtual bool Terraria.ModLoader.ModWaterfallStyle.Autoload ( ref string  name, ref string  texture  )

virtual

Allows you to automatically add a ModWaterfallStyle instead of using Mod.AddWaterfallStyle. Return true to allow autoloading; by default returns the mod's autoload property. Name is initialized to the overriding class name, and texture is initialized to the namespace and overriding class name with periods replaced with slashes. Use this to either force or stop an autoload, change the name that identifies this type of ModWaterStyle, or change the texture path used by this ModWaterfallStyle.

Definition at line 117 of file ModWaterStyle.cs.

                                                                          {
            return mod.Properties.Autoload;
        }

References Terraria.ModLoader.ModProperties.Autoload, Terraria.ModLoader.ModWaterfallStyle.mod, and Terraria.ModLoader.Mod.Properties.

Referenced by Terraria.ModLoader.Mod.AutoloadWaterfallStyle().

Here is the caller graph for this function:

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.

Definition at line 130 of file ModWaterStyle.cs.

                                                                                            {
        }

Property Documentation

mod

Mod Terraria.ModLoader.ModWaterfallStyle.mod

getset

The mod that added this style of waterfall.

Definition at line 91 of file ModWaterStyle.cs.

                       {
            get;
            internal set;
        }

Referenced by Terraria.ModLoader.ModWaterfallStyle.Autoload().

Name

string Terraria.ModLoader.ModWaterfallStyle.Name

getset

The internal name of this waterfall style.

Definition at line 99 of file ModWaterStyle.cs.

                           {
            get;
            internal set;
        }

Referenced by Terraria.ModLoader.Mod.AutoloadWaterfallStyle().

Type

int Terraria.ModLoader.ModWaterfallStyle.Type

getset

The ID of this waterfall style.

Definition at line 107 of file ModWaterStyle.cs.

                        {
            get;
            internal set;
        }