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

ModSceneEffect is an abstract class that your classes can derive from. It serves as a container for handling exclusive SceneEffect content such as backgrounds, music, and water styling. More...

Inherits Terraria.ModLoader.ModType.

Inherited by Terraria.ModLoader.ModBiome.

Public Member Functions

virtual float GetWeight (Player player)
 Is invoked when two or more modded SceneEffect layers are active within the same Priority group to attempt to determine which one should take precedence, if it matters. It's uncommon that need to assign a weight - you'd have to specifically believe that you don't need higher SceneEffectPriority, but do need to be the active SceneEffect within the priority you designated Analogously, if SceneEffect were competing in a wrestling match, this would be how likely the SceneEffect should win within its weight class. Is intentionally bounded at a max of 100% (1) to reduce complexity. Defaults to 50% (0.5). Typical calculations may include: 1) how many tiles are present as a percentage of target amount; 2) how far away you are from the cause of the SceneEffect More...
 
virtual bool IsSceneEffectActive (Player player)
 
- 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 SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
virtual void Unload ()
 Allows you to safely unload things you added in Load. More...
 

Protected Member Functions

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

Properties

virtual int Music [get]
 
virtual SceneEffectPriority Priority [get]
 The SceneEffectPriority of this SceneEffect layer. Determines the relative postion compared to vanilla SceneEffect. Analogously, if SceneEffect were competing in a wrestling match, this would be the 'Weight Class' that this SceneEffect is competing in. More...
 
virtual ModSurfaceBackgroundStyle SurfaceBackgroundStyle [get]
 
virtual CaptureBiome.TileColorStyle TileColorStyle [get]
 Used to apply secondary colour shading for the capture camera. For example, darkening the background with the GlowingMushroom style. More...
 
int Type [get, set]
 
virtual ModUndergroundBackgroundStyle UndergroundBackgroundStyle [get]
 
virtual ModWaterStyle WaterStyle [get]
 
- 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

ModSceneEffect is an abstract class that your classes can derive from. It serves as a container for handling exclusive SceneEffect content such as backgrounds, music, and water styling.

Member Function Documentation

◆ GetWeight()

virtual float Terraria.ModLoader.ModSceneEffect.GetWeight ( Player  player)
virtual

Is invoked when two or more modded SceneEffect layers are active within the same Priority group to attempt to determine which one should take precedence, if it matters. It's uncommon that need to assign a weight - you'd have to specifically believe that you don't need higher SceneEffectPriority, but do need to be the active SceneEffect within the priority you designated Analogously, if SceneEffect were competing in a wrestling match, this would be how likely the SceneEffect should win within its weight class. Is intentionally bounded at a max of 100% (1) to reduce complexity. Defaults to 50% (0.5). Typical calculations may include: 1) how many tiles are present as a percentage of target amount; 2) how far away you are from the cause of the SceneEffect

◆ Register()

override void Terraria.ModLoader.ModSceneEffect.Register ( )
protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

Property Documentation

◆ Priority

virtual SceneEffectPriority Terraria.ModLoader.ModSceneEffect.Priority
get

The SceneEffectPriority of this SceneEffect layer. Determines the relative postion compared to vanilla SceneEffect. Analogously, if SceneEffect were competing in a wrestling match, this would be the 'Weight Class' that this SceneEffect is competing in.

◆ TileColorStyle

virtual CaptureBiome.TileColorStyle Terraria.ModLoader.ModSceneEffect.TileColorStyle
get

Used to apply secondary colour shading for the capture camera. For example, darkening the background with the GlowingMushroom style.