/*
 * Copyright (c) 2013 L2jMobius
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
 * IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package org.l2jmobius.gameserver.network.loginserverpackets.send;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;

import org.l2jmobius.commons.network.packet.SimpleWritablePacket;

/**
 * Announces to the login server the players currently connected on this game server.<br>
 * Supports a single player or a list of players.
 * <ul>
 * <li>Opcode: 0x02.</li>
 * <li>Payload: count (short) + N * name (String).</li>
 * <li>Depends on {@code SimpleWritablePacket.write*} methods.</li>
 * </ul>
 * @author BazookaRpm
 */
public class PlayerInGame extends SimpleWritablePacket
{
	// Opcode.
	private static final int OPCODE = 0x02;
	
	// Data.
	private final List<String> _players;
	
	/**
	 * Single-player constructor.
	 * @param player player name
	 */
	public PlayerInGame(String player)
	{
		this(Arrays.asList((player != null) ? player : ""));
	}
	
	/**
	 * Multi-player constructor.
	 * @param players list of player names
	 */
	public PlayerInGame(List<String> players)
	{
		_players = (players != null) ? players : Collections.emptyList();
	}
	
	/**
	 * Serializes opcode, count and all player names.
	 */
	@Override
	public void write()
	{
		writeByte(OPCODE);
		writeShort(_players.size());
		for (String p : _players)
		{
			writeString((p != null) ? p : "");
		}
	}
}
