API reference
The reference is generated from the XML documentation and reflection metadata of Mc.Scripting.Api (namespace Mc.Scripting), and from the event catalogue src/scripting/events.json. It covers every public type: 305 types, 2408 members.
Machine-readable: /api.json. For agents: /llms.txt and /llms-full.txt.
Plugins and lifecycle
Section titled “Plugins and lifecycle”Entry points, metadata, API versions, the per-plugin context and everything that is released on unload.
ApiVersion · IPlugin · IPluginResource · McPluginAttribute · Plugin · PluginContext · PluginDependency · PluginInfoAttribute · PluginMessageHandler · PluginMetadata · Plugins · VersionConstraint
Events (infrastructure)
Section titled “Events (infrastructure)”Subscribing, firing, priorities, the event struct contract and the cause/reason enums events carry.
DamageCause · EventBus · EventHeader · EventListener<T> · EventPriority · EventRegistry · EventType<T> · GameModeChangeCause · IEvent · IgniteCause · InteractAction · LoginDeferral · PlayerAction · PortalCreateReason · RespawnReason · SpawnReason · Subscription · TeleportCause · TimeSkipReason
Event types
Section titled “Event types”The event catalogue: one struct per event, generated from src/scripting/events.json.
See also the event catalogue and the event explorer.
BlockBreakEvent · BlockBurnEvent · BlockDamageEvent · BlockFadeEvent · BlockFormEvent · BlockGrowEvent · BlockIgniteEvent · BlockPistonExtendEvent · BlockPistonRetractEvent · BlockPlaceEvent · BlockRedstoneEvent · BlockSpreadEvent · ChunkLoadEvent · ChunkUnloadEvent · CommandsRegisteredEvent · CraftItemEvent · CustomBlockBreakEvent · CustomBlockInteractEvent · CustomBlockPlaceEvent · CustomItemUseEvent · EnchantItemEvent · EntityCombustEvent · EntityDamageEvent · EntityDeathEvent · EntitySpawnEvent · FurnaceBurnEvent · FurnaceSmeltEvent · InventoryClickEvent · InventoryCloseEvent · InventoryDragEvent · InventoryOpenEvent · MenuClickEvent · MenuCloseEvent · NpcInteractEvent · PacketReceiveEvent · PacketSendEvent · PermissionChangedEvent · PermissionsReloadedEvent · PlayerChangedWorldEvent · PlayerChatEvent · PlayerCommandEvent · PlayerConsumeEvent · PlayerCreativeSlotEvent · PlayerDeathEvent · PlayerDropItemEvent · PlayerGameModeChangeEvent · PlayerInteractBlockEvent · PlayerInteractEntityEvent · PlayerInteractEvent · PlayerItemHeldEvent · PlayerJoinEvent · PlayerKickEvent · PlayerLevelChangeEvent · PlayerMoveEvent · PlayerPickupItemEvent · PlayerPortalEvent · PlayerPreLoginEvent · PlayerQuitEvent · PlayerResourcePackStatusEvent · PlayerRespawnEvent · PlayerSwapHandsEvent · PlayerTeleportEvent · PlayerToggleFlightEvent · PlayerToggleSneakEvent · PlayerToggleSprintEvent · PluginDisableEvent · PluginEnableEvent · PortalCreateEvent · PrepareAnvilEvent · PrepareCraftEvent · PrivateMessageEvent · ServerListPingEvent · ServerStartEvent · ServerStopEvent · TickEndEvent · TickStartEvent · TimeSkipEvent · WeatherChangeEvent
Commands
Section titled “Commands”Command trees, arguments, suggestions and reading an invocation.
Arg · ArgType · AsyncSuggestionProvider · Command · CommandContext · CommandExecutor · CommandFailure · CommandHandler · CommandNode · CommandRegistry · CommandSource · DetachedCommand · RegisteredCommand · SuggestionContext · SuggestionProvider · SuggestionsBuilder
Permissions
Section titled “Permissions”Permission nodes, defaults, the permission manager and providers.
FilePermissionProvider · IPermissionProvider · McPermissionAttribute · NativePermissionTable · NativeRule · NativeTableStats · Permission · PermissionDefault · PermissionManager · PermissionValue · PluginPermissions
Config and data
Section titled “Config and data”Typed plugin configuration and the plugin data folder.
Services
Section titled “Services”Inter-plugin services and the built-in service contracts (economy, bans, placeholders, player meta).
Affix · AffixKind · BanEntry · Currency · EconomyResult · IBanList · IEconomy · IPlaceholders · IPlayerMeta · MetaKey<T> · PlaceholderScope · PlaceholderValue · PlayerMetaExtensions · ServiceManager · ServicePriority · ServiceRegistration<T> · ServiceUnavailableException
Players
Section titled “Players”Online and offline players, game modes, effects, sounds, particles and resource packs.
GameMode · Hand · InteractionHand · OfflinePlayers · OfflineProfile · Particle · Player · PlayerSnapshot · PotionEffect · ResourcePack · ResourcePackStatus · SoundCategory
Scoreboards, boss bars, tab list
Section titled “Scoreboards, boss bars, tab list”Sidebars, objectives, boss bars, titles, the tab list, nametags and the below-name line.
Belowname · BossBar · BossBarColor · BossBarFlags · BossBars · BossBarStyle · DisplaySlot · NametagCollision · Nametags · NametagStyle · NametagVisibility · Objective · PresenceExtensions · Scoreboard · ScoreFormat · Sidebar · Sidebars · TabEntry · Tablist · TitleTimes
Chat and text
Section titled “Chat and text”Rich text components, chat routing, channels and mutes.
ChannelRegistry · ChannelSubscription · Chat · ChatFilterKind · ChatKind · ChatMute · ChatMuteEntry · ChatRoute · ClickAction · ClickEvent · HoverEvent · TextColor
Inventories and menus
Section titled “Inventories and menus”Item stacks, player and block inventories, and custom menus.
BlockInventory · ClickType · DragType · EngineInventory · IInventory · InventoryKind · ItemStack · ItemView · Menu · MenuClick · MenuClickType · MenuCloseReason · Menus · MenuType · PlayerInventory
Worlds and blocks
Section titled “Worlds and blocks”Dimensions, block states, weather, height maps and chunk tickets.
BlockFace · BlockState · BlockUpdateFlags · ChunkTicket · ChunkTickets · Facing · HeightMap · WeatherType · World
Custom content
Section titled “Custom content”Custom blocks and items, and the resource pack they are served with.
BlockBreakContext · BlockInteractContext · BlockPlaceContext · BlockRegistry · Content · CustomBlock · CustomItem · ItemRarity · ItemRegistry · ItemUseContext · PackImage · ResourcePackBuilder · ResourcePackFile · ResourcePackHost
Holograms and NPCs
Section titled “Holograms and NPCs”Client-side holograms and NPCs.
Hologram · HologramAlign · HologramBillboard · HologramOptions · Holograms · Npc · NpcClick · NpcInteraction · NpcPose · Npcs · NpcSkin · NpcSlot
NBT tags, binary IO and SNBT.
NbtByte · NbtByteArray · NbtCompound · NbtDouble · NbtFloat · NbtInt · NbtIntArray · NbtIo · NbtList · NbtLong · NbtLongArray · NbtShort · NbtString · NbtTag · NbtType · NbtValueTag · Snbt
Packets
Section titled “Packets”Observing and intercepting protocol packets.
PacketBase · PacketEvent<T> · PacketMode · Packets · PacketSendStatus
Entities, components, queries
Section titled “Entities, components, queries”Entity handles, plain-data components and cached queries over the ECS.
Component · Component<T> · Ecs · Entity · Query · Query<T1, T2, T3> · Query<T1, T2> · Query<T1> · QueryAction<T1, T2, T3> · QueryAction<T1, T2> · QueryAction<T1> · QueryChunk · QueryEnumerator
Systems and phases
Section titled “Systems and phases”Per-tick systems and where they run in the tick pipeline.
Phase · SystemCallback · SystemHandle · SystemPlacement · SystemRegistry
Scheduler and threading
Section titled “Scheduler and threading”Delayed, repeating and cross-thread tasks, tick awaitables and the tick-thread check.
ScheduledTask · Scheduler · TickAwaitable · WrongThreadException
Server, HTTP and logging
Section titled “Server, HTTP and logging”Server-wide services, tick timings, outgoing HTTP and logging.
Http · Log · Logger · LogLevel · Server · TickTimes
Primitives
Section titled “Primitives”Blittable value types shared with the native side.
BlockPos · Location · NativeBytes · Utf8String · Uuid · Vec3d
Documentation coverage
Section titled “Documentation coverage”Of 2408 members, 2301 are documented in the C# XML comments, 2 take their text from the site’s supplement (docs-site/api-supplement), 105 have no description yet (their signature is still listed). Adding /// comments to src/scripting/managed/Mc.Scripting.Api improves this page on the next build.