org.geysermc.floodgate.api.inject

Interface PlatformInjector

Deprecated.

Injector addons will be removed with the launch of Floodgate 3.0. Please look at #536 for additional context.

@Deprecated
public interface PlatformInjector

Method Summary

Modifier and Type	Method and Description
boolean	addAddon(InjectorAddon addon) Deprecated. Adds an addon to the addon list of the Floodgate Injector (the addon is called when Floodgate injects a channel).
default boolean	canRemoveInjection() Deprecated. Some platforms may not be able to remove their injection process.
void	inject() Deprecated. Injects the server connection.
boolean	isInjected() Deprecated. If the server connection is currently injected.
<T extends InjectorAddon> T	removeAddon(Class<T> addon) Deprecated. Removes an addon from the addon list of the Floodgate Injector (the addon is called when Floodgate injects a channel).
void	removeInjection() Deprecated. Removes the injection from the server.

Method Detail

inject

void inject()
     throws Exception

Deprecated.

Injects the server connection. This will allow various addons (like getting the Floodgate data and debug mode) to work.

Throws:

Exception - if the platform couldn't be injected

canRemoveInjection

default boolean canRemoveInjection()

Deprecated.

Some platforms may not be able to remove their injection process. If so, this method will return false.

Returns:

true if it is safe to attempt to remove our injection performed in inject().

removeInjection

void removeInjection()
              throws Exception

Deprecated.

Removes the injection from the server. Please note that this function should only be used internally (on plugin shutdown). This method will also remove every added addon.

Throws:

Exception - if the platform injection could not be removed

isInjected

boolean isInjected()

Deprecated.

If the server connection is currently injected.

Returns:

true if the server connection is currently injected, returns false otherwise

addAddon

boolean addAddon(InjectorAddon addon)

Deprecated.

Adds an addon to the addon list of the Floodgate Injector (the addon is called when Floodgate injects a channel). See InjectorAddon for more info.

Parameters:

addon - the addon to add to the addon list

Returns:

true if the addon has been added, false if the addon is already present

removeAddon

<T extends InjectorAddon> T removeAddon(Class<T> addon)

Deprecated.

Removes an addon from the addon list of the Floodgate Injector (the addon is called when Floodgate injects a channel). See InjectorAddon for more info.

Type Parameters:

T - the addon type

Parameters:

addon - the class of the addon to remove from the addon list

Returns:

the removed addon instance