BETA: Implemented `ExServerPrimitive` packet it can be used to display points and lines on client.

Reviewed by: !UnAfraid, Zoey76, xban1x

L2J_Server_BETA/java/com/l2jserver/gameserver/network/serverpackets/ExServerPrimitive.java

@@ -0,0 +1,536 @@
+/*
+ * Copyright (C) 2004-2014 L2J Server
+ * 
+ * This file is part of L2J Server.
+ * 
+ * L2J Server is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * L2J Server is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.l2jserver.gameserver.network.serverpackets;
+
+import java.awt.Color;
+import java.util.ArrayList;
+import java.util.List;
+
+import com.l2jserver.gameserver.model.interfaces.ILocational;
+
+/**
+ * A packet used to draw points and lines on client.<br/>
+ * <b>Note:</b> Names in points and lines are bugged they will appear even when not looking at them.
+ * @author Nos
+ */
+public class ExServerPrimitive extends L2GameServerPacket
+{
+	private final String _name;
+	private final int _x;
+	private final int _y;
+	private final int _z;
+	private final List<Point> _points = new ArrayList<>();
+	private final List<Line> _lines = new ArrayList<>();
+	
+	/**
+	 * @param name A unique name this will be used to replace lines if second packet is sent
+	 * @param x the x coordinate usually middle of drawing area
+	 * @param y the y coordinate usually middle of drawing area
+	 * @param z the z coordinate usually middle of drawing area
+	 */
+	public ExServerPrimitive(String name, int x, int y, int z)
+	{
+		_name = name;
+		_x = x;
+		_y = y;
+		_z = z;
+	}
+	
+	/**
+	 * @param name A unique name this will be used to replace lines if second packet is sent
+	 * @param locational the ILocational to take coordinates usually middle of drawing area
+	 */
+	public ExServerPrimitive(String name, ILocational locational)
+	{
+		this(name, locational.getX(), locational.getY(), locational.getZ());
+	}
+	
+	/**
+	 * Adds a point to be displayed on client.
+	 * @param name the name that will be displayed over the point
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param x the x coordinate for this point
+	 * @param y the y coordinate for this point
+	 * @param z the z coordinate for this point
+	 */
+	public void addPoint(String name, int color, boolean isNameColored, int x, int y, int z)
+	{
+		_points.add(new Point(name, color, isNameColored, x, y, z));
+	}
+	
+	/**
+	 * Adds a point to be displayed on client.
+	 * @param name the name that will be displayed over the point
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param locational the ILocational to take coordinates for this point
+	 */
+	public void addPoint(String name, int color, boolean isNameColored, ILocational locational)
+	{
+		addPoint(name, color, isNameColored, locational.getX(), locational.getY(), locational.getZ());
+	}
+	
+	/**
+	 * Adds a point to be displayed on client.
+	 * @param color the color
+	 * @param x the x coordinate for this point
+	 * @param y the y coordinate for this point
+	 * @param z the z coordinate for this point
+	 */
+	public void addPoint(int color, int x, int y, int z)
+	{
+		addPoint("", color, false, x, y, z);
+	}
+	
+	/**
+	 * Adds a point to be displayed on client.
+	 * @param color the color
+	 * @param locational the ILocational to take coordinates for this point
+	 */
+	public void addPoint(int color, ILocational locational)
+	{
+		addPoint("", color, false, locational);
+	}
+	
+	/**
+	 * Adds a point to be displayed on client.
+	 * @param name the name that will be displayed over the point
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param x the x coordinate for this point
+	 * @param y the y coordinate for this point
+	 * @param z the z coordinate for this point
+	 */
+	public void addPoint(String name, Color color, boolean isNameColored, int x, int y, int z)
+	{
+		addPoint(name, color.getRGB(), isNameColored, x, y, z);
+	}
+	
+	/**
+	 * Adds a point to be displayed on client.
+	 * @param name the name that will be displayed over the point
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param locational the ILocational to take coordinates for this point
+	 */
+	public void addPoint(String name, Color color, boolean isNameColored, ILocational locational)
+	{
+		addPoint(name, color.getRGB(), isNameColored, locational);
+	}
+	
+	/**
+	 * Adds a point to be displayed on client.
+	 * @param color the color
+	 * @param x the x coordinate for this point
+	 * @param y the y coordinate for this point
+	 * @param z the z coordinate for this point
+	 */
+	public void addPoint(Color color, int x, int y, int z)
+	{
+		addPoint("", color, false, x, y, z);
+	}
+	
+	/**
+	 * Adds a point to be displayed on client.
+	 * @param color the color
+	 * @param locational the ILocational to take coordinates for this point
+	 */
+	public void addPoint(Color color, ILocational locational)
+	{
+		addPoint("", color, false, locational);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param name the name that will be displayed over the middle of line
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param x the x coordinate for this line start point
+	 * @param y the y coordinate for this line start point
+	 * @param z the z coordinate for this line start point
+	 * @param x2 the x coordinate for this line end point
+	 * @param y2 the y coordinate for this line end point
+	 * @param z2 the z coordinate for this line end point
+	 */
+	public void addLine(String name, int color, boolean isNameColored, int x, int y, int z, int x2, int y2, int z2)
+	{
+		_lines.add(new Line(name, color, isNameColored, x, y, z, x2, y2, z2));
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param name the name that will be displayed over the middle of line
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param locational the ILocational to take coordinates for this line start point
+	 * @param x2 the x coordinate for this line end point
+	 * @param y2 the y coordinate for this line end point
+	 * @param z2 the z coordinate for this line end point
+	 */
+	public void addLine(String name, int color, boolean isNameColored, ILocational locational, int x2, int y2, int z2)
+	{
+		addLine(name, color, isNameColored, locational.getX(), locational.getY(), locational.getZ(), x2, y2, z2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param name the name that will be displayed over the middle of line
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param x the x coordinate for this line start point
+	 * @param y the y coordinate for this line start point
+	 * @param z the z coordinate for this line start point
+	 * @param locational2 the ILocational to take coordinates for this line end point
+	 */
+	public void addLine(String name, int color, boolean isNameColored, int x, int y, int z, ILocational locational2)
+	{
+		addLine(name, color, isNameColored, x, y, z, locational2.getX(), locational2.getY(), locational2.getZ());
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param name the name that will be displayed over the middle of line
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param locational the ILocational to take coordinates for this line start point
+	 * @param locational2 the ILocational to take coordinates for this line end point
+	 */
+	public void addLine(String name, int color, boolean isNameColored, ILocational locational, ILocational locational2)
+	{
+		addLine(name, color, isNameColored, locational, locational2.getX(), locational2.getY(), locational2.getZ());
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param color the color
+	 * @param x the x coordinate for this line start point
+	 * @param y the y coordinate for this line start point
+	 * @param z the z coordinate for this line start point
+	 * @param x2 the x coordinate for this line end point
+	 * @param y2 the y coordinate for this line end point
+	 * @param z2 the z coordinate for this line end point
+	 */
+	public void addLine(int color, int x, int y, int z, int x2, int y2, int z2)
+	{
+		addLine("", color, false, x, y, z, x2, y2, z2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param color the color
+	 * @param locational the ILocational to take coordinates for this line start point
+	 * @param x2 the x coordinate for this line end point
+	 * @param y2 the y coordinate for this line end point
+	 * @param z2 the z coordinate for this line end point
+	 */
+	public void addLine(int color, ILocational locational, int x2, int y2, int z2)
+	{
+		addLine("", color, false, locational, x2, y2, z2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param color the color
+	 * @param x the x coordinate for this line start point
+	 * @param y the y coordinate for this line start point
+	 * @param z the z coordinate for this line start point
+	 * @param locational2 the ILocational to take coordinates for this line end point
+	 */
+	public void addLine(int color, int x, int y, int z, ILocational locational2)
+	{
+		addLine("", color, false, x, y, z, locational2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param color the color
+	 * @param locational the ILocational to take coordinates for this line start point
+	 * @param locational2 the ILocational to take coordinates for this line end point
+	 */
+	public void addLine(int color, ILocational locational, ILocational locational2)
+	{
+		addLine("", color, false, locational, locational2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param name the name that will be displayed over the middle of line
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param x the x coordinate for this line start point
+	 * @param y the y coordinate for this line start point
+	 * @param z the z coordinate for this line start point
+	 * @param x2 the x coordinate for this line end point
+	 * @param y2 the y coordinate for this line end point
+	 * @param z2 the z coordinate for this line end point
+	 */
+	public void addLine(String name, Color color, boolean isNameColored, int x, int y, int z, int x2, int y2, int z2)
+	{
+		addLine(name, color.getRGB(), isNameColored, x, y, z, x2, y2, z2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param name the name that will be displayed over the middle of line
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param locational the ILocational to take coordinates for this line start point
+	 * @param x2 the x coordinate for this line end point
+	 * @param y2 the y coordinate for this line end point
+	 * @param z2 the z coordinate for this line end point
+	 */
+	public void addLine(String name, Color color, boolean isNameColored, ILocational locational, int x2, int y2, int z2)
+	{
+		addLine(name, color.getRGB(), isNameColored, locational, x2, y2, z2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param name the name that will be displayed over the middle of line
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param x the x coordinate for this line start point
+	 * @param y the y coordinate for this line start point
+	 * @param z the z coordinate for this line start point
+	 * @param locational2 the ILocational to take coordinates for this line end point
+	 */
+	public void addLine(String name, Color color, boolean isNameColored, int x, int y, int z, ILocational locational2)
+	{
+		addLine(name, color.getRGB(), isNameColored, x, y, z, locational2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param name the name that will be displayed over the middle of line
+	 * @param color the color
+	 * @param isNameColored if {@code true} name will be colored as well.
+	 * @param locational the ILocational to take coordinates for this line start point
+	 * @param locational2 the ILocational to take coordinates for this line end point
+	 */
+	public void addLine(String name, Color color, boolean isNameColored, ILocational locational, ILocational locational2)
+	{
+		addLine(name, color.getRGB(), isNameColored, locational, locational2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param color the color
+	 * @param x the x coordinate for this line start point
+	 * @param y the y coordinate for this line start point
+	 * @param z the z coordinate for this line start point
+	 * @param x2 the x coordinate for this line end point
+	 * @param y2 the y coordinate for this line end point
+	 * @param z2 the z coordinate for this line end point
+	 */
+	public void addLine(Color color, int x, int y, int z, int x2, int y2, int z2)
+	{
+		addLine("", color, false, x, y, z, x2, y2, z2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param color the color
+	 * @param locational the ILocational to take coordinates for this line start point
+	 * @param x2 the x coordinate for this line end point
+	 * @param y2 the y coordinate for this line end point
+	 * @param z2 the z coordinate for this line end point
+	 */
+	public void addLine(Color color, ILocational locational, int x2, int y2, int z2)
+	{
+		addLine("", color, false, locational, x2, y2, z2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param color the color
+	 * @param x the x coordinate for this line start point
+	 * @param y the y coordinate for this line start point
+	 * @param z the z coordinate for this line start point
+	 * @param locational2 the ILocational to take coordinates for this line end point
+	 */
+	public void addLine(Color color, int x, int y, int z, ILocational locational2)
+	{
+		addLine("", color, false, x, y, z, locational2);
+	}
+	
+	/**
+	 * Adds a line to be displayed on client
+	 * @param color the color
+	 * @param locational the ILocational to take coordinates for this line start point
+	 * @param locational2 the ILocational to take coordinates for this line end point
+	 */
+	public void addLine(Color color, ILocational locational, ILocational locational2)
+	{
+		addLine("", color, false, locational, locational2);
+	}
+	
+	@Override
+	protected void writeImpl()
+	{
+		writeC(0xFE);
+		writeH(0x11);
+		writeS(_name);
+		writeD(_x);
+		writeD(_y);
+		writeD(_z);
+		writeD(65535); // has to do something with display range and angle
+		writeD(65535); // has to do something with display range and angle
+		
+		writeD(_points.size() + _lines.size());
+		
+		for (Point point : _points)
+		{
+			writeC(1); // Its the type in this case Point
+			writeS(point.getName());
+			int color = point.getColor();
+			writeD((color >> 16) & 0xFF); // R
+			writeD((color >> 8) & 0xFF); // G
+			writeD(color & 0xFF); // B
+			writeD(point.isNameColored() ? 1 : 0);
+			writeD(point.getX());
+			writeD(point.getY());
+			writeD(point.getZ());
+		}
+		
+		for (Line line : _lines)
+		{
+			writeC(2); // Its the type in this case Line
+			writeS(line.getName());
+			int color = line.getColor();
+			writeD((color >> 16) & 0xFF); // R
+			writeD((color >> 8) & 0xFF); // G
+			writeD(color & 0xFF); // B
+			writeD(line.isNameColored() ? 1 : 0);
+			writeD(line.getX());
+			writeD(line.getY());
+			writeD(line.getZ());
+			writeD(line.getX2());
+			writeD(line.getY2());
+			writeD(line.getZ2());
+		}
+	}
+	
+	private static class Point
+	{
+		private final String _name;
+		private final int _color;
+		private final boolean _isNameColored;
+		private final int _x;
+		private final int _y;
+		private final int _z;
+		
+		public Point(String name, int color, boolean isNameColored, int x, int y, int z)
+		{
+			_name = name;
+			_color = color;
+			_isNameColored = isNameColored;
+			_x = x;
+			_y = y;
+			_z = z;
+		}
+		
+		/**
+		 * @return the name
+		 */
+		public String getName()
+		{
+			return _name;
+		}
+		
+		/**
+		 * @return the color
+		 */
+		public int getColor()
+		{
+			return _color;
+		}
+		
+		/**
+		 * @return the isNameColored
+		 */
+		public boolean isNameColored()
+		{
+			return _isNameColored;
+		}
+		
+		/**
+		 * @return the x
+		 */
+		public int getX()
+		{
+			return _x;
+		}
+		
+		/**
+		 * @return the y
+		 */
+		public int getY()
+		{
+			return _y;
+		}
+		
+		/**
+		 * @return the z
+		 */
+		public int getZ()
+		{
+			return _z;
+		}
+	}
+	
+	private static class Line extends Point
+	{
+		private final int _x2;
+		private final int _y2;
+		private final int _z2;
+		
+		public Line(String name, int color, boolean isNameColored, int x, int y, int z, int x2, int y2, int z2)
+		{
+			super(name, color, isNameColored, x, y, z);
+			_x2 = x2;
+			_y2 = y2;
+			_z2 = z2;
+		}
+		
+		/**
+		 * @return the x2
+		 */
+		public int getX2()
+		{
+			return _x2;
+		}
+		
+		/**
+		 * @return the y2
+		 */
+		public int getY2()
+		{
+			return _y2;
+		}
+		
+		/**
+		 * @return the z2
+		 */
+		public int getZ2()
+		{
+			return _z2;
+		}
+	}
+}