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.
|
| 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) |
| |
| virtual void | SpecialVisuals (Player player) |
| | Allows you to create special visual effects in the area around the player. For example, the blood moon's red filter on the screen or the slime rain's falling slime in the background. You must create classes that override Terraria.Graphics.Shaders.ScreenShaderData or Terraria.Graphics.Effects.CustomSky, add them in your mod's Load hook, then call Player.ManageSpecialBiomeVisuals. See the ExampleMod if you do not have access to the source code. 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 | 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...
|
| |
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.
◆ 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 |
◆ SpecialVisuals()
| virtual void Terraria.ModLoader.ModSceneEffect.SpecialVisuals |
( |
Player |
player | ) |
|
|
virtual |
Allows you to create special visual effects in the area around the player. For example, the blood moon's red filter on the screen or the slime rain's falling slime in the background. You must create classes that override Terraria.Graphics.Shaders.ScreenShaderData or Terraria.Graphics.Effects.CustomSky, add them in your mod's Load hook, then call Player.ManageSpecialBiomeVisuals. See the ExampleMod if you do not have access to the source code.
◆ Priority
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.
Public Member Functions inherited from Terraria.ModLoader.ModType
1.9.1