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 M:Terraria.ModLoader.ModSystem.PreDrawMapIconOverlay(System.Collections.Generic.IReadOnlyList<Terraria.Map.IMapLayer>,Terraria.Map.MapOverlayDrawContext) to selectively hide vanilla layers if needed. More...

Inheritance diagram for Terraria.ModLoader.ModMapLayer:

Collaboration diagram for Terraria.ModLoader.ModMapLayer:

Public Member Functions
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 M:Terraria.Map.MapOverlayDrawContext.Draw(Microsoft.Xna.Framework.Graphics.Texture2D,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Color,Terraria.DataStructures.SpriteFrame,System.Single,System.Single,Terraria.UI.Alignment) as described in ExampleMod and in vanilla examples for full compatibility and simplicity of 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	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.

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.

void	Hide ()

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 ()

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

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

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 M:Terraria.ModLoader.ModSystem.PreDrawMapIconOverlay(System.Collections.Generic.IReadOnlyList<Terraria.Map.IMapLayer>,Terraria.Map.MapOverlayDrawContext) to selectively hide vanilla layers if needed.

Definition at line 8 of file ModMapLayer.cs.

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

source/Terraria.ModLoader/ModMapLayer.cs

Public Member Functions

Protected Member Functions

Properties

Private Member Functions

Private Attributes

Detailed Description