# Bloxd Code API

> JavaScript that runs inside Bloxd, in code blocks, boards and World Code: from a block that launches players into the sky to a whole custom game. Code calls methods on the `api` object and defines callbacks that react to game events.

Each link is a page of the docs as Markdown. A page longer than about 6K tokens is also split into parts, listed under it, so that each fits a small context window. People read the same docs at https://bloxd.io/docs.

## Get started

- [Welcome](https://bloxd.io/docs/index.md): Run JavaScript in Bloxd, from a single block to a whole custom game. About 1K tokens.
- [Getting started](https://bloxd.io/docs/getting-started.md): Code blocks, boards and World Code, and the globals your code can use. About 1K tokens.
- [Snippets](https://bloxd.io/docs/snippets.md): Ready-made code for common jobs, from moving players to running code every second. About 1K tokens.
- [Changelog](https://bloxd.io/docs/changelog.md): What changed in the Code API, newest first. About 5K tokens.

## How-Tos

- [How-Tos](https://bloxd.io/docs/how-to.md): Step-by-step guides for variations, plugins and full games. About 1K tokens.
- [Variations](https://bloxd.io/docs/how-to-variations.md): Alternate versions of a custom game, and matchmaking players between them. About 1K tokens.
- [Plugins](https://bloxd.io/docs/how-to-plugins.md): Reusable first-party World Code features, imported from @plugins. About 1K tokens.
- [Building a SessionBasedGame](https://bloxd.io/docs/how-to-building-a-session-based-game.md): A full team game: lobby, teams, map voting, rounds and a winner. About 4K tokens.
- [Interactable NPCs](https://bloxd.io/docs/how-to-interactable-npcs.md): Entities players talk to or use, such as shopkeepers and guards. About 1K tokens.
- [Dialogue](https://bloxd.io/docs/how-to-dialogue.md): Lines of dialogue below the crosshair, read out a syllable at a time in a voice. About 1K tokens.
- [Project schematics](https://bloxd.io/docs/how-to-project-schematics.md): Build whole chunks from schematics stored with your project. About 1K tokens.

## Reference

- [API Reference](https://bloxd.io/docs/api-reference.md): Every method on the api object, with parameters and return types. About 24K tokens, in 5 parts:
  - [Part 1: addCustomKillfeedMessage to createEnchantmentAttributesForItem](https://bloxd.io/docs/api-reference/1.md)
  - [Part 2: createItemDrop to getMoonstoneChestItemSlot](https://bloxd.io/docs/api-reference/2.md)
  - [Part 3: getNumMobs to preventFallDamageNextGrounding](https://bloxd.io/docs/api-reference/3.md)
  - [Part 4: progressBarUpdate to setCurrencyAmount](https://bloxd.io/docs/api-reference/4.md)
  - [Part 5: setDefaultMobSetting to updateShopItemForPlayer](https://bloxd.io/docs/api-reference/5.md)
- [Callbacks](https://bloxd.io/docs/callbacks.md): Functions your world code defines to react to game events. About 12K tokens, in 3 parts:
  - [Part 1: doPeriodicSave to onPlayerAttemptFish](https://bloxd.io/docs/callbacks/1.md)
  - [Part 2: onPlayerAttemptOpenChest to onPlayerMoveInvenItemWithAmt](https://bloxd.io/docs/callbacks/2.md)
  - [Part 3: onPlayerMoveItemIntoIdxs to tick](https://bloxd.io/docs/callbacks/3.md)
- [Client Options](https://bloxd.io/docs/client-options.md): Per-player options such as speed, health and camera. About 7K tokens, in 2 parts:
  - [Part 1: airAccScale to fogOnSkybox](https://bloxd.io/docs/client-options/1.md)
  - [Part 2: forcedCameraDirection to zoomOutDistance](https://bloxd.io/docs/client-options/2.md)
- [Types](https://bloxd.io/docs/types.md): The types the API Reference's parameters and return values refer to. About 4K tokens.

## Settings

- [Entity Settings](https://bloxd.io/docs/entity-settings.md): How one player sees and interacts with another entity. About 2K tokens.
- [Mob Settings](https://bloxd.io/docs/mob-settings.md): Health, movement, combat and AI settings for mobs. About 4K tokens.
- [Vehicle Settings](https://bloxd.io/docs/vehicle-settings.md): Movement, physics and camera settings for vehicles. About 9K tokens, in 2 parts:
  - [Part 1: Vehicle Catalogue to mass](https://bloxd.io/docs/vehicle-settings/1.md)
  - [Part 2: maxPushDistance to Types Glossary](https://bloxd.io/docs/vehicle-settings/2.md)

## Systems

- [Mesh Entities](https://bloxd.io/docs/mesh-entities.md): Spawn mesh entities and throwables, and attach meshes to nodes. About 3K tokens.
- [QTEs](https://bloxd.io/docs/qte.md): Quick time events: progress bars, timed clicks and rhythm games. About 2K tokens.
- [Dialogue Voices](https://bloxd.io/docs/dialogue-voices.md): The voices dialogue is read out in, with a playground for making voices of your own. About 1K tokens.

## Assets

- [Particles](https://bloxd.io/docs/particles.md): Particle textures and presets, with a live effect playground. About 1K tokens.
- [Sounds & Music](https://bloxd.io/docs/sounds.md): Every sound effect and song you can play. About 3K tokens.
- [Icons](https://bloxd.io/docs/icons.md): Icons for styled text, from Bloxd icons to Font Awesome. About 2K tokens.
- [Skins & Poses](https://bloxd.io/docs/skins.md): Skin parts, NPC skins and poses for players. About 1K tokens.
- [Block Names](https://bloxd.io/docs/block-names.md): Every block name, with its texture and variants. About 8K tokens, in 2 parts:
  - [Part 1](https://bloxd.io/docs/block-names/1.md)
  - [Part 2](https://bloxd.io/docs/block-names/2.md)
- [Item Names](https://bloxd.io/docs/item-names.md): Every item name, with its texture. About 8K tokens, in 2 parts:
  - [Part 1](https://bloxd.io/docs/item-names/1.md)
  - [Part 2](https://bloxd.io/docs/item-names/2.md)

## Optional

- [Every page in one file](https://bloxd.io/docs/llms-full.txt): About 102K tokens, for a model with a large context window.