This class is used to facilitate easily drawing icons and other things over the map. Pylons and spawn/bed icons are examples of vanilla map layers. Use ModSystem.PreDrawMapIconOverlay(System.Collections.Generic.IReadOnlyList<IMapLayer>, MapOverlayDrawContext) to selectively hide vanilla layers if needed. More...

Inherits Terraria.ModLoader.ModType, and Terraria.Map.IMapLayer.

Public Member Functions
abstract void	Draw (ref MapOverlayDrawContext context, ref string text)
	This method is called when this MapLayer is to be drawn. Map layers are drawn after the map itself is drawn. Use MapOverlayDrawContext.Draw(Microsoft.Xna.Framework.Graphics.Texture2D, Microsoft.Xna.Framework.Vector2, Microsoft.Xna.Framework.Color, DataStructures.SpriteFrame, float, float, Terraria.UI.Alignment) as described in ExampleMod and in vanilla examples for full compatibility and simplicity of code. More...

Public Member Functions inherited from Terraria.ModLoader.ModType
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...

Public Member Functions inherited from Terraria.Map.IMapLayer
void	Hide ()

Protected Member Functions
sealed override void	Register ()
	If you make a new ModType, seal this override. More...

Properties
bool	Visible = true `[get, set]`

Properties inherited from Terraria.ModLoader.ModType
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...

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.Map.IMapLayer
bool	Visible `[get, set]`

Detailed Description

This class is used to facilitate easily drawing icons and other things over the map. Pylons and spawn/bed icons are examples of vanilla map layers. Use ModSystem.PreDrawMapIconOverlay(System.Collections.Generic.IReadOnlyList<IMapLayer>, MapOverlayDrawContext) to selectively hide vanilla layers if needed.

Member Function Documentation

◆ Draw()

abstract void Terraria.ModLoader.ModMapLayer.Draw	(	ref MapOverlayDrawContext	context,
		ref string	text
	)

pure virtual

This method is called when this MapLayer is to be drawn. Map layers are drawn after the map itself is drawn. Use MapOverlayDrawContext.Draw(Microsoft.Xna.Framework.Graphics.Texture2D, Microsoft.Xna.Framework.Vector2, Microsoft.Xna.Framework.Color, DataStructures.SpriteFrame, float, float, Terraria.UI.Alignment) as described in ExampleMod and in vanilla examples for full compatibility and simplicity of code.

Parameters

context	Contains the scaling and positional data of the map being drawn. You should use the MapOverlayDrawContext.Draw method for all drawing
text	The mouse hover text. Assign a value typically if the user is hovering over something you draw

Implements Terraria.Map.IMapLayer.

◆ Register()

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

protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Draw()

◆ Register()