tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.PlayerDrawLayer Class Referenceabstract

This class represents a DrawLayer for the player, and uses PlayerDrawInfo as its InfoType. Drawing should be done by adding Terraria.DataStructures.DrawData objects to Main.playerDrawData. More...

Inherits Terraria.ModLoader.ModType.

Inherited by Terraria.DataStructures.VanillaPlayerDrawLayer, Terraria.ModLoader.Default.Developer.Jofairden.JofairdenArmorDrawLayer, and Terraria.ModLoader.PlayerDrawLayerSlot.

Classes

class  AfterParent
 
class  BeforeParent
 
class  Between
 
class  Multiple
 
class  Position
 
class  Transformation
 

Public Member Functions

void DrawWithTransformationAndChildren (ref PlayerDrawSet drawInfo)
 
abstract Position GetDefaultPosition ()
 Returns the layer's default position in regards to other layers. Make use of e.g BeforeParent/AfterParent, and provide a layer (usually a vanilla one from PlayerDrawLayers). More...
 
virtual bool GetDefaultVisibility (PlayerDrawSet drawInfo)
 Returns the layer's default visibility. This is usually called as a layer is queued for drawing, but modders can call it too for information. More...
 
void Hide ()
 
sealed override void SetupContent ()
 If you make a new ModType, seal this override, and call SetStaticDefaults in it. More...
 
override string ToString ()
 
- 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 Unload ()
 Allows you to safely unload things you added in Load. More...
 

Protected Member Functions

abstract void Draw (ref PlayerDrawSet drawInfo)
 Draws this layer. More...
 
sealed override void Register ()
 If you make a new ModType, seal this override. More...
 

Properties

IReadOnlyList< PlayerDrawLayerChildrenAfter [get]
 
IReadOnlyList< PlayerDrawLayerChildrenBefore [get]
 
virtual bool IsHeadLayer [get]
 Returns whether or not this layer should be rendered for the minimap icon. More...
 
virtual Transformation Transform [get]
 
bool Visible = true [get]
 
- 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...
 

Detailed Description

This class represents a DrawLayer for the player, and uses PlayerDrawInfo as its InfoType. Drawing should be done by adding Terraria.DataStructures.DrawData objects to Main.playerDrawData.

Member Function Documentation

◆ Draw()

abstract void Terraria.ModLoader.PlayerDrawLayer.Draw ( ref PlayerDrawSet  drawInfo)
protectedpure virtual

Draws this layer.

Implemented in Terraria.ModLoader.PlayerDrawLayerSlot.

◆ GetDefaultPosition()

abstract Position Terraria.ModLoader.PlayerDrawLayer.GetDefaultPosition ( )
pure virtual

Returns the layer's default position in regards to other layers. Make use of e.g BeforeParent/AfterParent, and provide a layer (usually a vanilla one from PlayerDrawLayers).

Implemented in Terraria.ModLoader.PlayerDrawLayerSlot.

◆ GetDefaultVisibility()

virtual bool Terraria.ModLoader.PlayerDrawLayer.GetDefaultVisibility ( PlayerDrawSet  drawInfo)
virtual

Returns the layer's default visibility. This is usually called as a layer is queued for drawing, but modders can call it too for information.

Returns
Whether or not this layer will be visible by default. Modders can hide layers later, if needed.

Reimplemented in Terraria.ModLoader.PlayerDrawLayerSlot.

◆ Register()

sealed override void Terraria.ModLoader.PlayerDrawLayer.Register ( )
protectedvirtual

If you make a new ModType, seal this override.

Implements Terraria.ModLoader.ModType.

◆ SetupContent()

sealed override void Terraria.ModLoader.PlayerDrawLayer.SetupContent ( )
virtual

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

Reimplemented from Terraria.ModLoader.ModType.

Property Documentation

◆ IsHeadLayer

virtual bool Terraria.ModLoader.PlayerDrawLayer.IsHeadLayer
get

Returns whether or not this layer should be rendered for the minimap icon.