Terraria.ModLoader.ModProperties Struct Reference

This is a struct that stores the properties of a mod. Without setting it in your Mod constructor, all properties default to true. More...

Collaboration diagram for Terraria.ModLoader.ModProperties:

Public Attributes
bool	Autoload
	Whether or not this mod will autoload content by default. Autoloading content means you do not need to manually add content through methods. More...
bool	AutoloadBackgrounds
	Whether or not this mod will automatically add images in the Backgrounds folder as background textures to the game. This means you do not need to manually call Mod.AddBackgroundTexture. More...
bool	AutoloadGores
	Whether or not this mod will automatically add images in the Gores folder as gores to the game, along with any ModGore classes that share names with the images. This means you do not need to manually call Mod.AddGore. More...
bool	AutoloadSounds
	Whether or not this mod will automatically add sounds in the Sounds folder to the game. Place sounds in Sounds/Item to autoload them as item sounds, Sounds/NPCHit to add them as npcHit sounds, Sounds/NPCKilled to add them as npcKilled sounds, and Sounds/Music to add them as music tracks. Sounds placed anywhere else in the Sounds folder will be added as custom sounds. Any ModSound classes that share the same name as the sound files will be bound to them. Setting this field to true means that you do not need to manually call AddSound. More...

Properties
static ModProperties	AutoLoadAll [get]
	Automatically return a ModProperties object which has all AutoLoad values set to true. More...

Detailed Description

This is a struct that stores the properties of a mod. Without setting it in your Mod constructor, all properties default to true.

Definition at line 6 of file ModProperties.cs.

Member Data Documentation

Autoload

bool Terraria.ModLoader.ModProperties.Autoload

Whether or not this mod will autoload content by default. Autoloading content means you do not need to manually add content through methods.

Definition at line 11 of file ModProperties.cs.

Referenced by Terraria.ModLoader.GlobalBuff.Autoload(), Terraria.ModLoader.GlobalItem.Autoload(), Terraria.ModLoader.GlobalNPC.Autoload(), Terraria.ModLoader.GlobalProjectile.Autoload(), Terraria.ModLoader.GlobalRecipe.Autoload(), Terraria.ModLoader.GlobalTile.Autoload(), Terraria.ModLoader.GlobalWall.Autoload(), Terraria.ModLoader.ModUgBgStyle.Autoload(), Terraria.ModLoader.ModSurfaceBgStyle.Autoload(), Terraria.ModLoader.GlobalBgStyle.Autoload(), Terraria.ModLoader.ModItem.Autoload(), Terraria.ModLoader.ModNPC.Autoload(), Terraria.ModLoader.ModPlayer.Autoload(), Terraria.ModLoader.ModPrefix.Autoload(), Terraria.ModLoader.ModProjectile.Autoload(), Terraria.ModLoader.ModTileEntity.Autoload(), Terraria.ModLoader.ModWorld.Autoload(), Terraria.ModLoader.ModBuff.Autoload(), Terraria.ModLoader.ModDust.Autoload(), Terraria.ModLoader.ModTile.Autoload(), Terraria.ModLoader.ModWall.Autoload(), Terraria.ModLoader.ModWaterfallStyle.Autoload(), Terraria.ModLoader.ModMountData.Autoload(), and Terraria.ModLoader.ModWaterStyle.Autoload().

AutoloadBackgrounds

bool Terraria.ModLoader.ModProperties.AutoloadBackgrounds

Whether or not this mod will automatically add images in the Backgrounds folder as background textures to the game. This means you do not need to manually call Mod.AddBackgroundTexture.

Definition at line 23 of file ModProperties.cs.

AutoloadGores

bool Terraria.ModLoader.ModProperties.AutoloadGores

Whether or not this mod will automatically add images in the Gores folder as gores to the game, along with any ModGore classes that share names with the images. This means you do not need to manually call Mod.AddGore.

Definition at line 15 of file ModProperties.cs.

AutoloadSounds

bool Terraria.ModLoader.ModProperties.AutoloadSounds

Whether or not this mod will automatically add sounds in the Sounds folder to the game. Place sounds in Sounds/Item to autoload them as item sounds, Sounds/NPCHit to add them as npcHit sounds, Sounds/NPCKilled to add them as npcKilled sounds, and Sounds/Music to add them as music tracks. Sounds placed anywhere else in the Sounds folder will be added as custom sounds. Any ModSound classes that share the same name as the sound files will be bound to them. Setting this field to true means that you do not need to manually call AddSound.

Definition at line 19 of file ModProperties.cs.

Property Documentation

AutoLoadAll

ModProperties Terraria.ModLoader.ModProperties.AutoLoadAll

staticget

Initial value:

=
            new ModProperties() {
                Autoload = true,
                AutoloadGores = true,
                AutoloadSounds = true,
                AutoloadBackgrounds = true
            }

Automatically return a ModProperties object which has all AutoLoad values set to true.

Definition at line 28 of file ModProperties.cs.

{ get; } =