Terraria.ModLoader.ModMenu Class Reference

A class that is used to customize aesthetic features of the main menu, such as the logo, background and music. More...

Inherits Terraria.ModLoader.ModType< TEntity, TModType >.

Inherited by Terraria.ModLoader.Default.MenuJourneysEnd, Terraria.ModLoader.Default.MenuOldVanilla, and Terraria.ModLoader.Default.MenutML.

Public Member Functions
virtual void	OnDeselected ()
	Called when this ModMenu is deselected.
virtual void	OnSelected ()
	Called when this ModMenu is selected. Set the state of the UserInterface to a given UIState to make that UIState appear on the main menu.
virtual void	PostDrawLogo (SpriteBatch spriteBatch, Vector2 logoDrawCenter, float logoRotation, float logoScale, Color drawColor)
	Called just after the logo is drawn, and gives the values of some of the parameters of the logo draw code.
virtual bool	PreDrawLogo (SpriteBatch spriteBatch, ref Vector2 logoDrawCenter, ref float logoRotation, ref float logoScale, ref Color drawColor)
	Called just before the logo is drawn, and allows you to modify some of the parameters of the logo draw code.
sealed override void	SetupContent ()
	If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
virtual void	Update (bool isOnTitleScreen)
	Called when this ModMenu's logic is updated.
virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned. 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 TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity 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...
virtual bool	IsLoadingEnabled (Mod mod)
	Whether or not this type should be loaded when it's told to. Returning false disables Mod.AddContent from actually loading this type. More...
abstract void	Load (Mod mod)
	Called when loading the type. More...
abstract void	Unload ()
	Called during unloading when needed. More...
virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned. 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 TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity 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
sealed override void	Register ()
	If you make a new ModType, seal this override. More...
Protected Member Functions inherited from Terraria.ModLoader.ModType< TEntity, TModType >
abstract TEntity	CreateTemplateEntity ()
virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types More...
override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types More...
abstract void	Register ()
	If you make a new ModType, seal this override. More...
virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties More...
Protected Member Functions inherited from Terraria.ModLoader.ModType< TEntity >
abstract TEntity	CreateTemplateEntity ()
virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types More...
override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types
abstract void	Register ()
	If you make a new ModType, seal this override. More...
virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties More...

Properties
virtual string	DisplayName [get]
	Controls the name that shows up at the base of the screen when this ModMenu is active. If not overridden, it will use this mod's display name.
virtual bool	IsAvailable [get]
	Controls whether this ModMenu will be available to switch to. Useful if you want this menu to only be available at specific times.
bool	IsNew [get, set]
bool	IsSelected [get]
virtual Asset< Texture2D >	Logo [get]
	The logo texture shown when this ModMenu is active. If not overridden, it will use the tModLoader logo.
virtual ModSurfaceBackgroundStyle	MenuBackgroundStyle [get]
	The background style that will be used when this ModMenu is active. If not overridden, it will use the vanilla background.
virtual Asset< Texture2D >	MoonTexture [get]
	The moon texture shown when this ModMenu is active. If not overridden, it will use the vanilla moon.
virtual int	Music [get]
	The music that will be played while this ModMenu is active. If not overridden, it will use the vanilla music.
virtual Asset< Texture2D >	SunTexture [get]
	The sun texture shown when this ModMenu is active. If not overridden, it will use the vanilla sun.
UserInterface	UserInterface = new UserInterface() [get]
Properties inherited from Terraria.ModLoader.ModType< TEntity, TModType >
virtual bool	CloneNewInstances [get]
	Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor).
TEntity	Entity [get, set]
string	FullName [get]
	The internal name of this, including the mod it is from. More...
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]
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...
Properties inherited from Terraria.ModLoader.ModType< TEntity >
virtual bool	CloneNewInstances [get]
	Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor).
TEntity	Entity [get, set]
string	FullName [get]
	The internal name of this, including the mod it is from. More...
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]
Mod	Mod [get, set]
	The mod this belongs to. More...
virtual string	Name [get]
	The internal name of this. More...

Detailed Description

A class that is used to customize aesthetic features of the main menu, such as the logo, background and music.

Member Function Documentation

Register()

sealed override void Terraria.ModLoader.ModMenu.Register ( )

protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType< TEntity, TModType >.

SetupContent()

sealed override void Terraria.ModLoader.ModMenu.SetupContent ( )

virtual

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

Reimplemented from Terraria.ModLoader.ModType< TEntity, TModType >.