tModLoader v2022.09
A mod to make and play Terraria mods
Terraria.ModLoader.GlobalType< TEntity, TGlobal > Class Template Reference

Inherits Terraria.ModLoader.ModType< TEntity, TModType >, Terraria.ModLoader.IIndexed, and GlobalType.

Public Member Functions

virtual bool AppliesToEntity (TEntity entity, bool lateInstantiation)
 Use this to control whether or not this global should be associated with the provided entity instance. More...
 
virtual TGlobal Clone (TEntity from, TEntity to)
 Create a copy of this instanced global. Called when an entity is cloned. More...
 
virtual TGlobal NewInstance (TEntity target)
 Only called if GlobalType.InstancePerEntity and AppliesToEntity(target , ...) are both true 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...
 
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...
 

Static Public Member Functions

static TResult GetGlobal< TEntity, TGlobal, TResult > (Instanced< TGlobal >[] globals, bool exactType)
 
static TResult GetGlobal< TEntity, TGlobal, TResult > (Instanced< TGlobal >[] globals, TResult baseInstance)
 
static T Instance< T > (Instanced< T >[] globals, ushort index)
 
static bool TryGetGlobal< TGlobal, TResult > (Instanced< TGlobal >[] globals, bool exactType, out TResult result)
 
static bool TryGetGlobal< TGlobal, TResult > (Instanced< TGlobal >[] globals, TResult baseInstance, out TResult result)
 

Protected Member Functions

override 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, 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

virtual bool CloneNewInstances [get]
 Whether to create new instances of this mod type via Clone or via the default constructor Defaults to false (default constructor).
 
ushort Index [get, set]
 
virtual bool InstancePerEntity [get]
 Whether to create a new instance of this Global for every entity that exists. Useful for storing information on an entity. Defaults to false. Return true if you need to store information (have non-static fields).
 
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]
 
- 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...
 
- Properties inherited from Terraria.ModLoader.IIndexed
ushort Index [get]
 

Member Function Documentation

◆ AppliesToEntity()

virtual bool Terraria.ModLoader.GlobalType< TEntity, TGlobal >.AppliesToEntity ( TEntity  entity,
bool  lateInstantiation 
)
virtual

Use this to control whether or not this global should be associated with the provided entity instance.

Parameters
entityThe entity for which the global instantion is being checked.
lateInstantiationWhether this check occurs before or after the ModX.SetDefaults call.
If you're relying on entity values that can be changed by that call, you should likely prefix your return value with the following:
lateInstantiation &amp;&amp; ...

◆ Clone()

virtual TGlobal Terraria.ModLoader.GlobalType< TEntity, TGlobal >.Clone ( TEntity  from,
TEntity  to 
)
virtual

Create a copy of this instanced global. Called when an entity is cloned.

Parameters
fromThe entity being cloned
toThe new clone of the entity
Returns
A clone of this global

◆ GetGlobal< TEntity, TGlobal, TResult >() [1/2]

static TResult Terraria.ModLoader.GlobalType< TEntity, TGlobal >.GetGlobal< TEntity, TGlobal, TResult > ( Instanced< TGlobal >[]  globals,
bool  exactType 
)
static
Type Constraints
TGlobal :GlobalType 
TResult :TGlobal 
TResult :TryGetGlobal 
TResult :globals 
TResult :exactType 
TResult :out 
TResult :TResult 
TResult :result 
TResult :result 
TResult :throw 
TResult :new 
TResult :KeyNotFoundException 
TResult :$ 
TResult :Instance 
TResult :of 

◆ GetGlobal< TEntity, TGlobal, TResult >() [2/2]

static TResult Terraria.ModLoader.GlobalType< TEntity, TGlobal >.GetGlobal< TEntity, TGlobal, TResult > ( Instanced< TGlobal >[]  globals,
TResult  baseInstance 
)
static
Type Constraints
TGlobal :GlobalType 
TResult :TGlobal 
TResult :TryGetGlobal 
TResult :globals 
TResult :baseInstance 
TResult :out 
TResult :TResult 
TResult :result 
TResult :result 
TResult :throw 
TResult :new 
TResult :KeyNotFoundException 
TResult :$ 
TResult :Instance 
TResult :of 

◆ Instance< T >()

static T Terraria.ModLoader.GlobalType< TEntity, TGlobal >.Instance< T > ( Instanced< T >[]  globals,
ushort  index 
)
static
Type Constraints
T :class 

◆ NewInstance()

virtual TGlobal Terraria.ModLoader.GlobalType< TEntity, TGlobal >.NewInstance ( TEntity  target)
virtual

Only called if GlobalType.InstancePerEntity and AppliesToEntity(target , ...) are both true

Parameters
targetThe entity instance the global is being instantiated for
Returns

Reimplemented from Terraria.ModLoader.ModType< TEntity, TModType >.

◆ TryGetGlobal< TGlobal, TResult >() [1/2]

static bool Terraria.ModLoader.GlobalType< TEntity, TGlobal >.TryGetGlobal< TGlobal, TResult > ( Instanced< TGlobal >[]  globals,
bool  exactType,
out TResult  result 
)
static
Type Constraints
TGlobal :GlobalType 
TResult :TGlobal 

◆ TryGetGlobal< TGlobal, TResult >() [2/2]

static bool Terraria.ModLoader.GlobalType< TEntity, TGlobal >.TryGetGlobal< TGlobal, TResult > ( Instanced< TGlobal >[]  globals,
TResult  baseInstance,
out TResult  result 
)
static
Type Constraints
TGlobal :GlobalType 
TResult :TGlobal 

◆ ValidateType()

override void Terraria.ModLoader.GlobalType< TEntity, TGlobal >.ValidateType ( )
protectedvirtual

Check for the correct overrides of different hook methods and fields and properties

Reimplemented from Terraria.ModLoader.ModType< TEntity, TModType >.

Property Documentation

◆ Index

ushort Terraria.ModLoader.GlobalType< TEntity, TGlobal >.Index
getset