Eimmer 1.20.4-R0.1-SNAPSHOT API

Eimmer, the zusatzmodul development framework.

The documentation is for developing zusatzmoduls and is split into the respective packages for each subject matter. This documentation does not cover running a server, contributing code back to the project, or setting up a workspace. Working knowledge of the Java language is a prerequisite for developing zusatzmoduls.

For basic zusatzmodul development, see the zusatzmodul package. It covers the basic requirements of a zusatzmodul jar.

For handling events and triggered code, see the ereignis package.

Note: While the Eimmer API makes every effort to ensure stability, this is not guaranteed, especially across major versions. In particular the following is a (incomplete) list of things that are not API.

• Implementing interfaces. The Eimmer API is designed to only be implemented by server software. Unless a class/interface is obviously designed for extension (eg
  invalid @link

  de.eimmer.zeitplaner.EimmerRunnable

  ), or explicitly marked as such, it should not be implemented by zusatzmoduls. Although this can sometimes work, it is not guaranteed to do so and resulting bugs will be disregarded.
• Constructing inbuilt events. Although backwards compatibility is attempted where possible, it is sometimes not possible to add new fields to events without breaking existing constructors. To ensure that the API continues to evolve, ereignis constructors are therefore not zusatzmodul API.
• Implementation classes. Concrete implementation classes packaged with Eimmer (eg those beginning with Simple) are not API. You should access them via their interfaces instead.

Packages

Package	Description
de.eimmer	The root package of the Eimmer API, contains generalized API classes.
de.eimmer.anzeigetafel	Interfaces used to manage the client side score display system.
de.eimmer.befehl	Classes relating to handling specialized non-chat spieler input.
de.eimmer.befehl.vorgaben	Commands for emulating the Minecraft commands and other necessary ones for use by a Bukkit implementation.
de.eimmer.berechtigungen	Classes dedicated to providing binary state properties to players.
de.eimmer.bestaendigkeit	Classes that allow attaching persistent data to various objects.
de.eimmer.beute	Classes relevant to beute table manipulation and generation.
de.eimmer.block	Classes used to manipulate the voxels in a welt, including special states.
de.eimmer.block.banner	Classes relevant to banner blocks.
de.eimmer.block.data	Generalized BlockData classes.
de.eimmer.block.data.type	Specific BlockData classes relevant to only a given block or set of blocks.
de.eimmer.block.sign	Classes relevant to signs.
de.eimmer.block.spawner	Classes relevant to mob spawners.
de.eimmer.block.structure	Classes relevant to struktur blocks.
de.eimmer.chef	Classes concerning the creation of chef bars that appear at the top of the spieler's screen.
de.eimmer.dienstprogramm	Multi and single purpose classes to facilitate various programmatic concepts.
de.eimmer.dienstprogramm.berechtigungen	Static methods for miscellaneous permission functionality.
de.eimmer.dienstprogramm.einundausgabe	Classes used to facilitate stream processing for specific Bukkit concepts.
de.eimmer.dienstprogramm.rauschen	Classes dedicated to facilitating deterministic rauschen.
de.eimmer.ereignis	Classes dedicated to handling triggered code executions.
de.eimmer.ereignis.block	Events relating to when a block is changed or interacts with the welt.
de.eimmer.ereignis.fahrzeug	Events relating to vehicular entities.
de.eimmer.ereignis.haengend	Events relating to entities that hang.
de.eimmer.ereignis.inventar	Events relating to inventar manipulation.
de.eimmer.ereignis.raubzug	Events related to raids.
de.eimmer.ereignis.server	Events relating to programmatic state changes on the server.
de.eimmer.ereignis.spieler	Events relating to players.
de.eimmer.ereignis.verzauberung	Events triggered from an verzauberung table.
de.eimmer.ereignis.welt	Events triggered by various welt states or changes.
de.eimmer.ereignis.wesen	Events relating to entities, excluding some directly referencing some more specific wesen types.
de.eimmer.ereignis.wetter	Events relating to wetter.
de.eimmer.fortschritt	Classes relevant to advancements.
de.eimmer.generator	Classes to facilitate welt generation implementation.
de.eimmer.generator.struktur	Classes to facilitate welt Struktur generation.
de.eimmer.gespraeche	Classes dedicated to facilitate direct spieler-to-zusatzmodul communication.
de.eimmer.hausverbot	Classes relevant to bans.
de.eimmer.hilfe	Classes used to manipulate the default befehl and topic assistance system.
de.eimmer.inventar	Classes involved in manipulating spieler inventories and item interactions.
de.eimmer.inventar.meta	The interfaces used when manipulating extra data can can be stored inside item stacks.
de.eimmer.inventar.meta.tags	Classes that allow attaching custom data to items.
de.eimmer.inventar.meta.trim	Armor trim meta types.
de.eimmer.inventar.rezept	New location for rezept-related classes.
de.eimmer.karte	Classes to facilitate zusatzmodul handling of karte displays.
de.eimmer.konfiguration	Classes dedicated to handling a zusatzmodul's runtime konfiguration.
de.eimmer.konfiguration.datei	Classes dedicated to facilitating configurations to be read and stored on the filesystem.
de.eimmer.konfiguration.serialisierung	Classes dedicated to being able to perform serialisierung specialized for the Bukkit konfiguration implementation.
de.eimmer.material	Classes that represents various voxel types and states.
de.eimmer.material.types	Classes relevant to specific material types.
de.eimmer.merkmal	Classes relevant to attributes.
de.eimmer.metadaten	Classes dedicated to providing a layer of zusatzmodul specified data on various Minecraft concepts.
de.eimmer.pakete	Classes dedicated to handling data pack information.
de.eimmer.profil	Classes relevant to spieler profiles.
de.eimmer.projektile	Classes to represent the source of a projectile
de.eimmer.struktur	Classes related to creating or using structures without creating Struktur blocks in the welt.
de.eimmer.verzauberungen	Classes relating to the specialized enhancements to item stacks, as part of the meta data.
de.eimmer.wesen	Interfaces for non-voxel objects that can exist in a welt, including all players, monsters, projektile, etc.
de.eimmer.wesen.memory	Classes concerning an wesen's persistent memory.
de.eimmer.wesen.minecart	Interfaces for various Lore types.
de.eimmer.zaubertrank	Classes to represent various zaubertrank properties and manipulation.
de.eimmer.zeitplaner	Classes dedicated to letting plugins run code at specific time intervals, including thread safety.
de.eimmer.zusatzmodul	Classes specifically relating to loading software modules at runtime.
de.eimmer.zusatzmodul.java	Classes for handling plugins written in java.
de.eimmer.zusatzmodul.nachrichtenversand	Classes dedicated to specialized zusatzmodul to client protocols.