Skip to content

API Reference

Anvil’s API is grouped by domain. Start with the relevant guide page for examples, then use these module references when you need the exact classes or functions.

Content APIs

  • Actors: Custom entity definitions, entity components, spawn rules, and materials.
  • Blocks: Block definitions, block components, and custom behaviors.
  • Items: Item definitions, item components, and crafting / brewing recipes.

Runtime APIs

  • Logic: Molang query and expression wrappers.
  • World: Cameras, fog, loot tables, particles, features, and jigsaw structures.
  • Biomes: Biome definitions and components.
  • UI: UI and HUD manipulation.
  • PBR: Physical-based rendering, texture sets, and material properties.
  • Vanilla: Reference identifiers for vanilla Minecraft entities, items, and blocks.

Core Library

  • Config: Anvil project configuration and settings.
  • Schemas: Low-level JSON schemas and base addon objects.
  • Types: Type definitions, vectors, and identifiers.
  • Enums: Enums for components, slots, operations, and states.
  • Filters: Minecraft test filters builder.
  • Lib: Core utility functions and I/O helpers.
  • Reports: Build reporting and analytics.
  • Sounds: Sound events, music definitions, and sound categories.
  • Textures: Texture registration and atlas generators.
  • Templater: Template generators for Bedrock files.
  • Translator: Language localization helpers.
  • Blockbench: Blockbench geometry and animation importers.
  • Format Versions: Minecraft Bedrock format version helpers.