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

Inherits Terraria.ModLoader.ModTileEntity.

Public Member Functions

override void Load (TagCompound tag)
 Allows you to load the custom data you have saved for this tile entity. More...
 
override TagCompound Save ()
 Allows you to save custom data for this tile entity. More...
 
override bool ValidTile (int i, int j)
 Whether or not this tile entity is allowed to survive at the given coordinates. You should check whether the tile is active, as well as the tile's type and frame. More...
 
- Public Member Functions inherited from Terraria.ModLoader.ModTileEntity
int Find (int i, int j)
 Returns the entity ID of this kind of tile entity at the given coordinates for you. More...
 
sealed override TileEntity GenerateInstance ()
 
virtual int Hook_AfterPlacement (int i, int j, int type, int style, int direction, int alternate)
 This method does not get called by tModLoader, and is only included for you convenience so you do not have to cast the result of Mod.GetTileEntity. 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...
 
void Kill (int i, int j)
 A helper method that removes this kind of tile entity from the given coordinates for you. More...
 
virtual void Load (Mod mod)
 Called when loading the type. More...
 
override void NetPlaceEntityAttempt (int i, int j)
 You should never use this. It is only included here for completion's sake. More...
 
override void NetReceive (BinaryReader reader)
 Receives the data sent in the NetSend hook. Called on MP Client when receiving tile data (!lightReceive) and when a MessageID.TileEntitySharing message is sent (lightReceive) More...
 
override void NetSend (BinaryWriter writer)
 Allows you to send custom data for this tile entity between client and server. This is called on the server while sending tile data (!lightSend) and when a MessageID.TileEntitySharing message is sent (lightSend) More...
 
virtual void OnKill ()
 This method only gets called in the Kill method. If you plan to use that, you can put code here to make things happen when it is called. More...
 
virtual void OnNetPlace ()
 Code that should be run when this tile entity is placed by means of server-syncing. Called on Server only. More...
 
int Place (int i, int j)
 A helper method that places this kind of tile entity in the given coordinates for you. More...
 
virtual void PostGlobalUpdate ()
 Code that should be run after all tile entities in the world update. More...
 
virtual void PreGlobalUpdate ()
 Code that should be run before all tile entities in the world update. More...
 
sealed override void ReadExtraData (BinaryReader reader, bool networkSend)
 Should never be called on ModTileEntity. Replaced by NetReceive and Load Would make the base method internal if not for patch size More...
 
sealed override void RegisterTileEntityID (int assignedID)
 
virtual void Unload ()
 Called during unloading when needed. More...
 
sealed override void WriteExtraData (BinaryWriter writer, bool networkSend)
 Should never be called on ModTileEntity. Replaced by NetSend and Save. Would make the base method internal if not for patch size More...
 
- Public Member Functions inherited from Terraria.DataStructures.TileEntity
virtual string GetItemGamepadInstructions (int slot=0)
 
virtual bool IsTileValidForEntity (int x, int y)
 
virtual void OnInventoryDraw (Player player, SpriteBatch spriteBatch)
 
virtual void OnPlayerUpdate (Player player)
 
virtual bool OverrideItemSlotHover (Item[] inv, int context=0, int slot=0)
 
virtual bool OverrideItemSlotLeftClick (Item[] inv, int context=0, int slot=0)
 
virtual bool TryGetItemGamepadOverrideInstructions (Item[] inv, int context, int slot, out string instruction)
 
virtual void Update ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Terraria.ModLoader.ModTileEntity
static ModTileEntity ConstructFromBase (ModTileEntity tileEntity)
 Returns a new ModTileEntity with the same class, mod, name, and type as the parameter. It is very rare that you should have to use this. More...
 
static ModTileEntity ConstructFromType (int type)
 Returns a new ModTileEntity with the same class, mod, name, and type as the ModTileEntity with the given type. It is very rare that you should have to use this. More...
 
static int CountInWorld ()
 Returns the number of modded tile entities that exist in the world currently being played. More...
 
- Static Public Member Functions inherited from Terraria.DataStructures.TileEntity
static int AssignNewID ()
 
static void BasicOpenCloseInteraction (Player player, int x, int y, int id)
 
static void Clear ()
 
static void InitializeAll ()
 
static bool IsOccupied (int id, out int interactingPlayer)
 
static void PlaceEntityNet (int x, int y, int type)
 
static TileEntity Read (BinaryReader reader, bool networkSend=false, bool lightSend=false)
 
static void SetInteractionAnchor (Player player, int x, int y, int id)
 
static void UpdateEnd ()
 
static void UpdateStart ()
 
static void Write (BinaryWriter writer, TileEntity ent, bool networkSend=false, bool lightSend=false)
 
- Public Attributes inherited from Terraria.DataStructures.TileEntity
int ID
 
Point16 Position
 
byte type
 
- Static Public Attributes inherited from Terraria.ModLoader.ModTileEntity
static readonly int NumVanilla
 
- Static Public Attributes inherited from Terraria.DataStructures.TileEntity
static Dictionary< int, TileEntityByID = new Dictionary<int, TileEntity>()
 
static Dictionary< Point16, TileEntityByPosition = new Dictionary<Point16, TileEntity>()
 
static object EntityCreationLock = new object()
 
static TileEntitiesManager manager
 
const int MaxEntitiesPerChunk = 1000
 
static int TileEntitiesNextID
 
- Properties inherited from Terraria.ModLoader.ModTileEntity
string FullName [get]
 
Mod Mod [get, set]
 The mod that added this ModTileEntity. More...
 
string Name [get]
 The internal name of this ModTileEntity. More...
 
int Type [get, set]
 The numeric type used to identify this kind of tile entity. 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...
 
- Events inherited from Terraria.DataStructures.TileEntity
static Action _UpdateEnd
 
static Action _UpdateStart
 

Member Function Documentation

◆ Load()

override void Terraria.ModLoader.Default.UnloadedTileEntity.Load ( TagCompound  tag)
virtual

Allows you to load the custom data you have saved for this tile entity.

Reimplemented from Terraria.DataStructures.TileEntity.

◆ Save()

override TagCompound Terraria.ModLoader.Default.UnloadedTileEntity.Save ( )
virtual

Allows you to save custom data for this tile entity.

Returns

Reimplemented from Terraria.DataStructures.TileEntity.

◆ ValidTile()

override bool Terraria.ModLoader.Default.UnloadedTileEntity.ValidTile ( int  i,
int  j 
)
virtual

Whether or not this tile entity is allowed to survive at the given coordinates. You should check whether the tile is active, as well as the tile's type and frame.

Implements Terraria.ModLoader.ModTileEntity.