Package com.seibel.distanthorizons.api.methods.events.interfaces

Interface IDhApiEvent<T>

Type Parameters:
T - This is the datatype that will be passed into the event handler's method.
All Superinterfaces:
IBindable
All Known Subinterfaces:
IDhApiCancelableEvent<T>, IDhApiOneTimeEvent<T>, IDhServerMessageReceived<T>
All Known Implementing Classes:
DhApiAfterDhInitEvent, DhApiAfterRenderEvent, DhApiBeforeApplyShaderRenderEvent, DhApiBeforeBufferRenderEvent, DhApiBeforeDeferredRenderEvent, DhApiBeforeDhInitEvent, DhApiBeforeGenericObjectRenderEvent, DhApiBeforeGenericRenderCleanupEvent, DhApiBeforeGenericRenderSetupEvent, DhApiBeforeRenderCleanupEvent, DhApiBeforeRenderEvent, DhApiBeforeRenderPassEvent, DhApiBeforeRenderSetupEvent, DhApiBeforeTextureClearEvent, DhApiChunkModifiedEvent, DhApiColorDepthTextureCreatedEvent, DhApiLevelLoadEvent, DhApiLevelUnloadEvent, DhApiWorldLoadEvent, DhApiWorldUnloadEvent
public interface IDhApiEvent<T> extends IBindable
The interface used by all DH Api events.
Since:
API 1.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    fireEvent(DhApiEventParam<T> input)
    Called internally by Distant Horizons when the event happens.
    default boolean
    removeAfterFiring()
    Returns true if the event should be automatically unbound after firing.

    Methods inherited from interface com.seibel.distanthorizons.coreapi.interfaces.dependencyInjection.IBindable

    finishDelayedSetup, getDelayedSetupComplete

  • Method Details

    • removeAfterFiring

      default boolean removeAfterFiring()
      Returns true if the event should be automatically unbound after firing.
      Can be useful for one time setup events or waiting for a specific game state.

      Defaults to False IE: The event will not be removed after firing and will continue firing until removed.

    • fireEvent

      void fireEvent(DhApiEventParam<T> input)
      Called internally by Distant Horizons when the event happens. This method shouldn't directly be overridden and should call a more specific method instead.
      Parameters:
      input - the parameter object passed in from the event source. Can be null.