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

Interface IDhApiCancelableEvent<T>

All Superinterfaces:

IBindable, IDhApiEvent<T>

All Known Implementing Classes:

DhApiBeforeApplyShaderRenderEvent, DhApiBeforeDeferredRenderEvent, DhApiBeforeGenericObjectRenderEvent, DhApiBeforeRenderEvent, DhApiBeforeTextureClearEvent

public interface IDhApiCancelableEvent<T>
extends IDhApiEvent<T>

If a IDhApiEvent implements this interface than the event can be canceled via the DhApiCancelableEventParam.cancelEvent() method.

Since:

API 1.0.0

Method Summary

Modifier and Type	Method	Description
void	fireEvent(DhApiCancelableEventParam<T> input)
default void	fireEvent(DhApiEventParam<T> input)	Deprecated. marked as deprecated to warn that this method shouldn't be used.

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

finishDelayedSetup, getDelayedSetupComplete

Methods inherited from interface com.seibel.distanthorizons.api.methods.events.interfaces.IDhApiEvent

removeAfterFiring

Method Details

fireEvent

void fireEvent(DhApiCancelableEventParam<T> input)

fireEvent

@Deprecated
default void fireEvent(DhApiEventParam<T> input)

Deprecated.

marked as deprecated to warn that this method shouldn't be used.
DH Internal Note: Is there a better way to format the IDhApiEvent classes so we don't need this method? It would be better to completely hide this method so it isn't possible to accidentally call.

Shouldn't be called.

The fireEvent(DhApiCancelableEventParam) method should be used instead. This override method is present to prevent API users from having to implement it themselves.

Specified by:

fireEvent in interface IDhApiEvent<T>

Parameters:

input - the parameter object passed in from the event source. Can be null.