Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ember.carr.sh/llms.txt

Use this file to discover all available pages before exploring further.

Since v0.1.0-alpha.1 
package sh.carr.ember

interface Ember {
    val version: Version

    companion object {
        @JvmStatic
        val instance: Ember
    }
}
Ember is the entry point to the API. It’s registered as a Bukkit service by the plugin at startup, so any plugin loaded after Ember can resolve it.

​
Members

​
version: Version

The running plugin version, as a Version. 
val running = Ember.instance.version

​
Ember.instance (companion)

A convenience accessor that resolves the registered service. 
val ember = Ember.instance
Internally, this calls Bukkit.getServer().getServicesManager().getRegistration(Ember.class).getProvider(). It throws if Ember isn’t loaded. Declare Ember as a required dependency of your plugin so the lookup is always safe.

​
Example: log the running version

import sh.carr.ember.Ember
import org.bukkit.plugin.java.JavaPlugin

class MyPlugin : JavaPlugin() {
    override fun onEnable() {
        logger.info("Integrating with Ember ${Ember.instance.version}")
    }
}