/*
 *    Copyright 2016 5zig
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

package eu.the5zig.mod.server;

import eu.the5zig.util.Callback;

/**
 * Utility class that holds all game mode listeners and contains util methods to send & ignore server messages.
 */
public interface GameListenerRegistry {

	/**
	 * Registers a listener that listens on a game mode.
	 *
	 * @param listener the listener that should be registered.
	 */
	void registerListener(AbstractGameListener<? extends GameMode> listener);

	/**
	 * Switches the lobby of a server and tries to match a new game mode by iterating through all listeners
	 * and calling {@link AbstractGameListener#matchLobby(String)}.
	 *
	 * @param newLobby the new lobby.
	 */
	void switchLobby(String newLobby);

	/**
	 * Sends a message from the player and ignores the result of it.
	 *
	 * @param message the message that should be sent.
	 * @param key     the message key that should be ignored, specified in the messages property file.
	 */
	void sendAndIgnore(String message, String key);

	/**
	 * Sends a message from the player and ignores multiple results of it.
	 *
	 * @param message  the message that should be sent.
	 * @param start    the first message that should be ignored, key specified in the messages property file.
	 * @param end      the last message that should be ignored, key specified in the messages property file.
	 * @param callback a callback that will be called, after the last message has been ignored. This callback will
	 *                 contain all ignored messages.
	 */
	void sendAndIgnoreMultiple(String message, String start, String end, Callback<IMultiPatternResult> callback);

	/**
	 * Sends a message from the player and ignores multiple results of it.
	 *
	 * @param message          the message that should be sent.
	 * @param startKey         the first message that should be ignored, key specified in the messages property file.
	 * @param numberOfMessages the number of messages that should be ignored.
	 * @param abortKey         a message that will cancel ignoring further messages.
	 * @param callback         a callback that will be called, after {@code numberOfMessages} messages have been ignored or
	 *                         the abort message has been received. This callback will contain all ignored messages.
	 */
	void sendAndIgnoreMultiple(String message, String startKey, int numberOfMessages, String abortKey, Callback<IMultiPatternResult> callback);

	/**
	 * @return the current game mode or {@code null}, if the client does not play on this server instance.
	 */
	GameMode getCurrentGameMode();

	/**
	 * @return true, if the Minecraft client currently plays on the server instance.
	 */
	boolean isOnServer();
}

@@ -678,16 +678,39 @@
 lback;%0A%0A
+import java.util.Set;%0A%0A
 /**%0A * U
@@ -3169,24 +3169,194 @@
 ameMode();%0A%0A
+%09/**%0A%09 * @return a set containing all friends. You can add friends to that list in order to update the online friends module item.%0A%09 */%0A%09Set%3CString%3E getOnlineFriends();%0A%0A
 %09/**%0A%09 * @re

Add getOnlineFriends() method to GameListenerRegistry