Terraria.ModLoader.ModTile Class Reference

This class represents a type of tile that can be added by a mod. Only one instance of this class will ever exist for each type of tile that is added. Any hooks that are called will be called by the instance corresponding to the tile type. This is to prevent the game from using a massive amount of memory storing tile instances.
The Basic Tile Guideteaches the basics of making a modded tile. More...

Inheritance diagram for Terraria.ModLoader.ModTile:

Collaboration diagram for Terraria.ModLoader.ModTile:

Public Member Functions
void	AddToArray (ref int[] array)
	A convenient method for adding this tile's Type to the given array. This can be used with the arrays in TileID.Sets.RoomNeeds.
void	AddMapEntry (Color color, LocalizedText name=null)
	Adds an entry to the minimap for this tile with the given color and display name. This should be called in SetDefaults. For a typical tile that has a map display name, use M:Terraria.ModLoader.ModBlockType.CreateMapEntryName as the name parameter for a default key using the pattern "Mods.{ModName}.Tiles.{ContentName}.MapEntry". If a tile will be using multiple map entries, it is suggested to use this.GetLocalization("CustomMapEntryName"). Modders can also re-use the display name localization of items, such as ModContent.GetInstance<ItemThatPlacesThisStyle>().DisplayName. Multiple map entries are suitable for tiles that need a different color or hover text for different tile styles. Vanilla code uses this mostly only for chest and dresser tiles. Map entries will be given a corresponding map option value, counting from 0, according to the order in which they are added. Map option values don't necessarily correspond to tile styles. M:Terraria.ModLoader.ModBlockType.GetMapOption(System.Int32,System.Int32) will be used to choose which map entry is used for a given coordinate. Vanilla map entries for most furniture tiles tend to be fairly generic, opting to use a single map entry to show "Table" for all styles of tables instead of the style-specific text such as "Wooden Table", "Honey Table", etc. To use these existing localizations, use the M:Terraria.Localization.Language.GetText(System.String) method with the appropriate key, such as "MapObject.Chair", "MapObject.Door", "ItemName.WorkBench", etc. Consult the source code or ExampleMod to find the existing localization keys for common furniture types.
void	AddMapEntry (Color color, LocalizedText name, Func< string, int, int, string > nameFunc)
	Overload specific: This overload has an additional nameFunc parameter. This function will be used to dynamically adjust the hover text. The parameters for the function are the default display name, x-coordinate, and y-coordinate. This function is most typically used for chests and dressers to show the current chest name, if assigned, instead of the default chest name. ExampleMod's ExampleChestis one example of this functionality.
void	RegisterItemDrop (int itemType, params int[] tileStyles)
	Manually registers an item to drop for the provided tile styles. Use this for tile styles that don't have an item that places them. For example, open door tiles don't have any item that places them, but they should drop an item when destroyed. A tile style with no registered drop and no fallback drop will not drop anything when destroyed. This method can also be used to register the fallback item drop. The fallback item will drop for any tile with a style that does not have a manual or automatic item drop. To register the fallback item, omit the tileStyles parameter. If a mod removes content, manually specifying a replacement/fallback item allows users to recover something from the tile. If more control over tile item drops is required, such as conditional drops, custom data on dropped items, or multiple item drops, use M:Terraria.ModLoader.ModTile.GetItemDrops(System.Int32,System.Int32).
override void	SetupContent ()
	If you make a new ModType, seal this override, and call M:Terraria.ModLoader.ModType.SetStaticDefaults in it.
virtual void	PostSetDefaults ()
	Allows you to override some default properties of this tile, such as Main.tileNoSunLight and Main.tileObsidianKill.
virtual bool	HasSmartInteract (int i, int j, SmartInteractScanSettings settings)
	Whether or not the smart interact function can select this tile. Useful for things like chests. Defaults to false.
virtual void	ModifySmartInteractCoords (ref int width, ref int height, ref int frameWidth, ref int frameHeight, ref int extraY)
	Allows you to modify the smart interact parameters for the tile. Parameters already preset by deriving from TileObjectData defined for the tile. Example usage: Beds/Dressers which have separate interactions based on where to click.
virtual void	ModifySittingTargetInfo (int i, int j, ref TileRestingInfo info)
	Modify the parameters for the entity sitting on this furniture tile with its type registered to F:Terraria.ID.TileID.Sets.CanBeSatOnForPlayers. This is also called on NPCs sitting on this tile! To access the entity (player or NPC), use info.restingEntity. This gets called when calling M:Terraria.GameContent.PlayerSittingHelper.SitDown(Terraria.Player,System.Int32,System.Int32), when the town NPC decides to sit, and each tick while the player is sitting on a suitable furniture. i and j derived from "(entity.Bottom + new Vector2(0f, -2f)).ToTileCoordinates()" or from the tile coordinates the player clicked on. Formula: anchorTilePosition.ToWorldCoordinates(8f, 16f) + finalOffset + new Vector2(0, targetDirection * directionOffset).
virtual void	ModifySleepingTargetInfo (int i, int j, ref TileRestingInfo info)
	Modify the visual player offset when sleeping on this tile with its type registered to F:Terraria.ID.TileID.Sets.CanBeSleptIn. This gets called when calling M:Terraria.GameContent.PlayerSleepingHelper.SetIsSleepingAndAdjustPlayerRotation(Terraria.Player,System.Boolean), and each tick while the player is resting in the bed, i and j derived from "(player.Bottom + new Vector2(0f, -2f)).ToTileCoordinates()" or from the tile coordinates the player clicked on. Formula: new Point(anchorTilePosition.X, anchorTilePosition.Y + 1).ToWorldCoordinates(8f, 16f) + finalOffset + new Vector2(0, targetDirection * directionOffset).
virtual void	DropCritterChance (int i, int j, ref int wormChance, ref int grassHopperChance, ref int jungleGrubChance)
	Allows you to modify the chance the tile at the given coordinates has of spawning a certain critter when the tile is killed.
virtual bool	CanDrop (int i, int j)
	Allows prevention of item drops from the tile dropping at the given coordinates. Return false to stop the game from dropping the tile's item(s). Returns true by default. See M:Terraria.ModLoader.ModTile.GetItemDrops(System.Int32,System.Int32) to customize the item drop.
virtual IEnumerable< Item >	GetItemDrops (int i, int j)
	Allows customization of the items the tile at the given coordinates drops. The default item drop is determined by finding an item with F:Terraria.Item.createTile and F:Terraria.Item.placeStyle matching the type and style of this tile. M:Terraria.ModLoader.ModTile.RegisterItemDrop(System.Int32,System.Int32[]) can be used to manually register item drops for tile styles with no corresponding item. It can also be used to register a fallback item, which will be dropped if no suitable item is found. The default behavior should cover 99% of use cases, meaning that overriding this method should only be necessary in extremely unique tiles, such as tiles dropping multiple items, tiles dropping items with custom data, or tiles with custom tile style code. When overriding, use yield return new Item(ItemTypeHere); for each spawned item. Note that a random prefix will be applied to these items, if applicable, so if specific prefixes or no prefix is needed for an item drop, it will have to be spawned in manually using M:Terraria.ModLoader.ModTile.KillMultiTile(System.Int32,System.Int32,System.Int32,System.Int32) or M:Terraria.ModLoader.ModTile.KillTile(System.Int32,System.Int32,System.Boolean@,System.Boolean@,System.Boolean@). The style based drop logic is based on T:Terraria.ObjectData.TileObjectData. If a tile has custom 'styles' but still wants to make use of M:Terraria.ModLoader.ModTile.RegisterItemDrop(System.Int32,System.Int32[]), TileLoader.GetItemDropFromTypeAndStyle(Type, style) can be used to retrieve the associated item drop. Use M:Terraria.ModLoader.ModTile.CanDrop(System.Int32,System.Int32) to conditionally prevent any item drops. Use M:Terraria.ModLoader.ModTile.KillMultiTile(System.Int32,System.Int32,System.Int32,System.Int32) or M:Terraria.ModLoader.ModTile.KillTile(System.Int32,System.Int32,System.Boolean@,System.Boolean@,System.Boolean@) for other logic such as cleaning up TileEntities or killing chests or signs.
virtual bool	CanKillTile (int i, int j, ref bool blockDamaged)
	Allows you to determine whether or not the tile at the given coordinates can be hit by anything. Returns true by default. blockDamaged currently has no use.
virtual void	KillTile (int i, int j, ref bool fail, ref bool effectOnly, ref bool noItem)
	Allows you to determine what happens when the tile at the given coordinates is killed or hit with a pickaxe. Fail determines whether the tile is mined, effectOnly makes it so that only dust is created, and noItem stops items from dropping. Use this to clean up extra data such as Chests, Signs, or TileEntities. For tiles larger than 1x1, use M:Terraria.ModLoader.ModTile.KillMultiTile(System.Int32,System.Int32,System.Int32,System.Int32).
virtual void	KillMultiTile (int i, int j, int frameX, int frameY)
	This hook is called exactly once whenever a block encompassing multiple tiles is destroyed. Use this to clean up extra data such as Chests, Signs, or TileEntities. For tiles that are 1x1, use M:Terraria.ModLoader.ModTile.KillTile(System.Int32,System.Int32,System.Boolean@,System.Boolean@,System.Boolean@).
virtual void	NearbyEffects (int i, int j, bool closer)
	Allows you to make things happen when this tile is within a certain range of the player (around the same range water fountains and music boxes work). The closer parameter is whether or not the tile is within the range at which aesthetics like monoliths and music boxes and clocks work. It is false for campfires and heart lanterns.
virtual float	GetTorchLuck (Player player)
	Only called for torches, when there is one nearby. Use this to contribute to vanilla torch luck calculations. Typical return values are 1f for a torch in its biome, 0.5f for a weak positive torch, -1f for a torch in an opposing biome, and -0.5f for a weak negative torch.
virtual bool	IsTileDangerous (int i, int j, Player player)
	Allows you to determine whether this tile glows red when the given player has the Dangersense buff. This is only called on the local client.
virtual bool	IsTileBiomeSightable (int i, int j, ref Color sightColor)
	Allows you to determine whether this tile glows sightColor while the local player has the Biome Sight buff. Return true and assign to sightColor to allow this tile to glow. This is only called on the local client.
virtual bool	IsTileSpelunkable (int i, int j)
	Allows you to customize whether this tile can glow yellow while having the Spelunker buff, and is also detected by various pets. This is only called if Main.tileSpelunker[type] is false.
virtual void	SetSpriteEffects (int i, int j, ref SpriteEffects spriteEffects)
	Allows you to determine whether or not the tile will draw itself flipped in the world.
virtual void	SetDrawPositions (int i, int j, ref int width, ref int offsetY, ref int height, ref short tileFrameX, ref short tileFrameY)
	Allows you to customize the position in which this tile is drawn. Width refers to the width of one frame of the tile, offsetY refers to how many pixels below its actual position the tile should be drawn, height refers to the height of one frame of the tile.
virtual void	AnimateTile (ref int frame, ref int frameCounter)
	Allows you to animate your tile. Use frameCounter to keep track of how long the current frame has been active, and use frame to change the current frame. This is called once an update. Use AnimateIndividualTile to animate specific tile instances directly.
virtual void	AnimateIndividualTile (int type, int i, int j, ref int frameXOffset, ref int frameYOffset)
	Animates an individual tile. i and j are the coordinates of the Tile in question. frameXOffset and frameYOffset should be used to specify an offset from the tiles frameX and frameY. "frameYOffset = modTile.animationFrameHeight * Main.tileFrame[type];" will already be set before this hook is called, taking into account the TileID-wide animation set via AnimateTile. Use this hook for off-sync animations (lightning bug in a bottle), temporary animations (trap chests), or TileEntities to achieve unique animation behaviors without having to manually draw the tile via PreDraw.
virtual void	DrawEffects (int i, int j, SpriteBatch spriteBatch, ref TileDrawInfo drawData)
	Allows you to make stuff happen whenever the tile at the given coordinates is drawn. For example, creating dust or changing the color the tile is drawn in. SpecialDraw will only be called if coordinates are added using Main.instance.TilesRenderer.AddSpecialLegacyPoint here.
virtual void	SpecialDraw (int i, int j, SpriteBatch spriteBatch)
	Special Draw. Only called if coordinates are added using Main.instance.TilesRenderer.AddSpecialLegacyPoint during DrawEffects. Useful for drawing things that would otherwise be impossible to draw due to draw order, such as items in item frames.
virtual bool	TileFrame (int i, int j, ref bool resetFrame, ref bool noBreak)
	Called whenever this tile updates due to being placed or being next to a tile that is changed. Return false to stop the game from carrying out its default TileFrame operations. Returns true by default.
virtual bool	RightClick (int i, int j)
	Allows you to make something happen when this tile is right-clicked by the player. Return true to indicate that a tile interaction has occurred, preventing other right click actions like minion targeting from happening. Returns false by default.
virtual void	MouseOver (int i, int j)
	Allows you to make something happen when the mouse hovers over this tile. Useful for showing item icons or text on the mouse.
virtual void	MouseOverFar (int i, int j)
	Allows you to make something happen when the mouse hovers over this tile, even when the player is far away. Useful for showing what's written on signs, etc.
virtual bool	AutoSelect (int i, int j, Item item)
	Allows you to determine whether the given item can become selected when the cursor is hovering over this tile and the auto selection keybind is pressed.
virtual void	HitWire (int i, int j)
	Allows you to make something happen when a wire current passes through this tile. Both M:Terraria.Wiring.SkipWire(System.Int32,System.Int32) and M:Terraria.NetMessage.SendTileSquare(System.Int32,System.Int32,System.Int32,System.Int32,Terraria.ID.TileChangeType) are usually required in the logic used in this method to correctly work. Only called on the server and single player. All wiring happens on the world, not multiplayer clients.
virtual bool	Slope (int i, int j)
	Allows you to control how hammers slope this tile. Return true to allow it to slope normally. Returns true by default. Called on the local Client and Single Player.
virtual void	FloorVisuals (Player player)
	Allows you to make something happen when a player stands on this type of tile. For example, you can make the player slide as if on ice.
virtual bool	HasWalkDust ()
	Whether or not this tile creates dust when the player walks on it. Returns false by default.
virtual void	WalkDust (ref int dustType, ref bool makeDust, ref Color color)
	Allows you to modify the dust created when the player walks on this tile. The makeDust parameter is whether or not to make dust; you can randomly set this to false to reduce the amount of dust produced.
virtual void	ChangeWaterfallStyle (ref int style)
	Allows you to change the style of waterfall that passes through or over this type of tile.
virtual void	PostSetupTileMerge ()
	Can be used to adjust tile merge related things that are not possible to do in M:Terraria.ModLoader.ModBlockType.SetStaticDefaults due to timing.
virtual bool	IsLockedChest (int i, int j)
	Return true if this Tile corresponds to a chest that is locked. Prevents Quick Stacking items into the chest.
virtual bool	UnlockChest (int i, int j, ref short frameXAdjustment, ref int dustType, ref bool manual)
	Allows customization of how a chest unlock is accomplished. By default, frameXAdjustment will be -36, shifting the frameX over to the left by 1 chest style. If your chests are in a different order, adjust frameXAdjustment accordingly. This hook is called on the client, and if successful will be called on the server and other clients as the action is synced. Make sure that the logic is consistent and not dependent on local player data.
virtual bool	LockChest (int i, int j, ref short frameXAdjustment, ref bool manual)
	Allows customization of how locking a chest is accomplished. By default, frameXAdjustment will be 36, shifting the frameX over to the right by 1 chest style. If your chests are in a different order, adjust frameXAdjustment accordingly. This hook is called on the client, and if successful will be called on the server and other clients as the action is synced. Make sure that the logic is consistent and not dependent on local player data.
virtual LocalizedText	DefaultContainerName (int frameX, int frameY)
	Returns the default name for a chest or dresser with the provided FrameX and FrameY values. A typical implementation of a tile with only a single name might return CreateMapEntryName() A container with multiple styles might return this.GetLocalization("MapEntry" + option) where option is determined using similar logic to M:Terraria.ModLoader.ModBlockType.GetMapOption(System.Int32,System.Int32) to match the M:Terraria.ModLoader.ModTile.AddMapEntry(Microsoft.Xna.Framework.Color,Terraria.Localization.LocalizedText) entries. Another option is using return Lang._mapLegendCache[MapHelper.TileToLookup(Type, option)];, this will reuse the localizations used for the map entries.
virtual bool	CanReplace (int i, int j, int tileTypeBeingPlaced)
	Allows you to stop this tile at the given coordinates from being replaced via the block swap feature. The tileTypeBeingPlaced parameter is the tile type that will replace the current tile. This method is called on the local client. This method is only called if the local player has sufficient pickaxe power to mine the existing tile. Return false to block the tile from being replaced. Returns true by default. Use this for dynamic logic. F:Terraria.ID.TileID.Sets.DoesntGetReplacedWithTileReplacement, F:Terraria.ID.TileID.Sets.DoesntPlaceWithTileReplacement, and F:Terraria.ID.TileID.Sets.PreventsTileReplaceIfOnTopOfIt cover the most common use cases and should be used instead if possible.
LocalizedText	CreateMapEntryName ()
	Legacy helper method for creating a localization sub-key MapEntry.
override void	SetStaticDefaults ()
	Allows you to modify the properties after initial loading has completed. This is where you would set the properties of this tile/wall. Many properties are stored as arrays throughout Terraria's code. For example: Main.tileSolid[Type] = true; Main.tileSolidTop[Type] = true; Main.tileBrick[Type] = true; Main.tileBlockLight[Type] = true;
virtual ushort	GetMapOption (int i, int j)
	Allows you to choose which minimap entry the tile/wall at the given coordinates will use. 0 is the first entry added by AddMapEntry, 1 is the second entry, etc. Returns 0 by default.
virtual bool	KillSound (int i, int j, bool fail)
	Allows you to customize which sound you want to play when the tile/wall at the given coordinates is hit. Return false to stop the game from playing its default sound for the tile/wall. Returns true by default.
virtual void	NumDust (int i, int j, bool fail, ref int num)
	Allows you to change how many dust particles are created when the tile/wall at the given coordinates is hit.
virtual bool	CreateDust (int i, int j, ref int type)
	Allows you to modify the default type of dust created when the tile/wall at the given coordinates is hit. Return false to stop the default dust (the type parameter) from being created. Returns true by default.
virtual bool	CanPlace (int i, int j)
	Allows you to stop this tile/wall from being placed at the given coordinates. Return false to stop the tile/wall from being placed. Returns true by default.
virtual bool	CanExplode (int i, int j)
	Whether or not the tile/wall at the given coordinates can be killed by an explosion (ie. bombs). Returns true by default; return false to stop an explosion from destroying it.
virtual bool	PreDraw (int i, int j, SpriteBatch spriteBatch)
	Allows you to draw things behind the tile/wall at the given coordinates. Return false to stop the game from drawing the tile normally. Returns true by default.
virtual void	PostDraw (int i, int j, SpriteBatch spriteBatch)
	Allows you to draw things in front of the tile/wall at the given coordinates. This can also be used to do things such as creating dust.
virtual void	RandomUpdate (int i, int j)
	Called whenever the world randomly decides to update this tile/wall in a given tick. Useful for things such as growing or spreading.
virtual void	PlaceInWorld (int i, int j, Item item)
	Allows you to do something when this tile/wall is placed. Called on the local Client and Single Player.
virtual void	ModifyLight (int i, int j, ref float r, ref float g, ref float b)
	Allows you to determine how much light this tile/wall emits. If it is a tile, make sure you set Main.tileLighted[Type] to true in SetDefaults for this to work. If it is a wall, it can also let you light up the block in front of this wall. See M:Terraria.Graphics.Light.TileLightScanner.ApplyTileLight(Terraria.Tile,System.Int32,System.Int32,Terraria.Utilities.FastRandom@,Microsoft.Xna.Framework.Vector3@) for vanilla tile light values to use as a reference.
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.
virtual bool	IsLoadingEnabled (Mod mod)
	Allows you to stop M:Terraria.ModLoader.Mod.AddContent(Terraria.ModLoader.ILoadable) from actually adding this content. Useful for items that can be disabled by a config.
virtual void	Unload ()
	Allows you to safely unload things you added in M:Terraria.ModLoader.ModType.Load.
string	PrettyPrintName ()
virtual TModType	Clone (TEntity newEntity)
	Create a copy of this instanced global. Called when an entity is cloned.
virtual TModType	NewInstance (TEntity entity)
	Create a new instance of this ModType for a specific entity.

Protected Member Functions
override void	Register ()
virtual void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.
override void	InitTemplateInstance ()
	Create dummy objects for instanced mod-types.
virtual void	ValidateType ()
	Check for the correct overrides of different hook methods and fields and properties.
TEntity	CreateTemplateEntity ()

Properties
int	AnimationFrameHeight [get, set]
	The height of a group of animation frames for this tile. Defaults to 0, which disables animations.
float	MineResist = 1f [get, set]
	A multiplier describing how much this block resists harvesting. Higher values will make it take longer to harvest. Defaults to 1f.
int	MinPick [get, set]
	The minimum pickaxe power required for pickaxes to mine this block. Defaults to 0.
int[]	AdjTiles = new int[0] [get, set]
	An array of the IDs of tiles that this tile can be considered as when looking for crafting stations.
override string	LocalizationCategory [get]
	The category used by this modded content for use in localization keys. Localization keys follow the pattern of "Mods.{ModName}.{Category}.{ContentName}.{DataName}". The Localization wiki pageexplains how custom T:Terraria.ModLoader.ModType classes can utilize this.
virtual string	HighlightTexture [get]
	The highlight texture used when this tile is selected by smart interact. Defaults to adding "_Highlight" onto the main texture.
bool	IsDoor [get]
ushort	Type [get, set]
	The internal ID of this type of tile/wall.
SoundStyle?	HitSound = SoundID.Dig [get, set]
	The default style of sound made when this tile/wall is hit. Defaults to SoundID.Dig, which is the sound used for tiles such as dirt and sand.
int	DustType [get, set]
	The default type of dust made when this tile/wall is hit. Defaults to 0.
ushort	VanillaFallbackOnModDeletion [get, set]
	The vanilla ID of what should replace the instance when a user unloads and subsequently deletes data from your mod in their save file. Defaults to 0.
virtual string	Texture [get]
	The file name of this type's texture file in the mod loader's file space.
Mod	Mod [get, set]
	The mod this belongs to.
virtual string	Name [get]
	The internal name of this.
string	FullName [get]
	The internal name of this, including the mod it is from.
TEntity	Entity [get, set]
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].
virtual bool	CloneNewInstances [get]
	Whether to create new instances of this mod type via M:Terraria.ModLoader.ModType`2.Clone(`0) or via the default constructor Defaults to false (default constructor).

Private Member Functions
void ILoadable.	Load (Mod mod)
	Called when loading the type.

Private Attributes
bool?	_isCloneable

Detailed Description

This class represents a type of tile that can be added by a mod. Only one instance of this class will ever exist for each type of tile that is added. Any hooks that are called will be called by the instance corresponding to the tile type. This is to prevent the game from using a massive amount of memory storing tile instances.
The Basic Tile Guide

teaches the basics of making a modded tile.

Definition at line 18 of file ModTile.cs.

---

The documentation for this class was generated from the following file:

• source/Terraria.ModLoader/ModTile.cs