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.
Inherited by Terraria.ModLoader.Default.MenuJourneysEnd, Terraria.ModLoader.Default.MenuOldVanilla, and Terraria.ModLoader.Default.MenutML.
|
virtual void | OnDeselected () |
| Called when this ModMenu is deselected. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. 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 | Unload () |
| Allows you to safely unload things you added in Load. More...
|
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
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. More...
|
|
virtual Asset< Texture2D > | MoonTexture [get] |
| The moon texture shown when this ModMenu is active. If not overridden, it will use the vanilla moon. More...
|
|
virtual int | Music [get] |
| The music that will be played while this ModMenu is active. If not overridden, it will use the vanilla music. More...
|
|
virtual Asset< Texture2D > | SunTexture [get] |
| The sun texture shown when this ModMenu is active. If not overridden, it will use the vanilla sun. More...
|
|
UserInterface | UserInterface = new UserInterface() [get] |
|
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...
|
|
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...
|
|
A class that is used to customize aesthetic features of the main menu, such as the logo, background and music.
◆ OnDeselected()
virtual void Terraria.ModLoader.ModMenu.OnDeselected |
( |
| ) |
|
|
virtual |
Called when this ModMenu is deselected.
◆ OnSelected()
virtual void Terraria.ModLoader.ModMenu.OnSelected |
( |
| ) |
|
|
virtual |
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.
◆ PostDrawLogo()
virtual void Terraria.ModLoader.ModMenu.PostDrawLogo |
( |
SpriteBatch |
spriteBatch, |
|
|
Vector2 |
logoDrawCenter, |
|
|
float |
logoRotation, |
|
|
float |
logoScale, |
|
|
Color |
drawColor |
|
) |
| |
|
virtual |
Called just after the logo is drawn, and gives the values of some of the parameters of the logo draw code.
◆ PreDrawLogo()
virtual bool Terraria.ModLoader.ModMenu.PreDrawLogo |
( |
SpriteBatch |
spriteBatch, |
|
|
ref Vector2 |
logoDrawCenter, |
|
|
ref float |
logoRotation, |
|
|
ref float |
logoScale, |
|
|
ref Color |
drawColor |
|
) |
| |
|
virtual |
Called just before the logo is drawn, and allows you to modify some of the parameters of the logo draw code.
◆ Register()
sealed override void Terraria.ModLoader.ModMenu.Register |
( |
| ) |
|
|
protectedvirtual |
◆ SetupContent()
sealed override void Terraria.ModLoader.ModMenu.SetupContent |
( |
| ) |
|
|
virtual |
◆ Update()
virtual void Terraria.ModLoader.ModMenu.Update |
( |
bool |
isOnTitleScreen | ) |
|
|
virtual |
Called when this ModMenu's logic is updated.
◆ DisplayName
virtual string Terraria.ModLoader.ModMenu.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.
◆ IsAvailable
virtual bool Terraria.ModLoader.ModMenu.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.
◆ Logo
virtual Asset<Texture2D> Terraria.ModLoader.ModMenu.Logo |
|
get |
The logo texture shown when this ModMenu is active. If not overridden, it will use the tModLoader logo.
◆ MenuBackgroundStyle
The background style that will be used when this ModMenu is active. If not overridden, it will use the vanilla background.
◆ MoonTexture
virtual Asset<Texture2D> Terraria.ModLoader.ModMenu.MoonTexture |
|
get |
The moon texture shown when this ModMenu is active. If not overridden, it will use the vanilla moon.
◆ Music
virtual int Terraria.ModLoader.ModMenu.Music |
|
get |
The music that will be played while this ModMenu is active. If not overridden, it will use the vanilla music.
◆ SunTexture
virtual Asset<Texture2D> Terraria.ModLoader.ModMenu.SunTexture |
|
get |
The sun texture shown when this ModMenu is active. If not overridden, it will use the vanilla sun.