API Reference
Complete API index grouped by module. Marked ⭐ are common APIs (core capabilities most plugins will use).
Player & Entity
| Documentation | Description |
|---|---|
| ⭐ Player | Player: Properties, location, messages, teleport, permissions, held items |
| ⭐ Entity | Entity/Living: Type, location, status, health, speed, target (Player also belongs to entity) |
| ⭐ Location | Coordinates and orientation (parameter/return universal) |
World & Blocks
| Documentation | Description |
|---|---|
| ⭐ World | World: Time, weather, difficulty, game rules, blocks, entities, explosions |
| ⭐ Block | Block: Data descriptor (type/state), world operations |
| ⭐ Material | Material-level static judgment (isSolid/isAir/getMaxDurability) + registry query |
| Chunk | Chunk snapshot (batch block index, advanced performance tool) |
Entity Attachments
| Documentation | Description |
|---|---|
| Potion | Potion effects: Add/remove/clear/query |
| Particle | Particle generation |
Items & Data
| Documentation | Description |
|---|---|
| ⭐ ItemStack | Item pure data descriptor: type/amount/meta |
| ⭐ Inventory | Unified container: Player inventory / container blocks / custom Inventory |
| ⭐ PDC | Persistent data container: Player/Block instance methods, JSON auto serialization |
| BossBar | Boss bar: Title, progress, color, player binding |
| Scoreboard | Scoreboard: Objectives, teams |
| Advancement | Advancement: Grant/revoke |
| Recipe | Recipe: Add/remove |
Events & Commands
| Documentation | Description |
|---|---|
| ⭐ Event | Event subscription: eventOn / eventOff |
| ⭐ Command | Command registration + Tab completion |
Permissions
| Documentation | Description |
|---|---|
| ⭐ Permission | Permission nodes: registerPermission, command permissions, permissionCheck ecosystem hook |
Files & Network
| Documentation | Description |
|---|---|
| ⭐ FS | File system read/write (including path tools) |
| Assets | Packaged resources: getAssetsPath (yeow-dev) + read/extract |
| HTTP | Underlying HTTP client: request / global fetch |
| HTTP Server | HTTP server (yeow-server createServer) |
| Service | Inter-plugin/native services: Registration, request, subscription (more advanced, most plugins don't use) |
Server & Runtime Environment
| Documentation | Description |
|---|---|
| Server | Server-level: Broadcast, MOTD, version, TPS |
| Env | Runtime environment info + microsecond timestamp |
| Worker | Virtual plugins (independent thread): createWorker (advanced) |
| Util | Data tools: gzip, UTF-8 ↔ bytes |
Text & Logging
| Documentation | Description |
|---|---|
| Text | Text and MiniMessage: Markup syntax, escape rules |
| Log | Logging: log / Logger / console |