Each background style determines in its own way how exactly the background is drawn. This class serves as a collection of functions for above-ground backgrounds. More...

Inheritance diagram for Terraria.ModLoader.ModSurfaceBackgroundStyle:

Collaboration diagram for Terraria.ModLoader.ModSurfaceBackgroundStyle:

Public Member Functions
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.

void	ModifyFarFades (float[] fades, float transitionSpeed)
	Allows you to modify the transparency of all background styles that exist. In general, you should move the index equal to this style's slot closer to 1, and all other indexes closer to 0. The transitionSpeed parameter is what you should add/subtract to each element of the fades parameter. See the ExampleMod for an example.

virtual int	ChooseFarTexture ()
	Allows you to determine which texture is drawn in the very back of the background. BackgroundTextureLoader.GetBackgroundSlot may be useful here, as well as for the other texture-choosing hooks.

virtual int	ChooseMiddleTexture ()
	Allows you to determine which texture is drawn in the middle of the background.

virtual bool	PreDrawCloseBackground (SpriteBatch spriteBatch)
	Gives you complete freedom over how the closest part of the background is drawn. Return true for ChooseCloseTexture to have an effect; return false to disable tModLoader's own code for drawing the close background.

virtual int	ChooseCloseTexture (ref float scale, ref double parallax, ref float a, ref float b)
	Allows you to determine which texture is drawn in the closest part of the background. This also lets you modify the scale and parallax (as well as two unfortunately-unknown parameters).

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.

virtual bool	IsLoadingEnabled (Mod mod)
	Allows you to stop M:Terraria.ModLoader.Mod.AddContent(Terraria.ModLoader.ILoadable) from actually adding this content. Useful for items that can be disabled by a config.

virtual void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed.

virtual void	Unload ()
	Allows you to safely unload things you added in M:Terraria.ModLoader.ModType.Load.

string	PrettyPrintName ()

virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned.

virtual TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity.

Protected Member Functions
override void	Register ()

virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.

override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.

virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.

TEntity	CreateTemplateEntity ()

Properties
int	Slot `[get, set]`
	The ID of this underground background style.

Mod	Mod `[get, set]`
	The mod this belongs to.

virtual string	Name `[get]`
	The internal name of this.

string	FullName `[get]`
	The internal name of this, including the mod it is from.

TEntity	Entity `[get, set]`

virtual bool	IsCloneable `[get]`
	Whether or not this type is cloneable. Cloning is supported if all reference typed fields in each sub-class which doesn't override Clone are marked with [CloneByReference].

virtual bool	CloneNewInstances `[get]`
	Whether to create new instances of this mod type via M:Terraria.ModLoader.ModType`2.Clone(`0) or via the default constructor Defaults to false (default constructor).

Private Member Functions
void ILoadable.	Load (Mod mod)
	Called when loading the type.

Private Attributes
bool?	_isCloneable

Detailed Description

Each background style determines in its own way how exactly the background is drawn. This class serves as a collection of functions for above-ground backgrounds.

Definition at line 8 of file ModSurfaceBackgroundStyle.cs.

The documentation for this class was generated from the following file:

source/Terraria.ModLoader/ModSurfaceBackgroundStyle.cs

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description