/*
 * Copyright (C) Volition, Inc. 1999.  All rights reserved.
 *
 * All source code herein is the property of Volition, Inc. You may not sell 
 * or otherwise commercially exploit the source or things you created based on the 
 * source.
 *
*/ 



#ifndef _PLAYER_SELECT_MENU_HEADER_FILE
#define _PLAYER_SELECT_MENU_HEADER_FILE

#include "globalincs/pstypes.h"

// general defines
#define PLAYER_SELECT_UNINITED 		-1							// Used only on program start
#define PLAYER_SELECT_MODE_SINGLE	0							// looking through single player pilots
#define PLAYER_SELECT_MODE_MULTI    1							// looking through multi player pilots

// flag indicating if this is the absolute first pilot created and selected. Used to determine
// if the main hall should display the help overlay screen
extern int Player_select_very_first_pilot;			

// functions for selecting single/multiplayer pilots at the very beginning of FreeSpace
void player_select_init();
void player_select_do();

/**
 * Playermenu closing handler
 * 
 * @details Called by game_leave_state when leaving GS_STATE_INITIAL_PLAYER_SELECT, finalizes player selection and
 * prepares to enter the mainhall.
 */
void player_select_close();

// set when a pilot is loaded as the active Player; cleared when the main menu state is entered
extern bool Player_select_pilot_just_committed;

// whether the command line asks for a pilot to be selected without showing the pilot select screen
bool player_select_auto_select_requested();

// if requested by the command line, selects a pilot without the pilot select screen; returns true if a pilot was selected
bool player_select_try_auto_select();

// tooltips
extern int Player_tips_start_index;
void player_tips_init();
void player_tips_popup();
bool player_tips_controls();

// quick check to make sure we always load default campaign savefile values when loading from the pilot
// select screen but let us not overwrite current values with defaults when we aren't - taylor
extern int Player_select_screen_active;

/**
 * @brief Validates the pilot with the given callsign
 * 
 * @param[in] callsign The pilot's name/callsign
 * @param[in] no_popup If true, supress any popups from being shown
 * 
 * @return FALSE If pilot language is NOT the same as the current language,or
 * @return FALSE If the player selected NO on any popup warnings, or
 * 
 * @return TRUE otherwise
 * 
 * @note This function calls blocking popup dialogs and should only be used within menus
 */
bool valid_pilot(const char *callsign, bool no_popup = false);

SCP_vector<SCP_string> player_select_enumerate_pilots();

SCP_string player_get_last_player();

void player_finish_select(const char* callsign, bool is_multi);

/**
 * Creates a new pilot
 * 
 * @param[in] callsign	Name of the new pilot
 * @param[in] is_multi	True if this is a multiplayer pilot, False otherwise
 * @param[in] copy_from_callsign	If not null, copy the pilot with the given name
 * 
 * @returns true if successful or
 * @returns false otherwise
 * 
 * @note Used by scripting
 */
bool player_create_new_pilot(const char* callsign, bool is_multi, const char* copy_from_callsign = nullptr);

#endif