tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.ModSurfaceBackgroundStyle Class Referenceabstract

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

Inherits Terraria.ModLoader.ModBackgroundStyle.

Public Member Functions

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). More...
 
virtual int ChooseFarTexture ()
 Allows you to determine which texture is drawn in the very back of the background. Mod.GetBackgroundSlot may be useful here, as well as for the other texture-choosing hooks. More...
 
virtual int ChooseMiddleTexture ()
 Allows you to determine which texture is drawn in the middle of the background. More...
 
abstract 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. More...
 
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. 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

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

Additional Inherited Members

- Properties inherited from Terraria.ModLoader.ModBackgroundStyle
int Slot [get, set]
 The ID of this underground background style. 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

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.

Member Function Documentation

◆ ChooseCloseTexture()

virtual int Terraria.ModLoader.ModSurfaceBackgroundStyle.ChooseCloseTexture ( ref float  scale,
ref double  parallax,
ref float  a,
ref float  b 
)
virtual

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

Parameters
scaleThe scale.
parallaxThe parallax value.
aa?
bb?
Returns

◆ ChooseFarTexture()

virtual int Terraria.ModLoader.ModSurfaceBackgroundStyle.ChooseFarTexture ( )
virtual

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

◆ ChooseMiddleTexture()

virtual int Terraria.ModLoader.ModSurfaceBackgroundStyle.ChooseMiddleTexture ( )
virtual

Allows you to determine which texture is drawn in the middle of the background.

◆ ModifyFarFades()

abstract void Terraria.ModLoader.ModSurfaceBackgroundStyle.ModifyFarFades ( float[]  fades,
float  transitionSpeed 
)
pure virtual

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.

◆ PreDrawCloseBackground()

virtual bool Terraria.ModLoader.ModSurfaceBackgroundStyle.PreDrawCloseBackground ( SpriteBatch  spriteBatch)
virtual

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.

◆ Register()

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

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

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

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

Reimplemented from Terraria.ModLoader.ModType.