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

Inheritance diagram for Terraria.ModLoader.ModMenu:

Collaboration diagram for Terraria.ModLoader.ModMenu:

Public Member Functions
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.
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	OnDeselected ()
	Called when this ModMenu is deselected.
virtual void	Update (bool isOnTitleScreen)
	Called when this ModMenu's logic is updated.
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.
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 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.
virtual bool	IsLoadingEnabled (Mod mod)
	Allows you to stop M:Terraria.ModLoader.Mod.AddContent(Terraria.ModLoader.ILoadable) from actually adding this content. Useful for items that can be disabled by a config.
virtual void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed.
virtual void	Unload ()
	Allows you to safely unload things you added in M:Terraria.ModLoader.ModType.Load.
string	PrettyPrintName ()
virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned.
virtual TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity.

Protected Member Functions
override void	Register ()
virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.
override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.
virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.
TEntity	CreateTemplateEntity ()

Static Package Attributes
static Asset< Texture2D >	modLoaderLogo

Properties
UserInterface	UserInterface = new UserInterface() [get]
bool	IsNew [get, set]
virtual Asset< Texture2D >	Logo [get]
	The logo texture shown when this ModMenu is active. If not overridden, it will use the tModLoader logo.
virtual Asset< Texture2D >	SunTexture [get]
	The sun texture shown when this ModMenu is active. If not overridden, it will use the vanilla sun.
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 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 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.
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.
bool	IsSelected [get]
Mod	Mod [get, set]
	The mod this belongs to.
virtual string	Name [get]
	The internal name of this.
string	FullName [get]
	The internal name of this, including the mod it is from.
TEntity	Entity [get, set]
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].
virtual bool	CloneNewInstances [get]
	Whether to create new instances of this mod type via M:Terraria.ModLoader.ModType`2.Clone(`0) or via the default constructor Defaults to false (default constructor).

Private Member Functions
void ILoadable.	Load (Mod mod)
	Called when loading the type.

Private Attributes
bool?	_isCloneable

Detailed Description

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

Definition at line 12 of file ModMenu.cs.

---

The documentation for this class was generated from the following file:

• source/Terraria.ModLoader/ModMenu.cs