tAPI · Docs · ModInterface

OnCombatTextSpawn

Called when a new CombatText instance is created (damage being dealt).

public override void OnCombatTextSpawn(CombatText combattext, Rectangle location) { }

Type	Name	Info
`CombatText`	`combattext`	New CombatText instance.
`Rectangle`	`location`	Bounding box of the CombatText.

OnItemTextSpawn

Called when a new ItemText instance is created (item being picked up / crafted / reforged).

public override void OnItemTextSpawn(ItemText itemtext, Item item) { }

Type	Name	Info
`ItemText`	`itemtext`	New ItemText instance.
`Item`	`item`	Item for which the ItemText was created.

ModifyInterfaceLayerList

Called after all the vanilla InterfaceLayers are setup, allowing to modify which layers are visible and allowing to add custom layers.

public override void ModifyInterfaceLayerList(List<InterfaceLayer> list) { }

Type	Name	Info
`List<InterfaceLayer>`	`list`	The list of all interface layers.

PreDrawInterface

Called before the interface gets drawn.

public override bool PreDrawInterface(SpriteBatch sb) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.

Returns: bool Whether the interface should be drawn.

PostDrawInterface

Called after the interface gets drawn.

public override void PostDrawInterface(SpriteBatch sb) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.

PreDrawInventory

Called before the inventory part of the interface gets drawn.

public override bool PreDrawInventory(SpriteBatch sb) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.

Returns: bool Whether the inventory part should be drawn.

PostDrawInventory

Called after the inventory part of the interface gets drawn.

public override void PostDrawInventory(SpriteBatch sb) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.

PreDrawCrafting

Called before the crafting part of the interface gets drawn.

public override bool PreDrawCrafting(SpriteBatch sb) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.

Returns: bool Whether the crafting part should be drawn.

PostDrawCrafting

Called after the crafting part of the interface gets drawn.

public override void PostDrawCrafting(SpriteBatch sb) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.

PreDrawMap

Called before the map gets drawn.

public override bool PreDrawMap(SpriteBatch sb) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.

Returns: bool Whether the map should be drawn.

PostDrawMap

Called after the map gets drawn.

public override void PostDrawMap(SpriteBatch sb) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.

PreDrawTooltipText

Called before a basic text tooltip gets drawn.

public override bool PreDrawTooltipText(SpriteBatch sb, string context, ref string text, ref int rare) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`string`	`context`	Tooltip context - type of the thing drawing the tooltip, in the format of `{modName}:{type}`.
`ref string`	`text`	The text to be drawn.
`ref int`	`rare`	Item rarity color to use when drawing.

Returns: bool Whether the basic text tooltip should be drawn.

PostDrawTooltipText

Called after a basic text tooltip gets drawn.

public override void PostDrawTooltipText(SpriteBatch sb, string context, string text, int rare) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`string`	`context`	Tooltip context - type of the thing drawing the tooltip, in the format of `{modName}:{type}`.
`string`	`text`	The text to be drawn.
`int`	`rare`	Item rarity color to use when drawing.

PreDrawTooltipItem

Called before an item tooltip gets drawn.

public override bool PreDrawTooltipItem(SpriteBatch sb, Item item, ref string text, ref int rare) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`Item`	`item`	The item to for which the tooltip is to be drawn.
`ref string`	`text`	The tooltip caption to be drawn.
`ref int`	`rare`	Item rarity color to use when drawing the caption.

Returns: bool Whether the item tooltip should be drawn.

PostDrawTooltipItem

Called after an item tooltip gets drawn.

public override void PostDrawTooltipItem(SpriteBatch sb, Item item, string text, int rare) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`Item`	`item`	The item to for which the tooltip is to be drawn.
`string`	`text`	The tooltip caption to be drawn.
`int`	`rare`	Item rarity color to use when drawing the caption.

PreDrawTooltipLocalHealth

Called before a local health tooltip (the one displaying when hovering over player life on screen) gets drawn.

public override bool PreDrawTooltipLocalHealth(SpriteBatch sb, ref string text) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`ref string`	`text`	The text to be drawn.

Returns: bool Whether the local health tooltip should be drawn.

PostDrawTooltipLocalHealth

Called after a local health tooltip (the one displaying when hovering over player life on screen) gets drawn.

public override void PostDrawTooltipLocalHealth(SpriteBatch sb, string text) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`string`	`text`	The text to be drawn.

PreDrawTooltipLocalMana

Called before a local mana tooltip (the one displaying when hovering over player mana on screen) gets drawn.

public override bool PreDrawTooltipLocalMana(SpriteBatch sb, ref string text) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`ref string`	`text`	The text to be drawn.

Returns: bool Whether the local mana tooltip should be drawn.

PostDrawTooltipLocalMana

Called after a local mana tooltip (the one displaying when hovering over player mana on screen) gets drawn.

public override void PostDrawTooltipLocalMana(SpriteBatch sb, string text) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`string`	`text`	The text to be drawn.

PreDrawTooltipItemInWorld

Called before an item-in-world tooltip gets drawn.

public override bool PreDrawTooltipItemInWorld(SpriteBatch sb, Item item, ref string text, ref int rare) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`Item`	`item`	Item for which the tooltip should be displayed.
`ref string`	`text`	The text to be drawn.
`ref int`	`rare`	Item rarity color to use when drawing.

Returns: bool Whether the item-in-world tooltip should be drawn.

PostDrawTooltipItemInWorld

Called after an item-in-world tooltip gets drawn.

public override void PostDrawTooltipItemInWorld(SpriteBatch sb, Item item, string text, int rare) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`Item`	`item`	Item for which the tooltip should be displayed.
`string`	`text`	The text to be drawn.
`int`	`rare`	Item rarity color to use when drawing.

PreDrawTooltipPlayer

Called before a player tooltip gets drawn.

public override bool PreDrawTooltipPlayer(SpriteBatch sb, Player player, ref string text, ref int difficulty) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`Player`	`player`	Player for which the tooltip should be displayed.
`ref string`	`text`	The text to be drawn.
`ref int`	`difficulty`	Player difficulty color to use when drawing.

Returns: bool Whether the player tooltip should be drawn.

PostDrawTooltipPlayer

Called after a player tooltip gets drawn.

public override void PostDrawTooltipPlayer(SpriteBatch sb, Player player, string text, int difficulty) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`Player`	`player`	Player for which the tooltip should be displayed.
`string`	`text`	The text to be drawn.
`int`	`difficulty`	Player difficulty color to use when drawing.

PreDrawTooltipNPC

Called before a NPC tooltip gets drawn.

public override bool PreDrawTooltipNPC(SpriteBatch sb, NPC npc, ref bool isHidingMimic, ref string text) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`NPC`	`npc`	NPC for which the tooltip should be displayed.
`ref bool`	`isHidingMimic`	Whether the NPC is currently hiding (mimics).
`ref string`	`text`	The text to be drawn.

Returns: bool Whether the NPC tooltip should be drawn.

PostDrawTooltipNPC

Called after a NPC tooltip gets drawn.

public override void PostDrawTooltipNPC(SpriteBatch sb, NPC npc, bool isHidingMimic, string text) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`NPC`	`npc`	NPC for which the tooltip should be displayed.
`bool`	`isHidingMimic`	Whether the NPC is currently hiding (mimics).
`string`	`text`	The text to be drawn.

PreDrawTooltipBuff

Called before a buff tooltip gets drawn.

public override bool PreDrawTooltipBuff(SpriteBatch sb, int buffIndex, int buffType, ref string text, ref bool imbue) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`int`	`buffIndex`	Index of the buff in arrays.
`int`	`buffType`	Type of the buff.
`ref string`	`text`	The text to be drawn.
`ref bool`	`imbue`	Whether the buff comes from a melee enchantment.

Returns: bool Whether the buff tooltip should be drawn.

PostDrawTooltipBuff

Called after a buff tooltip gets drawn.

public override void PostDrawTooltipBuff(SpriteBatch sb, int buffIndex, int buffType, string text, bool imbue) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`int`	`buffIndex`	Index of the buff in arrays.
`int`	`buffType`	Type of the buff.
`string`	`text`	The text to be drawn.
`bool`	`imbue`	Whether the buff comes from a melee enchantment.

PreDrawItemSlot

Called before an ItemSlot gets drawn.

public override bool PreDrawItemSlot(SpriteBatch sb, ItemSlot slot) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`ItemSlot`	`slot`	ItemSlot instance to be drawn.

Returns: bool Whether the ItemSlot should be drawn.

PostDrawItemSlot

Called after an ItemSlot gets drawn.

public override void PostDrawItemSlot(SpriteBatch sb, ItemSlot slot) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`ItemSlot`	`slot`	ItemSlot instance to be drawn.

PreDrawItemSlotBackground

Called before an ItemSlot's background layer gets drawn.

public override bool PreDrawItemSlotBackground(SpriteBatch sb, ItemSlot slot) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`ItemSlot`	`slot`	ItemSlot instance to be drawn.

Returns: bool Whether the ItemSlot's background layer should be drawn.

PostDrawItemSlotBackground

Called after an ItemSlot's background layer gets drawn.

public override void PostDrawItemSlotBackground(SpriteBatch sb, ItemSlot slot) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`ItemSlot`	`slot`	ItemSlot instance to be drawn.

PreDrawItemSlotItem

Called before an ItemSlot's item layer gets drawn.

public override bool PreDrawItemSlotItem(SpriteBatch sb, ItemSlot slot) { return true; }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`ItemSlot`	`slot`	ItemSlot instance to be drawn.

Returns: bool Whether the ItemSlot's item layer should be drawn.

PostDrawItemSlotItem

Called after an ItemSlot's item layer gets drawn.

public override void PostDrawItemSlotItem(SpriteBatch sb, ItemSlot slot) { }

Type	Name	Info
`SpriteBatch`	`sb`	SpriteBatch instance used to do all the drawing.
`ItemSlot`	`slot`	ItemSlot instance to be drawn.

PreItemSlotLeftClick

Called before the default ItemSlot left click code gets called.

public override bool PreItemSlotLeftClick(ItemSlot slot, ref bool release) { return true; }

Type	Name	Info
`ItemSlot`	`slot`	Clicked ItemSlot instance.
`ref bool`	`release`	Whether it's the first frame of the click.

Returns: bool Whether the default ItemSlot left click code should be called.

PostItemSlotLeftClick

Called after the default ItemSlot left click code gets called.

public override void PostItemSlotLeftClick(ItemSlot slot, bool release) { }

Type	Name	Info
`ItemSlot`	`slot`	Clicked ItemSlot instance.
`bool`	`release`	Whether it's the first frame of the click.

PreItemSlotRightClick

Called before the default ItemSlot right click code gets called.

public override bool PreItemSlotRightClick(ItemSlot slot, ref bool release) { return true; }

Type	Name	Info
`ItemSlot`	`slot`	Clicked ItemSlot instance.
`ref bool`	`release`	Whether it's the first frame of the click.

Returns: bool Whether the default ItemSlot right click code should be called.

PostItemSlotRightClick

Called after the default ItemSlot right click code gets called.

public override void PostItemSlotRightClick(ItemSlot slot, bool release) { }

Type	Name	Info
`ItemSlot`	`slot`	Clicked ItemSlot instance.
`bool`	`release`	Whether it's the first frame of the click.

ItemSlotAllowsItem

Called when an Item is supposed to be placed in an ItemSlot.

public override bool? ItemSlotAllowsItem(ItemSlot slot, Item item) { return null; }

Type	Name	Info
`ItemSlot`	`slot`	ItemSlot in question.
`Item`	`item`	Item in question.

Returns: bool? Whether the ItemSlot allows the Item to be placed in it. Return null if you don't want to change the action for this item.

KeyboardInputFocused

Called before any keyboard input (for player movement) is checked.

public override bool KeyboardInputFocused() { return false; }

Returns: bool Whether to block keyboard input (player movement).

OverrideChat

Called when a player presses the Enter key.

public override bool OverrideChat() { return false; }

Returns: bool Whether the Enter key should open the chat input window.