Repository navigation
API Reference
Every public class a mod can use in Bunny Loader, member by member, side by side with tModLoader. Use the guides to learn how something works and this reference to look up what exists.
Create a class that derives from one of these and Bunny Loader finds it by itself. Click a name to see all its hooks.
| Class | What you use it for |
|---|---|
| Mod | The mod's main class. Every mod needs one. It holds Load, Call and HandlePacket. |
| ModSystem | Code for the whole mod: world data, recipes, interface layers, world generation. |
| ModPlayer | Data and hooks attached to each player. |
| ModConfig | Options the player can change in the game. |
| ModCommand | A chat command. |
| Class | What you use it for |
|---|---|
| ModItem | An item: weapon, tool, armor, accessory, material, potion... |
| ModPrefix | A prefix, such as Legendary. |
| ModRarity | A rarity, with its own color. |
| Class | What you use it for |
|---|---|
| ModNPC | An enemy, a boss or a town NPC. |
| ModInvasion | A wave-based event. Only in Bunny Loader. |
| ModBossBar | The health bar of a boss. |
| ModBossBarStyle | Replaces the whole boss bar display. |
| ModEmoteBubble | An emote. |
| Class | What you use it for |
|---|---|
| ModProjectile | A projectile: arrow, magic bolt, minion, whip, hook... |
| ModBuff | A buff or debuff. |
| Class | What you use it for |
|---|---|
| ModMount | A mount or minecart. |
| ModHair | A hairstyle. |
| ModResourceOverlay | Draws over the hearts and the mana stars. |
| Class | What you use it for |
|---|---|
| ModTile | A block or piece of furniture. |
| ModWall | A wall. |
| ModBannerTile | An enemy banner tile. |
| ModPylon | A pylon tile. |
| ModTileEntity | Data and updates attached to a placed tile. |
| ModTree | A kind of tree. |
| ModCactus | A kind of cactus. |
| ModBiome | A biome. |
| ModBiomeConversion | A conversion, such as the one the Clentaminator does. |
| Class | What you use it for |
|---|---|
| ModSceneEffect | Music and scenery that apply under a condition. |
| ModSurfaceBackgroundStyle | A surface background. |
| ModUndergroundBackgroundStyle | An underground background. |
| ModWaterStyle | A water style. |
| ModWaterfallStyle | A waterfall style. |
| ModCloud | A cloud. |
| ModDust | A dust particle. |
| ModGore | A gore piece. |
| Class | What you use it for |
|---|---|
| ModMenu | A title menu theme. |
| ModMapLayer | Draws icons over the map. |
| ModAchievement | An achievement. |
| ModKeybind | An input binding, a touch button on the phone. Not derived: created with KeybindLoader.RegisterKeybind. |
| ModTouchButton | A button on the screen. Only in Bunny Loader. Not derived: created with TouchButtonLoader.RegisterButton. |
| ModTouchJoystick | A button the player drags to aim. Only in Bunny Loader. Not derived: created with TouchButtonLoader.RegisterJoystick. |
| Class | What you use it for |
|---|---|
| GlobalItem | Every item, from the game or from any mod. |
| GlobalNPC | Every NPC. |
| GlobalProjectile | Every projectile. |
| GlobalBuff | Every buff. |
| GlobalTile | Every tile. |
| GlobalWall | Every wall. |
| GlobalPylon | Every pylon. |
| GlobalBossBar | Every boss bar. |
| GlobalEmoteBubble | Every emote. |
| GlobalBackgroundStyle | Every background. |
| Class | What you use it for |
|---|---|
| DamageClass | A damage class. |
| ExtraJump | An extra jump, like the Cloud in a Bottle. |
| InfoDisplay | A line of information accessories. |
| BuilderToggle | A builder accessory switch. |
| PlayerDrawLayer | A layer of the player's drawing. |
| Column | Meaning |
|---|---|
| Member | The signature, with short type names |
| Kind |
hook is a virtual you override. Otherwise method, property, field, event, const, constructor, indexer, with static when it applies |
| tModLoader |
same: same name and parameters, in tModLoader or in the PC game it runs on. differs: same name, other signature, which the row shows. only here: exists only in Bunny Loader. not here: exists in tModLoader, a mod that uses it does not compile here. XNA and ReLogic: from a library tModLoader also uses, not compared |
| What it does | What the member is for. Phone: marks a behavior different from the PC |
The game's own members, such as Item.damage or Main.dayTime, come from the
mobile game and are not listed: only what Bunny Loader adds to those classes is.
The On_ classes are generated for each game method, as
Hooks explains.
These pages are generated from the code by tools/docs/ApiReference. Descriptions
of members that tModLoader also has come from its documentation (MIT license); the
rest are in tools/docs/ApiReference/notes.txt.
The tModLoader column looks at signatures only. A member can be same and still
act differently on the phone, and an only here member can be a wrapper around
something the PC game has under another shape, such as GameList for a List<T>.
601 classes, 5351 members: 4311 the same as tModLoader or the PC game, 146 with a different signature, 566 only here, 328 not here. tModLoader's loaders have 297 more methods that only run hooks: each page counts them under its loader.
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| AmmoID | static class | yes | Ammo types: the value of Item.ammo and Item.useAmmo. |
| AmmoID.Sets | struct | yes | Tables indexed by ammo. |
| AmmoID.Sets.LauncherAmmoMatches | class | no | Which rocket each launcher fires for a given ammo. |
| ArmorIDs | struct | yes | Equipment texture slots: the numbers in Item.headSlot, bodySlot and legSlot. |
| ArmorIDs.Body | struct | yes | Body slots. |
| ArmorIDs.Body.Sets | struct | yes | Tables indexed by body slot. |
| ArmorIDs.Head | struct | yes | Head slots. |
| ArmorIDs.Head.Sets | struct | yes | Tables indexed by head slot. |
| ArmorIDs.Head.Sets.DrawHeadSet | class | no | Whether the player's head shows under a given helmet. |
| ArmorIDs.Legs | struct | yes | Leg slots. |
| ArmorIDs.Legs.Sets | struct | yes | Tables indexed by leg slot. |
| Condition | record | yes | A named check with text, used by recipes and shops. |
| Conditions | static class | yes | The game's drop conditions, each as a nested class. |
| Conditions.BeatAnyMechBoss | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.CorruptKeyCondition | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.CrimsonKeyCondition | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.DesertKeyCondition | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.DontStarveIsNotUp | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.DontStarveIsUp | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.DownedAllMechBosses | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.DownedPlantera | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.DropExtraGel | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.Easymode | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.EmpressOfLightIsGenuinelyEnraged | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.EyeOfCthulhuDefeatedAndNoAltarsInWorld | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.FirstTimeKillingPlantera | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.FromCertainWaveAndAbove | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.FrostMoonDropGateForTrophies | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.FrostMoonDropGatingChance | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.FrozenKeyCondition | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.HallowKeyCondition | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.HalloweenGoodieBagDrop | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.HalloweenWeapons | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsBloodMoonAndNotFromStatue | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsChristmas | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsCorruption | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsCorruptionAndNotExpert | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsCrimson | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsCrimsonAndNotExpert | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsExpert | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsHardmode | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsMasterMode | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsPumpkinMoon | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.IsUsingSpecificAIValues | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.JungleKeyCondition | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.LegacyHack_IsABoss | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.LegacyHack_IsBossAndExpert | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.LegacyHack_IsBossAndNotExpert | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.LivingFlames | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.MechanicalBossesDummyCondition | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.MechdusaKill | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.MissingTwin | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NamedNPC | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NeverTrue | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NotDropExtraGel | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NotExpert | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NotFromStatue | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NotMasterMode | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NotRemixSeed | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NotRemixSeedEasymode | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.NotRemixSeedHardmode | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.PirateMap | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.PlayerNeedsHealing | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.PumpkinMoonDropGateForTrophies | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.PumpkinMoonDropGatingChance | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.RedHatSkeletron | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.RemixSeed | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.RemixSeedEasymode | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.RemixSeedHardmode | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.SkyblockIsNotUp | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.SkyblockIsUp | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.SkyblockIsUpNoSickle | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.SoulOfLight | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.SoulOfNight | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.TenthAnniversaryIsNotUp | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.TenthAnniversaryIsUp | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.WindyEnoughForKiteDrops | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.XmasPresentDrop | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.YoyoCascade | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.YoyosAmarok | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.YoyosHelFire | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.YoyosKraken | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| Conditions.YoyosYelets | class | yes | A condition from the game for ItemDropRule.ByCondition. |
| DamageClass | abstract class | yes |
DamageClass is used to determine the application of item effects, damage/stat scaling, and class bonuses. |
| DamageClassData | class | yes | The stats a player keeps per damage class: damage, crit, knockback, attack speed, armor penetration. |
| DamageClassLoader | static class | yes | Registers damage classes and reads their stats. |
| DrawableTooltipLine | class | yes | This class serves as a way to store information about a line that will be drawn of tooltip for an item. |
| EquipLoader | static class | yes | This serves as a central place to store equipment slots and their corresponding textures. |
| GlobalItem | abstract class | yes | This class allows you to modify and use hooks for all items, both vanilla and modded. |
| Item | struct | yes | What Bunny Loader adds to the game's item. |
| Item.NewItemModifier | struct | no | Options for how a new item is created in the world, as the phone's Item.NewItem expects them. |
| ItemCreationContext | abstract class | yes | Why an item was created. |
| ItemDefinition | class | yes | ItemDefinition represents an Item identity. |
| ItemDropAttemptResult | struct | yes | The outcome of one attempt to run a drop rule. |
| ItemDropAttemptResultState | enum | yes | How a drop attempt ended. |
| ItemDropDatabase | struct | yes | The game's table of rules for each NPC and bag. |
| ItemDropResolver | struct | yes | Runs the rules when something dies or a bag opens. |
| ItemDropRule | static class | yes | Shortcuts that build the common rules, such as ItemDropRule.Common(type, 3). |
| ItemDropRuleResolveAction | delegate | yes | The method a rule chain uses to run the next rule. |
| ItemDropWithConditionRule | class | yes | A CommonDrop that also needs a condition. |
| ItemHoldStyleID | struct | yes | Values of Item.holdStyle. |
| ItemID | struct | yes | Item types. |
| ItemID.Sets | struct | yes | Tables indexed by item type. |
| ItemID.Sets.SandgunAmmoInfo | class | yes | Used in SandgunAmmoProjectileData. |
| ItemIO | static class | yes | Writes and reads items: Save and Load for a TagCompound, Send and Receive for packets. |
| ItemLoader | static class | yes | This serves as the central class from which item-related functions are carried out. |
| ItemLoot | struct | yes | Provides access to ItemDropDatabase's methods specific to this item type. |
| ItemRarityID | static class | yes | Enumerates the values used with Item.rare |
| ItemSlot | struct | yes | |
| ItemSlot.Context | struct | yes | |
| ItemUseStyleID | struct | yes | Values of Item.useStyle. |
| ModItem | abstract class | yes | This class serves as a place for you to place all your properties and hooks for each item. |
| ModPrefix | abstract class | yes | Represents a modded prefix (or modifier). |
| ModRarity | abstract class | yes | A rarity of your own: its color and where it sits in the order. |
| PrefixID | struct | yes | The game's prefixes. |
| PrefixLoader | static class | yes | Finds mod prefixes and runs their hooks. |
| RarityLoader | static class | yes | Finds mod rarities. |
| Recipe | struct | yes | A Recipe is a collection of ingredients, tiles, and a resulting Item. |
| Recipe.IngredientQuantityRules | static class | yes | Reduces how many ingredients a recipe consumes, for AddConsumeIngredientCallback. |
| RecipeException | class | yes | Thrown when a recipe is built wrongly, such as an ingredient added twice. |
| RecipeGroup | struct | yes | An ingredient that accepts any item in the group, such as any wood. |
| RecipeItemCreationContext | class | yes | The items used and the recipe, passed to OnCreated when an item is crafted. |
| RecipeLoader | static class | yes | This is where all Recipe hooks are gathered and called. |
| StatModifier | struct | yes | A stat change made of an additive part, a multiplier and flat amounts, as in player.GetDamage(DamageClass.Melee) += 0.1f. |
| TooltipLine | class | yes | This class serves as a way to store information about a line of tooltip for an item. |
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| AbstractNPCShop | abstract class | yes | A shop of any shape. |
| AbstractNPCShop.Entry | class | yes | One line of a shop: the item and its conditions. |
| AutoloadBossHead | class | yes | This attribute annotates a ModNPC class to indicate that the game should autoload the boss head texture found at BossHeadTexture. |
| AutoloadHead | class | yes | This attribute annotates a ModNPC class to indicate that the game should autoload the head texture found at HeadTexture. |
| BestiaryEntry | struct | yes | An NPC's page in the bestiary. |
| BestiaryInfoList | struct | no | The list behind BestiaryEntry.Info, with Add and AddRange. |
| BossBarDrawParams | struct | yes | Holds data required for boss bar drawing. |
| BossBarLoader | static class | yes | Runs the hooks of mod boss bars. |
| EmoteBubble | struct | yes | The emote bubble above a player or NPC. |
| EmoteBubbleLoader | static class | yes | Registers emotes and runs their hooks. |
| EmoteID | static class | yes | Emote types, and the categories of the emote menu in EmoteID.Category. |
| EmoteID.Category | static class | yes | This class is added by TML for easily adding mod emotes to a specific category. |
| GlobalBossBar | abstract class | yes | A class that is used to modify existing boss health bars. |
| GlobalEmoteBubble | abstract class | yes | Changes emote bubbles of the game and of every mod. |
| GlobalNPC | abstract class | yes | This class allows you to modify and use hooks for all NPCs, both vanilla and modded. |
| IItemDropRule | interface | yes | A drop rule. |
| IItemDropRuleChainAttempt | interface | yes | A rule chained to another, run only if the first one meets its test. |
| IItemDropRuleCondition | interface | yes | A condition for a drop rule. |
| ITownNPCProfile | interface | yes | Chooses a town NPC's texture, head, name and variant. |
| InvasionEnemy | record | no | An enemy of an invasion wave: its NPC type, how often it spawns and the points it gives. |
| InvasionLoader | static class | no | Runs invasions: Start, Stop, AddPoints, and reads the wave and progress. |
| InvasionWave | record | no | One wave of an invasion: the points to clear it and its enemies. |
| ModBossBar | abstract class | yes | A class that is used to create custom boss health bars for modded and vanilla NPCs. |
| ModBossBarStyle | abstract class | yes | A class that is used to swap out the entire boss bar display system with your own implementation |
| ModEmoteBubble | abstract class | yes | Represents an emote. |
| ModInvasion | abstract class | no | A wave-based event that uses the game's progress bar. |
| ModNPC | abstract class | yes | This class serves as a place for you to place all your properties and hooks for each NPC. |
| NPC | struct | yes | What Bunny Loader adds to the game's NPC. |
| NPC.HitInfo | struct | yes | Represents a finalized damage calculation for damage about to be applied to an NPC. |
| NPC.HitModifiers | struct | yes | Represents a damage calculation in the process of being calculated for damage to be applied to an NPC. |
| NPC.Spawner | struct | yes | Spawns a boss or event the way the game does, through the phone's NPC.Spawner. |
| NPCAIStyleID | class | yes | Values of NPC.aiStyle. |
| NPCDefinition | class | yes | NPCDefinition represents an NPC identity. |
| NPCHappiness | struct | yes | This struct provides access to an NPC type's NPC & Biome relationships. |
| NPCHeadLoader | static class | yes | This class serves as a central place from which NPC head slots are stored and NPC head textures are assigned. |
| NPCID | struct | yes | NPC types. |
| NPCID.BestiaryDrawOffsets | class | no |
NPCID.Sets.NPCBestiaryDrawOffset: how an NPC is drawn in the bestiary. |
| NPCID.PortraitOffsetTable | class | no |
NPCID.Sets.NPCPortraitsCloseUpOffsets: the position of a portrait in chat. |
| NPCID.PortraitTable | class | no |
NPCID.Sets.NPCPortraits: the portrait shown in chat, per NPC. |
| NPCID.Sets | static class | yes | Tables indexed by NPC type. |
| NPCID.Sets.NPCBestiaryDrawModifiers | struct | yes | How to draw an NPC in the bestiary: position, velocity, scale, frame. |
| NPCInteraction | abstract class | yes | A button of a town NPC's chat. |
| NPCInteractionDatabase | class | yes | This holds and registers the NPCInteractionList data for each NPC. |
| NPCInteractionDatabase.DedicatedButton | class | no | A chat button with a fixed place: Close, Happiness, Housing. |
| NPCInteractionList | class | yes | Allows for NPCInteraction chat buttons to be assigned to an NPC. |
| NPCInteractionList.Entry | class | yes | This contains the NPCInteraction as well as if the interaction is enabled. |
| NPCInteractions | static class | yes | Ready-made chat buttons. |
| NPCInteractions.Actions | static class | yes | The game's chat buttons as NPCInteraction objects. |
| NPCInteractions.Actions.CloseChat | class | yes | The Close button. |
| NPCInteractions.Actions.GuideReverseCrafting | class | yes | The Guide's crafting button. |
| NPCInteractions.Actions.GuideTip | class | yes | The Guide's help button. |
| NPCInteractions.Actions.OpenShop | class | yes | A button that opens a shop by name. |
| NPCInteractions.Actions.VanillaOption | abstract class | no | One of the two buttons the game gives an NPC. |
| NPCLoader | static class | yes | This serves as the central class from which NPC-related functions are carried out. |
| NPCLoot | struct | yes | Provides access to ItemDropDatabase's methods specific to this NPC type. |
| NPCShop | class | yes | A town NPC's shop: new NPCShop(Type).Add<MyItem>().Register(). |
| NPCShop.Entry | class | yes | One line of an NPCShop. |
| NPCShopDatabase | static class | yes | Every shop by name. |
| NPCSpawnInfo | struct | no | Where and how an NPC would spawn, passed to SpawnChance. |
| Profiles | class | yes | Ready-made ITownNPCProfile classes. |
| Profiles.DefaultNPCProfile | class | yes | Class that is some-what identical to that allows for modded texture usage. |
| Profiles.StackedNPCProfile | class | yes | A profile that picks from others, usually normal and shimmered. |
| SpawnCondition | class | yes | This serves as a central class to help modders spawn their NPCs. |
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| GlobalProjectile | abstract class | yes | This class allows you to modify and use hooks for all projectiles, both vanilla and modded. |
| ModProjectile | abstract class | yes | This class serves as a place for you to place all your properties and hooks for each projectile. |
| Projectile | struct | yes | What Bunny Loader adds to the game's projectile. |
| ProjectileDefinition | class | yes | ProjectileDefinition represents a Projectile identity. |
| ProjectileID | struct | yes | Projectile types. |
| ProjectileID.Sets | static class | yes | Tables indexed by projectile type. |
| ProjectileID.Sets.FallingBlockTileItemInfo | class | yes | Used in FallingBlockTileItem. |
| ProjectileLoader | static class | yes | This serves as the central class from which projectile-related functions are carried out. |
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| BuffLoader | static class | yes | This serves as the central class from which buff-related functions are supported and carried out. |
| EquipTexture | class | yes | This serves as a place for you to program behaviors of equipment textures. |
| Gender | enum | yes | The gender a mod hair picks when the player randomizes. |
| GlobalBuff | abstract class | yes | This class allows you to modify the behavior of any buff in the game. |
| HairLoader | static class | yes | Registers mod hairs. |
| ModAccessorySlot | abstract class | yes | A ModAccessorySlot instance represents a net new accessory slot instance. |
| ModAccessorySlotPlayer | class | yes | |
| ModBuff | abstract class | yes | This class serves as a place for you to define a new buff and how that buff behaves. |
| ModHair | abstract class | yes | This class allows you to define custom hair styles for a player, controlling the associated gender and unlock conditions. |
| ModMount | abstract class | yes | This class serves as a place for you to place all your properties and hooks for each mount. |
| ModPlayer | abstract class | yes | A ModPlayer instance represents an extension of a Player instance. |
| ModResourceOverlay | abstract class | yes | This class serves as a place for you to customize how the vanilla resource displays (Classic, Fancy and Bars) are drawn. |
| Mount | struct | yes | What Bunny Loader adds to the game's mount. |
| Mount.MountData | struct | yes | What Bunny Loader adds to a mount's data. |
| Mount.MountDelegatesData | struct | yes | Replaceable methods of a mount, such as MinecartDust. |
| MountLoader | static class | yes | This serves as the central place from which mounts are stored and mount-related functions are carried out. |
| MountTextureType | enum | yes | This is an enum of all possible types of extra mount textures for custom mounts. |
| Player | struct | yes | What Bunny Loader adds to the game's player. |
| Player.HurtInfo | struct | yes | Represents a finalized damage calculation for damage about to be applied to a Player. |
| Player.HurtModifiers | struct | yes | Represents a damage calculation in the process of being calculated for damage to be applied to a Player. |
| PlayerDrawLayer | abstract class | yes | This class represents a DrawLayer for the player. |
| PlayerDrawLayer.AfterParent | class | yes | Places this layer immediately after (over) the provided parent layer. |
| PlayerDrawLayer.BeforeParent | class | yes | Places this layer immediately before (under) the provided parent layer. |
| PlayerDrawLayer.Between | class | yes | Places this layer between the two provided layers. |
| PlayerDrawLayer.Multiple | class | yes | Places this layer into multiple Positions. |
| PlayerDrawLayer.Position | abstract class | yes | A PlayerDrawLayer's position in the player rendering draw order. |
| PlayerDrawLayer.Transformation | abstract class | yes | A change applied to every layer in a group, as PlayerDrawLayer positions it. |
| PlayerDrawLayerLoader | static class | yes | Orders the layers and draws them. |
| PlayerDrawLayerSlot | class | yes | A layer that stands for a slot where another is drawn. |
| PlayerDrawLayers | struct | yes | The game's layers by name, as PlayerDrawLayers.Head, to position yours against. |
| PlayerDrawSet | struct | yes | Contains all the parameters defining how a particular player will be rendered in the current lighting, copied from the drawPlayer. |
| PlayerEyeHelper | struct | yes | The blink state of the player's eyes. |
| PlayerLoader | static class | yes | This is where all ModPlayer hooks are gathered and called. |
| PlayerStatsSnapshot | struct | yes | The player's life and mana at the moment the resource bars are drawn. |
| ResourceOverlayDrawContext | struct | yes | What a ModResourceOverlay is drawing now: texture, position, color. |
| ResourceOverlayLoader | static class | yes | Runs the hooks of mod resource overlays. |
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| BackgroundColorAttribute | class | yes | Specifies a background color to be used for the property, field, or class in the ModConfig UI. |
| BackgroundTextureLoader | static class | yes | This is the class that keeps track of all modded background textures and their slots/IDs. |
| BiomeConversionLoader | static class | yes | Registers conversion types and runs the conversions of tiles and walls. |
| BiomeLoader | static class | yes | Runs the hooks of mod biomes. |
| Chest | struct | yes | What Bunny Loader adds to the game's chest. |
| CloudInABottleJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| CloudLoader | static class | yes | Registers mod clouds. |
| ContentBoolTable | class | no | A yes-or-no table by content type. |
| ContentIntTable | class | no | A number table by content type. |
| ContentTable | class | no | A table by content type that holds objects. |
| DustID | static class | yes | The game's dust types. |
| DustLoader | static class | yes | Registers mod dusts. |
| FlexibleTileWand | struct | yes | Lets an item place several tile styles, as the Rubble Maker does. |
| GlobalPylon | abstract class | yes | Global Type that exists for pylons that allows for modification of teleportation steps, map drawing, and other functionality for any pylon that exists, whether it be vanilla or modded. |
| GlobalTile | abstract class | yes | This class allows you to modify the behavior of any tile in the game, both vanilla and modded. |
| GlobalWall | abstract class | yes | This class allows you to modify the behavior of any wall in the game (although admittedly walls don't have much behavior). |
| Gore | struct | yes | What Bunny Loader adds to the game's gore. |
| GoreLoader | static class | yes | Registers mod gores. |
| MapLayerLoader | static class | yes | Runs the mod map layers. |
| ModBannerTile | abstract class | yes | Extension to that streamlines the process of creating an enemy banner tile. |
| ModBiome | abstract class | yes | This class represents a biome added by a mod. |
| ModBiomeBestiaryInfoElement | struct | yes | The icon and name of a mod biome in a bestiary page. |
| ModBiomeConversion | abstract class | yes | This class allows you to define a modded conversion to work with Convert and RegisterConversion / RegisterConversion For the moment, this class does not provide any functional hooks, but it can still be used by mods in combination with the aforementioned hooks to create custom conversion behavior |
| ModBlockType | abstract class | yes | This is the superclass for ModTile and ModWall, combining common code |
| ModCactus | abstract class | yes | This class represents a type of modded cactus. |
| ModCloud | abstract class | yes | This class allows you to customize the behavior of a custom cloud. |
| ModDust | abstract class | yes | This class represents a type of dust that is added by a mod. |
| ModGore | abstract class | yes | This class allows you to customize the behavior of a custom gore. |
| ModMapLayer | abstract class | yes | This class is used to facilitate easily drawing icons and other things over the map. |
| ModMapLayer.After | class | yes | Draws a map layer after another one. |
| ModMapLayer.Before | class | yes | Draws a map layer before another one. |
| ModMapLayer.Position | abstract class | yes | Where a map layer goes in the draw order. |
| ModPylon | abstract class | yes | Extension to that streamlines the process of creating a modded Pylon. |
| ModSceneEffect | abstract class | yes | ModSceneEffect is an abstract class that your classes can derive from. |
| ModSubworld | abstract class | no | A dimension: a separate world the player travels to, with its own size, generation and save file. |
| ModSurfaceBackgroundStyle | abstract class | yes | Each background style determines in its own way how exactly the background is drawn. |
| ModTile | abstract class | yes | This class represents a type of tile that can be added by a mod. |
| ModTileEntity | abstract class | yes | Tile Entities are Entities tightly coupled with tiles, allowing the possibility of tiles to exhibit cool behavior. |
| ModTree | abstract class | yes | This class represents a type of modded tree. |
| ModUndergroundBackgroundStyle | abstract class | yes | Each background style determines in its own way how exactly the background is drawn. |
| ModWall | abstract class | yes | This class represents a type of wall that can be added by a mod. |
| ModWaterStyle | abstract class | yes | Represents a style of water that gets drawn, based on factors such as the background. |
| ModWaterfallStyle | abstract class | yes | Represents a style of waterfalls that gets drawn. |
| PlantLoader | static class | yes | Finds which tree, palm tree or cactus of a mod grows on a ground. |
| PressurePlateHelper | struct | yes | Tells which pressure plates are being stepped on. |
| PylonLoader | static class | yes | Runs the hooks of GlobalPylon and of mod pylons. |
| SceneEffectLoader | static class | yes | This serves as the central class from which SceneEffect functions are supported and carried out. |
| SceneEffectLoader.SceneEffectInstance | class | yes | The scene the player is in now: music, water, backgrounds, each with a priority. |
| SceneEffectLoader.SceneEffectInstance.PrioritizedPair | struct | yes | A value and the priority that chose it. |
| SceneEffectPriority | enum | yes | This enum dictates from low to high which SceneEffect selections take priority. |
| SubworldLoader | static class | no | Travels between the main world and the dimensions: Enter, Exit, Current. |
| TEModdedPylon | abstract class | yes | This is a TML provided Tile Entity that acts extremely similar to vanilla's pylon TEs by default. |
| TeleportPylonInfo | struct | yes | A pylon in the world: its position and type. |
| Tile | struct | yes | A data structure used for accessing information about tiles, walls, wires, and liquids at a single position in the world. |
| TileData | struct | no | The tile data of the world. |
| TileDefinition | class | yes | TileDefinition represents a Tile identity. |
| TileDrawing | struct | yes | What Bunny Loader adds to the game's tile drawing. |
| TileEntity | struct | yes | A tile with its own data. |
| TileID | struct | yes | Tile types. |
| TileID.Sets | static class | yes | Tables indexed by tile type. |
| TileID.Sets.FallingBlockProjectileInfo | class | yes | Used in FallingBlockProjectile. |
| TileLoader | static class | yes | This serves as the central class from which tile-related functions are supported and carried out. |
| TileObjectData | struct | yes | The layout of a multi-tile object: size, anchors, styles. |
| TileRestingInfo | struct | yes | Holds data required for offsetting an entity when it rests on a tile (sitting/sleeping). |
| WallLoader | static class | yes | This serves as the central class from which wall-related functions are supported and carried out. |
| WaterFallStylesLoader | static class | yes | Registers mod waterfall styles. |
| WaterStylesLoader | static class | yes | Registers mod water styles. |
| WorldGen | struct | yes | What Bunny Loader adds to the game's world generation. |
| WorldGenLegacyMethod | delegate | yes | The body of a PassLegacy. |
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| Asset | class | no | A texture, sound or effect that may still be loading. |
| AssetArray | struct | no | A game table of assets, such as TextureAssets.Item. |
| AssetRequestMode | enum | no | Whether a request loads in the background or now. |
| AssetState | enum | no | Where an asset is in its loading. |
| AutoloadAttribute | class | yes | Allows for customizing if the annotated Type should be automatically loaded. |
| AutoloadEquip | class | yes | This attribute annotates a ModItem class to indicate that the game should autoload the specified equipment texture or textures and assign it to this item. |
| BinaryIO | static class | yes | Reads and writes colors, vectors, items and compact numbers in a packet. |
| BitReader | class | yes | Reads back what a BitWriter wrote. |
| BitWriter | class | yes | Packs many bool into a few bytes. |
| CommandCaller | interface | yes | Who ran a chat command: the player and where to reply. |
| CommandType | enum | yes | A flag enum representing context where this command operates. |
| ILoadable | interface | yes | Works with AddContent to provide Load and Unload callbacks. |
| ILocalizedModType | interface | yes | Content with a place in the localization files. |
| ILocalizedModTypeExtensions | static class | yes | Finds the key and the text of a content's localization. |
| Lang | struct | yes | What Bunny Loader adds to the game's language tables. |
| Language | static class | yes | Contains methods to access or retrieve localization values. |
| LocalizedText | struct | yes | Contains the localization value corresponding to a key for the current game language. |
| Mod | abstract class | yes | Mod is an abstract class that you will override. |
| ModCommand | abstract class | yes | This class represents a chat or console command. |
| ModContent | static class | yes | Manages content added by mods. |
| ModLoader | static class | yes | This serves as the central class which loads mods. |
| ModPacket | class | yes | Used to send data between the server and client. |
| ModSystem | abstract class | yes | ModSystem is an abstract class that your classes can derive from. |
| ModTexturedType | abstract class | yes | The base type for most modded things with textures. |
| ModType | abstract class | yes | The base type for most modded things. |
| ModTypeLookup | static class | yes | Enables content instances to register with Register towards retrieval via and similar methods. |
| NetworkText | struct | yes | Text sent over the network, translated on each client. |
| SystemLoader | static class | yes | This is where all ModSystem hooks are gathered and called. |
| TagCompound | class | yes | Tag compounds contained named values, serializable as per the NBT spec: NBT spec wiki page All primitive data types are supported as well as byte[], int[] and Lists of other supported data types Lists of Lists are internally stored as IList Modification of lists stored in a TagCompound will only work if there were no type conversions involved and is not advised bool is supported using TagConverter, serialized as a byte. |
| TagIO | static class | yes | Writes and reads a TagCompound in binary. |
| TagSerializable | interface | yes | An object that saves itself to a TagCompound. |
| UsageException | class | yes | Throw it in a command to show the player how to use the command. |
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| AchievementLoader | static class | no | Registers mod achievements. |
| AchievementsHelper | struct | yes | Reports achievement progress. |
| ArmorShaderData | struct | yes | A shader for a dye. |
| ArmorShaderDataSet | struct | yes |
GameShaders.Armor: binds a dye item to its shader. |
| Color | struct | no | What Bunny Loader adds to the color. |
| ColorHSLSliderAttribute | class | yes | Add this attribute to a Color item and the UI will present a Hue, Saturation, and Lightness sliders rather than Red, Green, and Blue sliders. |
| ColorNoAlphaAttribute | class | yes | Add this attribute to a Color item and Alpha will not be presented in the UI and will remain as 255 unless manually edited. |
| Colors | static class | yes | The game's named colors. |
| ConfigArgsAttribute | abstract class | yes | Base of config attributes with arguments. |
| ConfigKeyAttribute | abstract class | yes | Base of config attributes that take a localization key. |
| ConfigManager | static class | yes | Finds configs by type. |
| ConfigSaveResult | enum | yes | Contains potential results for SaveChanges. |
| ConfigScope | enum | yes | Each ModConfig class has a different scope. |
| DefaultDamageClass | class | yes | One of the game's damage classes. |
| DefaultDictionaryKeyValueAttribute | class | yes | Defines the default key value to be added when using the ModConfig UI to add elements to a Dictionary. |
| DefaultListValueAttribute | class | yes | Defines the default value to be added when using the ModConfig UI to add elements to a Collection (List, Set, or Dictionary value). |
| DrawTicksAttribute | class | yes | Add this attribute and the sliders will show white tick marks at each increment. |
| GameInterfaceDrawMethod | delegate | yes | The body of a LegacyGameInterfaceLayer. |
| GameInterfaceLayer | class | yes | One layer of the game's interface, from ModSystem.ModifyInterfaceLayers. |
| HairColorMethod | delegate | no | The color a hair dye gives. |
| HairID | class | yes | Hair types. |
| HairID.Sets | static class | yes | Tables indexed by hair type. |
| HairShaderDataSet | struct | yes |
GameShaders.Hair: binds a hair dye to its shader. |
| HeaderAttribute | class | yes | This attribute adds a label above this property or field in the ModConfig UI that acts as a header. |
| IncrementAttribute | class | yes | Use this to set an increment for sliders (if using SliderAttribute) or the +/- buttons. |
| JsonDefaultDictionaryKeyValueAttribute | class | yes | Similar to JsonDefaultListValueAttribute, but for assigning to the Dictionary Key rather than the Value. |
| JsonDefaultListValueAttribute | class | yes | Similar to DefaultListValueAttribute but for reference types. |
| JsonDefaultValueAttribute | class | yes | Similar to DefaultValueAttribute but for reference types. |
| KeybindLoader | static class | yes | Registers a ModKeybind. |
| LabelArgsAttribute | class | yes | Use to provide values to be interpolated into the label of the annotated property or field. |
| LabelKeyAttribute | class | yes | A label is the text shown to the user in the ModConfig UI. |
| LegacyGameInterfaceLayer | class | yes | A layer that draws with a method of yours. |
| MenuLoader | static class | yes | Runs the mod title menus. |
| ModAchievement | abstract class | yes | Defines a custom achievement and implements how it should act upon completion. |
| ModAchievement.After | class | yes | Places an achievement after another one. |
| ModAchievement.Before | class | yes | Places an achievement before another one. |
| ModAchievement.Default | class | yes | Places an achievement in its default spot, at the end. |
| ModAchievement.Position | abstract class | yes | Where an achievement goes in the list. |
| ModConfig | abstract class | yes | ModConfig provides a way for mods to be configurable. |
| ModKeybind | class | yes | Represents a loaded input binding. |
| ModMenu | abstract class | yes | A class that is used to customize aesthetic features of the main menu, such as the logo, background and music. |
| ModTouchButton | class | no | A button on the screen, placed by the player in the game's controls editor. |
| ModTouchJoystick | class | no | A button the player drags to aim. |
| MusicLoader | static class | yes | Registers mod music and music boxes. |
| OptionStringsAttribute | class | yes | By default, string fields will provide the user with a text input field. |
| RangeAttribute | class | yes | Specifies a range for primitive data values. |
| RangedDamageClass | class | yes | One of the game's damage classes. |
| ReloadRequiredAttribute | class | yes | This attribute hints that changing the value of the annotated property or field will put the config in a state that requires a reload. |
| SeparatePageAttribute | class | yes | This specifies that the annotated item will appear as a button that leads to a separate page in the UI. |
| ShowDespiteJsonIgnoreAttribute | class | yes | This attribute indicates that the field or property should be shown in the ModConfig UI despite having a JsonIgnoreAttribute annotation. |
| ShowItemDropInUI | enum | yes | Whether a drop shows in the bestiary. |
| SliderAttribute | class | yes | Affects whether this data will be presented as a slider or an input field. |
| SliderColorAttribute | class | yes | Specifies a slider color for ModConfig elements that use a slider. |
| SoundEngine | static class | yes | Plays sounds. |
| SoundID | struct | yes | |
| SoundLimitBehavior | enum | yes | What happens when too many of a sound play together. |
| SoundStyle | struct | yes | This data type describes in detail how a sound should be played. |
| SoundUpdateCallback | delegate | no | Runs each frame for a playing sound, to change it or stop it. |
| TooltipArgsAttribute | class | yes | Use to provide values to be interpolated into the tooltip of the annotated property or field. |
| TooltipKeyAttribute | class | yes | A tooltip is the text shown to the user in the ModConfig UI next to the cursor when they hover over the annotated member (property, field, or class). |
| TouchButtonLoader | static class | no | Registers touch buttons and joysticks: RegisterButton, RegisterJoystick. |
| UICommon | static class | yes | Common colors and text of the mod menus. |
| UIElement | class | yes | The base of every UI piece: position and size in StyleDimension, children, events, drawing. |
| UIEvent | class | yes | An event of an element. |
| UIImage | class | yes | Shows a texture. |
| UIImageButton | class | yes | A texture that responds to a touch. |
| UIImageFramed | class | yes | Shows one frame of a texture. |
| UIList | class | yes | A scrollable list element. |
| UIMouseEvent | class | yes | A touch on an element. |
| UIPanel | class | yes | The game's blue panel. |
| UIScrollWheelEvent | class | yes | A scroll on an element. |
| UIScrollbar | class | yes | The game's scrollbar. |
| UIState | class | yes | A full screen of UI: the root element you give a UserInterface. |
| UIText | class | yes | Text. |
| UITextPanel | class | yes | A panel with text in it. |
| UserInterface | class | yes | Runs one UIState: update, draw and touch. |
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| GameArray | struct | no | An array of the game, such as Main.npc. |
| GameArray2D | struct | no | A two-dimensional array of the game. |
| GameClass | class | no | A class of the game by namespace and name, to create arrays of it. |
| GameConfiguration | struct | yes | What Bunny Loader adds to the game's settings file. |
| GameDictionary | struct | no | A Dictionary of the game. |
| GameException | class | no | An exception thrown by the game's code, carried into C#. |
| GameHandle | class | no | Holds a game object so the game's garbage collector keeps it. |
| GameList | struct | no | A List of the game. |
| GameListExtensions | static class | no | Helper for List<int> fields of the game, through GameObject. |
| GameNullable | struct | no |
int? and friends of the game. |
| GameObject | struct | no | Any object of the game, as a pointer. |
| GameString | struct | no | A string of the game. |
| GameTipData | class | yes | Wrapper class for a LocalizedText and visibility field that has intended use with modification of Game Tips. |
| GameTipID | static class | yes | Numbers of the game's tips. |
| IGameObject | interface | no | Every type that wraps a game object, with its Pointer. |
| Class | Kind | In tModLoader | What it is |
|---|---|---|---|
| AccessorySlotLoader | class | yes | This serves as a central place to store equipment slots and their corresponding textures. |
| AccessorySlotType | enum | yes | |
| AddableFloat | struct | yes | A value that only adds, as in StatModifier.Base. |
| AnchorData | struct | yes | How a tile object attaches to what is around it. |
| Animation | struct | yes | What Bunny Loader adds to the game's tile animations. |
| BasiliskMountJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| BigEndianReader | class | yes | A BinaryReader that reads big-endian numbers, for NBT files. |
| BigEndianWriter | class | yes | A BinaryWriter that writes big-endian numbers, for NBT files. |
| BigProgressBarSystem | struct | yes | |
| BiomeConversionID | static class | yes | The game's conversion types, as WorldGen.Convert takes them. |
| BlizzardInABottleJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| BlockType | enum | yes | The shape of a tile: solid, half brick, slopes. |
| BuffDefinition | class | yes | BuffDefinition represents an Buff identity. |
| BuffDrawParams | struct | yes | Holds data required for buff drawing. |
| BuffID | struct | yes | Buff types. |
| BuffID.Sets | struct | yes | Tables indexed by buff type. |
| BuffID.Sets.BuffTextHandlerTable | class | no | Custom buff time text, per buff. |
| BuilderToggle | abstract class | yes | Represents a builder toggle button shown in the top left corner of the screen while the inventory is shown. |
| BuilderToggle.After | class | yes | Places a builder toggle after another one. |
| BuilderToggle.Before | class | yes | Places a builder toggle before another one. |
| BuilderToggle.Default | class | yes | Places a builder toggle in its default spot. |
| BuilderToggle.Position | abstract class | yes | Where a builder toggle goes in the row. |
| BuilderToggleDrawParams | struct | yes | Holds data required for builder toggle drawing. |
| BuyItemCreationContext | class | yes | Created in the context of a player buying an item from a shop. |
| CachedProjectileCounterBuffTextHandler | struct | yes | A buff text that counts a projectile, as minion buffs do. |
| CalculatedStyle | struct | yes | The final position and size of an element, in pixels. |
| CameraModifierStack | struct | yes |
Main.instance.CameraModifiers: adds a screen shake or camera move. |
| Chains | static class | yes | Chains one rule to another with OnSuccess, OnFailedRoll, OnFailedConditions. |
| Chains.TryIfDoesntFillConditions | class | yes | Runs the next rule when the conditions fail. |
| Chains.TryIfFailedRandomRoll | class | yes | Runs the next rule when the roll fails. |
| Chains.TryIfSucceeded | class | yes | Runs the next rule when this one drops. |
| Collision | struct | yes | What Bunny Loader adds to the game's collision. |
| CommandLoader | static class | yes | This serves as the central class from which ModCommand functions are supported and carried out. |
| CommonCode | static class | yes | Helpers that drop items, used by rules. |
| CommonDrop | class | yes | Drops an item with a chance. |
| CommonDropNotScalingWithLuck | class | yes | A CommonDrop that ignores luck. |
| CommonDropScalingWithOnlyBadLuck | class | yes | A CommonDrop that only bad luck changes. |
| CommonDropWithRerolls | class | yes | A CommonDrop with more tries. |
| ContentSamples | static class | yes | A ready sample of each item, NPC and projectile, set up with defaults. |
| ContentSamples.BestiaryRarityStars | class | no | Stars each NPC gets in the bestiary. |
| ContentSamples.ItemSamples | class | no |
ContentSamples.ItemsByType. |
| ContentSamples.ProjectileSamples | class | no |
ContentSamples.ProjectilesByType. |
| CursorOverrideID | class | yes | Cursor icons in the inventory. |
| CustomModConfigItemAttribute | class | yes | Use this attribute to specify a custom UI element to be used for the annotated property, field, or class in the ModConfig UI. |
| CycleAttribute | class | yes | If present, this data will be presented as a cylc button. |
| DashID | static class | yes | Corresponds to values assigned to dashType. |
| DrawAnimationVertical | struct | yes | An animation for Main.RegisterItemAnimation: frames stacked vertically. |
| DrawData | struct | yes | A sprite waiting to be drawn, as the player draw layers use it. |
| DrawDataList | struct | no | The list a player draw layer adds its DrawData to. |
| DropAttemptInfo | struct | yes | What is happening when a rule runs: the NPC, player, item and the random source. |
| DropBasedOnExpertMode | class | yes | Runs one rule in Expert and another in Normal. |
| DropBasedOnExtraGel | class | yes | Runs a rule by the extra gel of a slime. |
| DropBasedOnMasterAndExpertMode | class | yes | Runs one of three rules by difficulty. |
| DropBasedOnMasterMode | class | yes | Runs one rule in Master and another below it. |
| DropLocalPerClientAndResetsNPCMoneyTo0 | class | yes | Drops for each client, and takes the NPC's money away. |
| DropNothing | class | yes | Drops nothing. |
| DropOneByOne | class | yes | Drops items one at a time, each with its chance. |
| DropOneByOne.Parameters | struct | yes | The amounts and chances of a DropOneByOne. |
| DropPerPlayerOnThePlayer | class | yes | Drops one for each player, at the player. |
| DropRateInfo | struct | yes | What the bestiary shows for a drop. |
| DropRateInfoChainFeed | struct | yes | The chance carried along a rule chain, for the bestiary. |
| DropdownAttribute | class | yes | If present, this data will be presented as a drop down. |
| Entity | struct | yes | What Bunny Loader adds to the game's entity. |
| EntityDefinition | abstract class | yes | Classes implementing EntityDefinition serve to function as a way to save and load the identities of various Terraria objects. |
| EntitySource_ShakeTree | struct | yes | The source of what falls from a shaken tree. |
| EntitySource_TileBreak | struct | yes | The source of what a broken tile drops. |
| EntitySource_TileUpdate | struct | yes | Intended for mods to use when a tile spawns an entity due to periodic/random updating, rather than in response to a specific trigger. |
| EquipType | enum | yes | This is an enum of all the types of equipment that exist. |
| ExpandAttribute | class | yes | Affects whether this data will be expanded by default. |
| Extensions | static class | yes | Chain methods as extensions of a rule. |
| ExtraJump | abstract class | yes |
ExtraJump is a singleton, defining the properties and behaviour of midair extra jumps. |
| ExtraJump.After | class | yes | Places an extra jump after another one. |
| ExtraJump.Before | class | yes | Places an extra jump before another one. |
| ExtraJump.Position | abstract class | yes | Where an extra jump goes in the order the game tries them. |
| ExtraJumpLoader | static class | yes | Runs the extra jumps. |
| ExtraJumpState | struct | yes | A structure containing fields used to manage extra jumps Valid states for an extra jump are as follows: Enabled = false | The extra jump cannot be used. |
| FartInAJarJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| FilterManager | struct | yes |
Filters.Scene: the full-screen filters. |
| FlavorTextBestiaryInfoElement | struct | yes | The description of a bestiary page, by localization key. |
| FlipperJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| FromOptionsWithoutRepeatsDropRule | class | yes | Drops some items from a list, with no repeats. |
| GenBase | abstract class | yes | The base of a world generation step. |
| GenPass | abstract class | yes | One step of world generation, added in ModSystem.ModifyWorldGenTasks. |
| GenerationProgress | struct | yes | The progress text and value of a step. |
| GenericDamageClass | class | yes | One of the game's damage classes. |
| GlobalBackgroundStyle | abstract class | yes | This class serves to collect functions that operate on any kind of background style, without being specific to one single background style. |
| GlobalLoot | struct | yes | This readonly struct is a simple shortcut for modifying global drop rules in an ItemDropDatabase. |
| GlobalType | abstract class | yes | The base of every GlobalX. |
| GoatMountJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| ICustomAutoload | interface | yes | Provides a static abstract Autoload method for mods to implement their own autoloading for types where ILoadable does not suffice. |
| IEntityWithGlobals | interface | yes | An entity with GlobalX instances. |
| ILoot | interface | yes | A list of drop rules: npcLoot and itemLoot in ModifyNPCLoot and ModifyItemLoot. |
| IMapLayer | struct | yes | A layer of the full map. |
| IModCameraModifier | interface | no | A change to the camera, per frame. |
| IModParticle | interface | no | A particle you draw yourself. |
| IModType | interface | yes | Content with a mod and a name. |
| INestedItemDropRule | interface | yes | A rule that runs another rule. |
| IPlant | interface | yes | Common to mod trees, palm trees and cactus. |
| IProvideItemConditionDescription | interface | yes | A condition with text for the bestiary. |
| ITree | interface | yes | Common to mod trees and palm trees. |
| ImmunityCooldownID | static class | yes | The kinds of immunity after a hit. |
| InfoDisplay | abstract class | yes | Represents an informational display toggle typically provided by informational accessories. |
| LeadingConditionRule | class | yes | A condition with no drop, that leads a chain. |
| LegacyHairShaderData | struct | yes | A hair dye made of a color method. |
| LegacyNameAttribute | class | yes | Allows for types to be registered with legacy/alias names for lookup via and similar methods. |
| LegacySoundStyle | struct | yes | The game's sound by number. |
| LoaderManager | static class | yes | |
| MagicDamageClass | class | yes | One of the game's damage classes. |
| MagicSummonHybridDamageClass | class | yes | One of the game's damage classes. |
| Main | struct | yes | What Bunny Loader adds to the game's main class. |
| MechBossSpawnersDropRule | class | yes | The spawners of the mechanical bosses. |
| MeleeDamageClass | class | yes | One of the game's damage classes. |
| MeleeNoSpeedDamageClass | class | yes | One of the game's damage classes. |
| ModBackgroundStyle | abstract class | yes | Base of the mod backgrounds. |
| ModSide | enum | yes | A ModSide enum defines how mods are synced between clients and servers. |
| MultipliableFloat | struct | yes | A value that only multiplies, as in StatModifier. |
| NativeDropCondition | class | no | A condition of the mobile game, with a C# face. |
| NativeDropRule | class | no | A rule of the mobile game, with a C# face. |
| NetmodeID | static class | yes | Correspond to netMode values. |
| NullAllowedAttribute | class | yes | This attribute means the annotated item can possibly be null. |
| OneFromOptionsDropRule | class | yes | Drops one item from a list. |
| OneFromOptionsNotScaledWithLuckDropRule | class | yes | Drops one item from a list, ignoring luck. |
| OneFromRulesRule | class | yes | Runs one rule from a list. |
| OverlayManager | struct | yes |
Overlays.Scene: the screen overlays. |
| ParticleRenderer | struct | yes | Draws IParticle objects. |
| PassLegacy | class | yes | A GenPass from a method. |
| PlacementHook | struct | yes | A method called when a tile object is placed, for TileObjectData.newTile. |
| Point | struct | no | What Bunny Loader adds to the point. |
| Point16 | struct | yes | A tile position in two short. |
| PosData | struct | yes | A value at a position, in a sorted array, for sparse data by tile. |
| PosData.OrderedSparseLookupBuilder | class | yes | Efficient builder for [] lookups covering the whole world. |
| PosData.OrderedSparseLookupReader | class | yes | Reads a PosData array walking forward. |
| PrefixCategory | enum | yes | The kind of item a prefix fits. |
| PrefixDefinition | class | yes | PrefixDefinition represents a Prefix identity. |
| ProjAIStyleID | static class | yes | Values of Projectile.aiStyle. |
| Rectangle | struct | no | What Bunny Loader adds to the rectangle. |
| ReinitializeDuringResizeArraysAttribute | class | yes | Classes annotated with this attribute will have their static constructor called again during the ResizeArrays stage of mod loading. |
| SandstormInABottleJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| SantankMountJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| SetFactory | struct | yes | SetFactory is responsible for creating "custom ID sets" for content. |
| SetFactory.NamedSetKey | class | yes | Used to construct the key for this "named ID set". |
| SimpleItemDropRuleCondition | record | yes | A condition made of a method and a text. |
| SimpleModCloud | class | yes | A ModCloud made by Autoload from a texture in Clouds/. |
| SimpleModGore | class | yes | A ModGore made by Autoload from a texture in Gores/. |
| SkyManager | struct | yes |
SkyManager.Instance: the custom skies. |
| SlimeBodyItemDropRule | class | yes | What a slime carries inside. |
| SlopeType | enum | yes | The slope of a tile. |
| SpriteFrame | struct | yes | One frame of a sprite sheet. |
| StatInheritanceData | struct | yes | How much one damage class takes from another. |
| StatueMimicItemDropRule | class | yes | The drop of a statue mimic. |
| StyleDimension | struct | yes | A position or size made of pixels plus a share of the parent. |
| SummonDamageClass | class | yes | One of the game's damage classes. |
| SummonMeleeSpeedDamageClass | class | yes | One of the game's damage classes. |
| SurfaceBackgroundStylesLoader | static class | yes | Registers the mod surface backgrounds. |
| TextureAssetArray | class | no | A table of the game's textures by type. |
| TextureAssets | static class | yes | The game's textures by type: TextureAssets.Item[type]. |
| ThrowingDamageClass | class | yes | One of the game's damage classes. |
| ToFromStringConverter | class | yes | This TypeConverter facilitates converting to and from the string Type. |
| TreePaintingSettings | struct | yes | How a tree takes paint. |
| TsunamiInABottleJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| UndergroundBackgroundStylesLoader | static class | yes | This serves as the central class from which ModUndergroundBackgroundStyle functions are supported and carried out. |
| UnicornMountJump | class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| UnloadedAccessorySlot | class | yes | |
| Utils | static class | yes | What Bunny Loader adds to the game's helpers. |
| UtilsExtensions | static class | yes | The extension methods tModLoader has in Utils, written here as extensions of the mobile game's types. |
| VanillaDamageClass | abstract class | yes | One of the game's damage classes. |
| VanillaExtraJump | abstract class | yes | One of the game's extra jumps, as an ExtraJump you can position against or read from Player.GetJumpState. |
| Vector2 | struct | no | A 2D vector of the game: position, velocity, scale. |
| Vector3 | struct | no | A 3D vector, also used for light and color values. |
| Vector4 | struct | no | A 4D vector, used for shader values and colors. |
| WallDefinition | class | yes | WallDefinition represents a Wall identity. |
| WeightedRandom | class | yes | Picks an item by weight. |
| WhipSettings | struct | yes | What Bunny Loader adds to the whip settings. |
| WhipTagEffect | struct | yes | What a whip's tag does to the minions' hits. |
| WingStats | struct | yes | The flight time and speed of a pair of wings. |
| Wiring | static class | yes | What Bunny Loader adds to the game's wiring. |
| WorldFileData | struct | yes | What Bunny Loader adds to the file data of a world. |
Public classes of tModLoader's mod API that Bunny Loader does not have. Names are under Terraria.ModLoader.
| Classes | Why |
|---|---|
ActiveItemIterator, ActiveItemIterator.Enumerator, ActiveNPCIterator, ActiveNPCIterator.Enumerator, ActivePlayerIterator, ActivePlayerIterator.Enumerator, ActiveProjectileIterator, ActiveProjectileIterator.Enumerator
|
Main.ActiveItems, ActiveNPCs, ActivePlayers and ActiveProjectiles exist and return a plain IEnumerable. |
ActuatorsVisibilityBuilderToggle, AutoActuateBuilderToggle, AutoPaintBuilderToggle, BlockSwapBuilderToggle, BlueWireVisibilityBuilderToggle, GreenWireVisibilityBuilderToggle, HideAllWiresBuilderToggle, RedWireVisibilityBuilderToggle, RulerGridBuilderToggle, RulerLineBuilderToggle, TorchBiomeBuilderToggle, VanillaBuilderToggle, WireVisibilityBuilderToggle, YellowWireVisibilityBuilderToggle
|
The game's own toggles are not classes here. BuilderToggle.TorchBiome is the one exposed, and mods add theirs with BuilderToggle. |
Assets.AssemblyResourcesContentSource, Assets.FxcReader, Assets.MP3Reader, Assets.OggReader, Assets.RawImgReader, Assets.TModContentSource, Assets.WavReader
|
File readers of tModLoader's asset system. Here assets go through ModContent.Request and Bunny Loader's own readers. |
AsyncProvider, AsyncProviderState, AsyncProviderStateExtensions, ICustomAutoload.AutoloadImpl, ILoadable.AutoloadImpl, ILoader, Loader, ModContent.TrackCurrentlyLoadingMod
|
Internal to tModLoader's loading. |
BuildInfo, BuildInfo.BuildPurpose, Framework, FrameworkVersion
|
Describes tModLoader's own build. |
BuilderToggleLoader |
Internal here. Mods subclass BuilderToggle. |
CloneByReference, DamageClass.Sets, InitializationItemCreationContext
|
Not implemented. |
CombinedHooks |
Internal here. It runs the ModPlayer and GlobalItem hooks of a use together, and those hooks exist. |
CompassInfoDisplay, DPSMeterInfoDisplay, DepthMeterInfoDisplay, DummyInfoDisplay, FishFinderInfoDisplay, LifeformAnalyzerInfoDisplay, MetalDetectorInfoDisplay, RadarInfoDisplay, SextantInfoDisplay, StopwatchInfoDisplay, TallyCounterInfoDisplay, VanillaInfoDisplay, WatchesInfoDisplay, WeatherRadioInfoDisplay
|
The game's own displays are not classes here. Mods add theirs with InfoDisplay. |
Config.LabelAttribute |
Old in tModLoader too. Labels come from the localization files. |
Config.TooltipAttribute |
Old in tModLoader too. Tooltips come from the localization files. |
ContentInstance |
Internal to tModLoader. Use ModContent.GetInstance<T>(). |
Default.ModLoaderModItem |
Base of tModLoader's own items. |
Default.PylonShopNPC |
tModLoader's rule for selling pylons in shops. Here the same rule is internal, and NPCShopDatabase.NoPylons lists the exceptions. |
Default.StartBag |
tModLoader's bag of starting items. ModPlayer.AddStartingItems puts them straight in the inventory. |
Default.UnloadedChest, Default.UnloadedDresser, Default.UnloadedGlobalItem, Default.UnloadedGlobalNPC, Default.UnloadedItem, Default.UnloadedNonSolidTile, Default.UnloadedPlayer, Default.UnloadedPrefix, Default.UnloadedSemiSolidTile, Default.UnloadedSolidTile, Default.UnloadedSupremeFurniture, Default.UnloadedSystem, Default.UnloadedTile, Default.UnloadedTileEntity, Default.UnloadedWall
|
tModLoader keeps content of a removed mod as a placeholder. There are no placeholders here: such an item loads empty. |
ExtendsFromModAttribute |
Weak references to other mods are not part of Bunny Loader. |
GlobalBlockType |
GlobalTile and GlobalWall derive directly from ModType here. |
GlobalInfoDisplay |
Not implemented: mods cannot change the displays of other mods or of the game. |
GlobalList |
Internal to tModLoader. Here the lists of globals live in Terraria.ModLoader.Core. |
GlobalRecipe |
Not implemented. Change recipes with ModSystem.PostAddRecipes. |
IAutoload, IAutoloader
|
Internal to tModLoader's loading. ILoadable and ICustomAutoload are the ones that exist. |
IEntityWithInstances |
Internal to tModLoader. Instances live in Terraria.ModLoader.Core. |
IIndexed, ModSideExtensions, RefReadOnlyArray, TopoSort, TopoSort.SortingException
|
Internal to tModLoader. |
ILPatchFailureException, MonoModHooks
|
IL editing cannot exist here: the game is compiled to machine code. Use the On_X hooks. |
IO.BoolTagSerializer, IO.ColorSerializer, IO.MultiDimArraySerializer, IO.Point16Serializer, IO.PointSerializer, IO.RectangleSerializer, IO.TagSerializer, IO.UIntTagSerializer, IO.ULongTagSerializer, IO.UShortTagSerializer, IO.Vector2TagSerializer, IO.Vector3TagSerializer, IO.VersionSerializer
|
Not implemented. TagCompound takes numbers, bool, strings, lists, enums, Item and TagSerializable. A Vector2 or Color must be saved as its own fields. |
IO.ImageIO |
tModLoader's .rawimg format. Mods here ship PNG. |
IO.TagPrinter |
Debug helper of tModLoader. |
IO.TileIO.IOImpl, IO.TileIO.TileIOImpl, IO.TileIO.WallIOImpl
|
tModLoader's save of tiles. Here tiles and walls go to Bunny Loader's own .bl files. |
IO.UploadFile |
Part of tModLoader's mod browser. |
IPylonTileEntity |
Mod pylons use TEModdedPylon directly. |
InfoDisplayLoader |
Internal here. Mods subclass InfoDisplay. |
JITWhenModsEnabledAttribute, MemberJitAttribute, NoJITAttribute, PreJITFilter
|
tModLoader compiles mods at load time with the JIT. Here a mod's DLL runs on Mono with no such filters. |
LocalizationLoader, LocalizationLoader.CommentedWscJsonObject, LocalizationLoader.LocalizationEntry, LocalizationLoader.LocalizationFile
|
Internal here. Localization files load by themselves. |
Logging, Logging.LogFile, Logging.QuietExceptionHandle
|
tModLoader's log. Use Mod.Logger. |
MapLegend |
Not implemented. Use ModTile.AddMapEntry. |
ModNet |
Internal here. Use Mod.GetPacket and Mod.HandlePacket. |
ModPalmTree |
Not implemented. ModTree and ModCactus exist. |
ModResourceDisplaySet, ResourceDisplaySetLoader
|
Not implemented. ModResourceOverlay exists. |
TravelingMerchantShop, TravelingMerchantShop.InfoEntry
|
Not implemented as a shop class. The game's merchant still works, and GlobalNPC.SetupTravelShop runs. |
Bunny Loader wiki ·
Discord ·
Repository ·
BL Editor
Written for Bunny Loader 0.5.5-beta and Terraria Mobile 1.4.5.8.6.
Bunny Loader is not affiliated with Re-Logic or 505 Games.
