tModLoader v2023.01
A mod to make and play Terraria mods
|
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< TEntity, TModType >.
Inherited by Terraria.DataStructures.VanillaPlayerDrawLayer, Terraria.ModLoader.Default.Developer.Jofairden.JofairdenArmorDrawLayer, Terraria.ModLoader.Default.Patreon.GuildpackEyeGlowDrawLayer, Terraria.ModLoader.Default.Patreon.GuildpackMiscEffectsDrawLayer, 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 () |
virtual TModType | Clone (TEntity newEntity) |
Create a copy of this instanced global. Called when an entity is cloned. 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 TModType | NewInstance (TEntity entity) |
Create a new instance of this ModType for a specific entity 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... | |
virtual bool | IsLoadingEnabled (Mod mod) |
Whether or not this type should be loaded when it's told to. Returning false disables Mod.AddContent from actually loading this type. More... | |
abstract void | Load (Mod mod) |
Called when loading the type. More... | |
abstract void | Unload () |
Called during unloading when needed. More... | |
virtual TModType | Clone (TEntity newEntity) |
Create a copy of this instanced global. Called when an entity is cloned. 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 TModType | NewInstance (TEntity entity) |
Create a new instance of this ModType for a specific entity 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... | |
Protected Member Functions | |
abstract void | Draw (ref PlayerDrawSet drawInfo) |
Draws this layer. This will be called multiple times a frame if a player afterimage is being drawn. If this layer shouldn't draw with each afterimage, check More... | |
sealed override void | Register () |
If you make a new ModType, seal this override. More... | |
Protected Member Functions inherited from Terraria.ModLoader.ModType< TEntity, TModType > | |
abstract TEntity | CreateTemplateEntity () |
virtual void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
override void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
abstract void | Register () |
If you make a new ModType, seal this override. More... | |
virtual void | ValidateType () |
Check for the correct overrides of different hook methods and fields and properties More... | |
Protected Member Functions inherited from Terraria.ModLoader.ModType< TEntity > | |
abstract TEntity | CreateTemplateEntity () |
virtual void | InitTemplateInstance () |
Create dummy objects for instanced mod-types More... | |
override void | InitTemplateInstance () |
Create dummy objects for instanced mod-types | |
abstract void | Register () |
If you make a new ModType, seal this override. More... | |
virtual void | ValidateType () |
Check for the correct overrides of different hook methods and fields and properties More... | |
Properties | |
IReadOnlyList< PlayerDrawLayer > | ChildrenAfter [get] |
IReadOnlyList< PlayerDrawLayer > | ChildrenBefore [get] |
virtual bool | IsHeadLayer [get] |
Returns whether or not this layer should be rendered for the minimap icon. | |
virtual Transformation | Transform [get] |
bool | Visible = true [get] |
Properties inherited from Terraria.ModLoader.ModType< TEntity, TModType > | |
virtual bool | CloneNewInstances [get] |
Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor). | |
TEntity | Entity [get, set] |
string | FullName [get] |
The internal name of this, including the mod it is from. More... | |
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] | |
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.ModLoader.ModType< TEntity > | |
virtual bool | CloneNewInstances [get] |
Whether to create new instances of this mod type via Clone(TEntity) or via the default constructor Defaults to false (default constructor). | |
TEntity | Entity [get, set] |
string | FullName [get] |
The internal name of this, including the mod it is from. More... | |
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] | |
Mod | Mod [get, set] |
The mod this belongs to. More... | |
virtual string | Name [get] |
The internal name of this. More... | |
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.
|
protectedpure virtual |
Draws this layer. This will be called multiple times a frame if a player afterimage is being drawn. If this layer shouldn't draw with each afterimage, check
if(drawinfo.shadow == 0f)
to only draw for the original player image.
Implemented in Terraria.ModLoader.PlayerDrawLayerSlot.
|
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.
|
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.
Reimplemented in Terraria.ModLoader.PlayerDrawLayerSlot.
|
protectedvirtual |
If you make a new ModType, seal this override.
Implements Terraria.ModLoader.ModType< TEntity, TModType >.
|
virtual |
If you make a new ModType, seal this override, and call SetStaticDefaults in it.
Reimplemented from Terraria.ModLoader.ModType< TEntity, TModType >.