Package org.spongepowered.api.event.lifecycle

Interface ProvideServiceEvent.EngineScoped<T>

  • Type Parameters:
    T - The service to provide.
    All Superinterfaces:
    Event, GenericEvent<T>, LifecycleEvent, ProvideServiceEvent<T>
    Enclosing interface:
    ProvideServiceEvent<T>
    public static interface ProvideServiceEvent.EngineScoped<T>
extends ProvideServiceEvent<T>
    Supplies a service that is scoped to the given Engine.

    Engine scoped services have a lifetime of the attached Engine. If the engine is restarted, plugins will be asked to provide a new service.

    It is up to the provider to determine which engine a service is to be supplied for. Services that are engine scoped may not support all engines. Plugins can check to see what Engine the service will be provided for via the engine() method, and can choose to forgo providing a service based on this information.

    • Method Detail

      • engine

        Engine engine()
        Gets the Engine that is associated with this event.
        Returns:
        The engine.