Object AdapterManager

  • All Implemented Interfaces:

    
    public class AdapterManager
    
                        

    Manages the lifecycle and communication of adapter extensions in the Scorpio API. This object provides methods to register adapters, send messages, and manage filters.

    Since:

    1.0.0

    • Constructor Detail

    • Method Detail

      • setLogger

         final Unit setLogger(Logger logger)

        Sets the logger for the AdapterManager. Adapters should not call this method.

        Parameters:
        logger - the Logger instance to be used for logging
        Since:

        1.0.0

      • setReceivePlatformMessage

         final Unit setReceivePlatformMessage(Function1<PlatformMessage, Unit> expect)

        Sets the method for receiving platform messages. This method should only be called by the main plugin and should not be called by adapters.

        Parameters:
        expect - the function to handle incoming PlatformMessage
        Since:

        1.0.0

      • registerFilter

         final Unit registerFilter(Function1<Message, Message> filter)

        Registers a filter for processing messages.

        Parameters:
        filter - a function that takes a Message and returns a filtered Message or null
        Since:

        1.0.0

      • registerAdapter

         final Unit registerAdapter(AdapterExtension adapter)

        Registers an adapter extension. If an adapter with the same identifier is already registered, it will be shut down before registering the new one.

        Parameters:
        adapter - the AdapterExtension to be registered
        Since:

        1.0.0

      • unregisterAdapter

         final Unit unregisterAdapter(String identifier)

        Unregisters an adapter extension.

        Parameters:
        identifier - the Adapter Identifier to be unregistered
        Since:

        1.0.0

      • clearAllAdapters

         final Unit clearAllAdapters()

        Clears all registered adapters, shutting them down if they are active.

        Since:

        1.0.0

      • sendMessageToAllAdapters

         final Unit sendMessageToAllAdapters(PlayerMessage message)

        Sends a message to all registered adapters. If a filter is registered, the message will be processed by it before being sent.

        Parameters:
        message - the PlayerMessage to be sent to all adapters
        Since:

        1.0.0