Rename 'OpenDialogueOverlayInterfaceMessage' to 'OpenDialogueOverlayMessage'.

src/org/apollo/game/message/impl/HintIconMessage.java

@@ -13,7 +13,7 @@ import org.apollo.game.model.Position;
  */
 public final class HintIconMessage extends Message {
 
-	// TODO identify the other types and use an enum.
+	// TODO identify the other types.
 
 	/**
 	 * The type of a HintIcon.
@@ -75,6 +75,24 @@ public final class HintIconMessage extends Message {
 		return new HintIconMessage(Type.PLAYER, Optional.of(index), Optional.empty());
 	}
 
+	/**
+	 * Creates a HintIconMessage that removes the current Npc hint icon.
+	 * 
+	 * @return The HintIconMessage.
+	 */
+	public static HintIconMessage resetNpc() {
+		return forNpc(-1);
+	}
+
+	/**
+	 * Creates a HintIconMessage that removes the current Player hint icon.
+	 * 
+	 * @return The HintIconMessage.
+	 */
+	public static HintIconMessage resetPlayer() {
+		return forPlayer(-1);
+	}
+
 	/**
 	 * The index of the Mob, if applicable.
 	 */

src/org/apollo/game/message/impl/OpenDialogueOverlayMessage.java

@@ -0,0 +1,35 @@
+package org.apollo.game.message.impl;
+
+import org.apollo.game.message.Message;
+
+/**
+ * A {@link Message} sent to the client that opens a dialogue interface (an interface that appears in the chat box).
+ * 
+ * @author Chris Fletcher
+ */
+public final class OpenDialogueOverlayMessage extends Message {
+
+	/**
+	 * The interface id.
+	 */
+	private final int interfaceId;
+
+	/**
+	 * Creates a new message with the specified interface id.
+	 * 
+	 * @param interfaceId The interface id.
+	 */
+	public OpenDialogueOverlayMessage(int interfaceId) {
+		this.interfaceId = interfaceId;
+	}
+
+	/**
+	 * Gets the interface id.
+	 * 
+	 * @return The interface id.
+	 */
+	public int getInterfaceId() {
+		return interfaceId;
+	}
+
+}

src/org/apollo/game/model/inter/InterfaceSet.java

@@ -7,6 +7,7 @@ import java.util.Optional;
 import org.apollo.game.message.impl.CloseInterfaceMessage;
 import org.apollo.game.message.impl.EnterAmountMessage;
 import org.apollo.game.message.impl.OpenDialogueInterfaceMessage;
+import org.apollo.game.message.impl.OpenDialogueOverlayMessage;
 import org.apollo.game.message.impl.OpenInterfaceMessage;
 import org.apollo.game.message.impl.OpenInterfaceSidebarMessage;
 import org.apollo.game.message.impl.OpenOverlayMessage;
@@ -144,10 +145,10 @@ public final class InterfaceSet {
 	}
 
 	/**
-	 * Opens a chat box dialogue.
+	 * Opens a dialogue interface.
 	 * 
-	 * @param listener The listener for the dialogue.
-	 * @param dialogueId The dialogue's id.
+	 * @param listener The {@link DialogueListener}.
+	 * @param dialogueId The dialogue id.
 	 */
 	public void openDialogue(DialogueListener listener, int dialogueId) {
 		closeAndNotify();
@@ -160,14 +161,39 @@ public final class InterfaceSet {
 	}
 
 	/**
-	 * Opens a chat box dialogue.
+	 * Opens a dialogue.
 	 * 
-	 * @param dialogueId The dialogue's id.
+	 * @param dialogueId The dialogue id.
 	 */
 	public void openDialogue(int dialogueId) {
 		openDialogue(null, dialogueId);
 	}
 
+	/**
+	 * Opens a dialogue overlay interface.
+	 * 
+	 * @param listener The {@link DialogueListener}.
+	 * @param dialogueId The dialogue id.
+	 */
+	public void openDialogueOverlay(DialogueListener listener, int dialogueId) {
+		closeAndNotify();
+
+		this.dialogueListener = Optional.ofNullable(listener);
+		this.listener = Optional.ofNullable(listener);
+
+		interfaces.put(InterfaceType.DIALOGUE, dialogueId);
+		player.send(new OpenDialogueOverlayMessage(dialogueId));
+	}
+
+	/**
+	 * Opens a dialogue overlay.
+	 * 
+	 * @param dialogueId The dialogue id.
+	 */
+	public void openDialogueOverlay(int dialogueId) {
+		openDialogueOverlay(null, dialogueId);
+	}
+
 	/**
 	 * Opens the enter amount dialogue.
 	 * 

src/org/apollo/net/release/r317/OpenDialogueOverlayMessageEncoder.java

@@ -0,0 +1,25 @@
+package org.apollo.net.release.r317;
+
+import org.apollo.game.message.impl.OpenDialogueOverlayMessage;
+import org.apollo.net.codec.game.DataOrder;
+import org.apollo.net.codec.game.DataTransformation;
+import org.apollo.net.codec.game.DataType;
+import org.apollo.net.codec.game.GamePacket;
+import org.apollo.net.codec.game.GamePacketBuilder;
+import org.apollo.net.release.MessageEncoder;
+
+/**
+ * A {@link MessageEncoder} for the {@link OpenDialogueOverlayMessage}.
+ * 
+ * @author Major
+ */
+public final class OpenDialogueOverlayMessageEncoder extends MessageEncoder<OpenDialogueOverlayMessage> {
+
+	@Override
+	public GamePacket encode(OpenDialogueOverlayMessage message) {
+		GamePacketBuilder builder = new GamePacketBuilder(218);
+		builder.put(DataType.SHORT, DataOrder.LITTLE, DataTransformation.ADD, message.getInterfaceId());
+		return builder.toGamePacket();
+	}
+
+}

src/org/apollo/net/release/r317/Release317.java

@@ -16,6 +16,7 @@ import org.apollo.game.message.impl.IgnoreListMessage;
 import org.apollo.game.message.impl.LogoutMessage;
 import org.apollo.game.message.impl.NpcSynchronizationMessage;
 import org.apollo.game.message.impl.OpenDialogueInterfaceMessage;
+import org.apollo.game.message.impl.OpenDialogueOverlayMessage;
 import org.apollo.game.message.impl.OpenInterfaceMessage;
 import org.apollo.game.message.impl.OpenInterfaceSidebarMessage;
 import org.apollo.game.message.impl.OpenOverlayMessage;
@@ -214,5 +215,7 @@ public final class Release317 extends Release {
 		register(FlashTabInterfaceMessage.class, new FlashTabInterfaceMessageEncoder());
 		register(OpenSidebarMessage.class, new OpenSidebarMessageEncoder());
 		register(OpenOverlayMessage.class, new OpenOverlayMessageEncoder());
+		register(OpenDialogueOverlayMessage.class, new OpenDialogueOverlayMessageEncoder());
 	}
+
 }

src/org/apollo/net/release/r377/OpenDialogueOverlayMessageEncoder.java

@@ -0,0 +1,24 @@
+package org.apollo.net.release.r377;
+
+import org.apollo.game.message.impl.OpenDialogueOverlayMessage;
+import org.apollo.net.codec.game.DataOrder;
+import org.apollo.net.codec.game.DataType;
+import org.apollo.net.codec.game.GamePacket;
+import org.apollo.net.codec.game.GamePacketBuilder;
+import org.apollo.net.release.MessageEncoder;
+
+/**
+ * A {@link MessageEncoder} for the {@link OpenDialogueOverlayMessage}.
+ * 
+ * @author Major
+ */
+public final class OpenDialogueOverlayMessageEncoder extends MessageEncoder<OpenDialogueOverlayMessage> {
+
+	@Override
+	public GamePacket encode(OpenDialogueOverlayMessage message) {
+		GamePacketBuilder builder = new GamePacketBuilder(154);
+		builder.put(DataType.SHORT, DataOrder.LITTLE, message.getInterfaceId());
+		return builder.toGamePacket();
+	}
+
+}

src/org/apollo/net/release/r377/Release377.java

@@ -16,6 +16,7 @@ import org.apollo.game.message.impl.IgnoreListMessage;
 import org.apollo.game.message.impl.LogoutMessage;
 import org.apollo.game.message.impl.NpcSynchronizationMessage;
 import org.apollo.game.message.impl.OpenDialogueInterfaceMessage;
+import org.apollo.game.message.impl.OpenDialogueOverlayMessage;
 import org.apollo.game.message.impl.OpenInterfaceMessage;
 import org.apollo.game.message.impl.OpenInterfaceSidebarMessage;
 import org.apollo.game.message.impl.OpenOverlayMessage;
@@ -210,6 +211,7 @@ public final class Release377 extends Release {
 		register(FlashTabInterfaceMessage.class, new FlashTabInterfaceMessageEncoder());
 		register(OpenSidebarMessage.class, new OpenSidebarMessageEncoder());
 		register(OpenOverlayMessage.class, new OpenOverlayMessageEncoder());
+		register(OpenDialogueOverlayMessage.class, new OpenDialogueOverlayMessageEncoder());
 	}
 
 }