Inherits Terraria.ModLoader.ModType, and GlobalType.
|
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 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 | 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 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) |
|
|
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). More...
|
|
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...
|
|
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...
|
|
◆ AppliesToEntity()
Use this to control whether or not this global should be associated with the provided entity instance.
- Parameters
-
entity | The entity for which the global instantion is being checked. |
lateInstantiation | Whether 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 && ...
|
◆ InstancePerEntity
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).