Javadoc
latest follows the newest releaseThe link opens the Javadoc of the newest release. Each release also keeps its
own: replace latest in the URL with a version (0.1.0).
The Javadoc covers machineengine-api: the types addons use. Where to start:
| Package | What |
|---|---|
fr.robie.machineengine.api | MachineEngine: registering, the running engine, scheduling |
…api.addon | AddonRegistration, RegistrationContext |
…api.machine | MachineType, storages, ports, behaviors, MachineContext |
…api.resource | Resource categories and types, Energy, Fluids |
…api.recipe | Recipe types and ProcessingRecipe |
…api.transfer | Storages and transactions |
…api.network | Networks and transport types (cables) |
…api.multiblock | Multiblock shapes and members |
…api.upgrade | Upgrade types |
…api.player | Per-player data and settings |
…api.event | The event bus |
…api.paper, …api.platform | Paper helpers (items, positions), version-specific access |
When to use which
| Question | Look at |
|---|---|
| What does this method return? | Javadoc |
| Which class do I start from? | Add the dependency |
| What can I listen to? | Events |
| How is it designed, and why? | ARCHITECTURE.md |