tModLoader  0.12 Alpha
A mod to make and play Terraria mods
Terraria.ModLoader.PlayerDrawLayerSlot Class Reference

Inherits Terraria.ModLoader.PlayerDrawLayer.

Public Member Functions

override 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...
 
override 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...
 
- Public Member Functions inherited from Terraria.ModLoader.PlayerDrawLayer
void DrawWithTransformationAndChildren (ref PlayerDrawSet drawInfo)
 
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

override void Draw (ref PlayerDrawSet drawInfo)
 Draws this layer. More...
 
- Protected Member Functions inherited from Terraria.ModLoader.PlayerDrawLayer
sealed override void Register ()
 If you make a new ModType, seal this override. More...
 

Properties

Multiple.Condition Condition [get]
 
PlayerDrawLayer Layer [get]
 
override string Name [get]
 
- Properties inherited from Terraria.ModLoader.PlayerDrawLayer
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...
 

Member Function Documentation

◆ Draw()

override void Terraria.ModLoader.PlayerDrawLayerSlot.Draw ( ref PlayerDrawSet  drawInfo)
protectedvirtual

Draws this layer.

Implements Terraria.ModLoader.PlayerDrawLayer.

◆ GetDefaultPosition()

override Position Terraria.ModLoader.PlayerDrawLayerSlot.GetDefaultPosition ( )
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).

Implements Terraria.ModLoader.PlayerDrawLayer.

◆ GetDefaultVisibility()

override bool Terraria.ModLoader.PlayerDrawLayerSlot.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 from Terraria.ModLoader.PlayerDrawLayer.